幾行代碼搞定 Spring Cloud OAuth2 授權碼模式三個頁面定制
Spring Security OAuth2的授權碼模式一直是個難點,如果你對底層的原理不太理解的話很難去定位到其中的問題。
今天這篇文章就針對這位朋友提出的問題做個解答,分為如下三個部分:
- 授權碼模式的登錄頁面重定制
- 授權碼模式的授權頁面重定制
- 授權碼模式的異常頁面重定制
授權碼模式的登錄頁面重定制
下面展示一下默認的登錄頁面什么熊樣,如下圖:
是不是有點丑?實際開發中肯定是要根據自己的系統定制這個登錄頁面。
問題來了:如何定制?
分為如下幾步:
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 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個步驟即可輕松的實現異常頁面自定義,效果如下: