几行代码搞定 Spring Cloud OAuth2 授权码模式3个页面定制

Spring Security OAuth2的授权码模式一直是个难点，如果你对底层的原理不太理解的话很难去定位到其中的问题

 

今天这篇文章就针对这个问题做个解答，分为如下三个部分：

1. 授权码模式的登录页面重定制
2. 授权码模式的授权页面重定制
3. 授权码模式的异常页面重定制

 

授权码模式的登录页面重定制
下面就以《Spring Cloud Alibaba 项目实战》的实战项目来展示一下默认的登录页面什么熊样，如下图：

是不是有点丑？实际开发中肯定是要根据自己的系统定制这个登录页面

问题来了：如何定制？

 

分为如下几步：

1. 定制页面
陈某随便找了一个前端页面oauth-login.html，代码如下：

使用thymeleaf进行渲染

 

 

2. 定义接口跳转
需要在OAuth2的授权服务中定义一个接口跳转到定制的页面，接口如下：

@ApiOperation(value = "表单登录跳转页面")
@GetMapping("/oauth/login")
public String loginPage(Model model){
    //返回跳转页面
    return "oauth-login";
}

 

3. Spring Security 中配置
只需要在Spring Security 的表单登录中定义一下跳转的接口即可，代码如下：

代码解释如下：

 

loginProcessingUrl：这个是定义的form表单提交的url
.loginPage：这个是定义跳转登录页面的url

按照上述三个步骤轻松实现了自定义登录页面，效果如下：

 

授权码模式的授权页面重定制

下面就以《Spring Cloud Alibaba 项目实战》的实战项目来展示一下默认的授权页面什么熊样，如下图：

那么如何自定义呢？这个自定义就相对麻烦了，需要对Spring Security 底层原理有一定的了解

 

1. 定制页面
陈某随便找了一个页面oauth-grant.html，代码如下：

2. 定义接口跳转
授权页面的跳转接口url：/oauth/confirm_access，这个接口定义在org.springframework.security.oauth2.provider.endpoint.WhitelabelApprovalEndpoint中，如下：

自定义也很简单，只需要模仿这个接口自定义一个将其覆盖即可，实现如下：

注意：@SessionAttributes("authorizationRequest")这个注解一定要标注，授权请求信息是存储在session中

 

3. 修改默认的映射地址
由于默认的跳转接口是：/oauth/confirm_access，陈某刚好定义的接口也是/oauth/confirm_access，因此这第3步不用配置也能生效

 

注意：如果你的跳转接口不是/oauth/confirm_access，那么需要按照这个步骤配置

 

修改也很简单，只需要在OAuth2的认证服务的配置类：继承AuthorizationServerConfigurerAdapter的配置中修改一下配置，代码如下：

按照上述3个步骤即可轻松的实现授权页面自定义，效果如下：

 

授权码模式的异常页面重定制
这个异常页面什么意思呢？授权码的请求url如下：

 

http://localhost:9001/blog-auth-server/oauth/authorize?client_id=mugu&response_type=code&scope=all&redirect_uri=http://www.baidu.com

 

假设我将的租户id（client_id）修改成数据库中不存在的值，那么将会触犯异常页面，页面如下：

这个异常页面是不是不太符合系统的要求，肯定是要自定义的

 

1. 定制页面
陈某前端能力有限，没找到现成的，自己随便写了一个oauth-error.html，代码如下：

2. 定义接口跳转

这个跳转的接口的逻辑在AuthorizationEndpoint中，如下：

因此只需要重新定义一个接口进行跳转即可，如下：

@ApiOperation(value = "处理授权异常的跳转页面")
@GetMapping("/oauth/error")
public String error(Model model){
    return "oauth-error";
}

 

3. 修改默认的映射地址
默认的映射地址为/oauth/error，陈某自定义的也是这个，因此第3步可以省略

“注意：如果你定义的接口不是/oauth/error则需要配置

修改也很简单，只需要在OAuth2的认证服务的配置类：继承AuthorizationServerConfigurerAdapter的配置中修改一下配置，代码如下：

按照上述3个步骤即可轻松的实现异常页面自定义，效果如下：