大家好,我是不才陳某~
最近讀者朋友針對Spring Security oauth2.0 想要陳某補充一些知識,如下:
今天這篇文章就來回答其中一個問題:如何自定義token的返回格式?
問題描述
Spring Security OAuth的token返回格式都是默認的,但是往往這個格式是不適配系統,/oauth/token返回的格式如下:
{ "access_token": token "token_type": "bearer", "refresh_token": xxxx "expires_in": xxx, "scope": "xxx", "jti": xxxx .................... } 復制代碼
然而此時系統中的統一返回格式為:
{ "code":xxx "data":xxx "msg":xxx } 復制代碼
那么如何去對默認的格式進行修改呢?
解決方案
其實解決方案還是很多的,據陳某了解有如下兩種解決方案:
- 使用AOP的方式對/oauth/token這個接口的結果攔截修改
- 重定義接口覆蓋默認的
第一種方案呢可以實現,但是對于陳某來說不夠優雅,實現比較簡單,不顯逼格
于是陳某今天介紹第二種方案,一種比較優雅的方式;想要理解第二種方式必須對Spring Security的底層源碼有一些了解。
/OAuth/token這個接口定義在哪里呢?通過源碼我們知道定義在org.springframework.security.oauth2.provider.endpoint.TokenEndpoint中,如下:
@RequestMApping(value = "/oauth/token", method=RequestMethod.GET) public ResponseEntity getAccessToken(Principal principal, @RequestParam Map parameters) throws HttpRequestMethodNotSupportedException {} @RequestMapping(value = "/oauth/token", method=RequestMethod.POST) public ResponseEntity postAccessToken(Principal principal, @RequestParam Map parameters) throws HttpRequestMethodNotSupportedException {} 復制代碼
可以看到針對這個接口定義了兩個,一個是GET請求、一個是POST請求
TokenEndpoint其實就是一個接口,使用注解@FrameworkEndpoint標注,這個注解和@Controller的作用一樣,如下:
@FrameworkEndpoint public class TokenEndpoint extends AbstractEndpoint {} 復制代碼
那么知道在哪里定義的就好辦了,模仿著它這個接口自己重新定義一個覆蓋掉不就好了,如下:
@Api(value = "OAuth接口") @RestController @RequestMapping("/oauth") @Slf4j public class AuthController implements InitializingBean { //令牌請求的端點 @Autowired private TokenEndpoint tokenEndpoint; //自定義異常翻譯器,針對用戶名、密碼異常,授權類型不支持的異常進行處理 private OAuthServerWebResponseExceptionTranslator translate; /** * 重寫/oauth/token這個默認接口,返回的數據格式統一 */ @PostMapping(value = "/token") public ResultMsg postAccessToken(Principal principal, @RequestParam Map parameters) throws HttpRequestMethodNotSupportedException { OAuth2AccessToken accessToken = tokenEndpoint.postAccessToken(principal, parameters).getBody(); return ResultMsg.resultSuccess(accessToken); } } 復制代碼
可以看到接口內部不需要自己重寫邏輯,只需要調用TokenEndpoint中的方法
注意:由于對TokenEndpoint中的端點重寫了,因此前面定義的對用戶名、密碼之類的異常捕獲的翻譯類(OAuthServerWebResponseExceptionTranslator)將會失效,需要在全局異常中進行捕獲
上面是/oauth/token的接口,/oauth/check_token這個校驗token的接口如需自定義也是可以的,對應的類是org.springframework.security.oauth2.provider.endpoint.CheckTokenEndpoint
重寫后代碼如下:
@Api(value = "OAuth接口") @RestController @RequestMapping("/oauth") @Slf4j public class AuthController implements InitializingBean { @Autowired private CheckTokenEndpoint checkTokenEndpoint; //自定義異常翻譯器,針對用戶名、密碼異常,授權類型不支持的異常進行處理 private OAuthServerWebResponseExceptionTranslator translate; /** * 重寫/oauth/check_token這個默認接口,用于校驗令牌,返回的數據格式統一 */ @PostMapping(value = "/check_token") public ResultMsg> checkToken(@RequestParam("token") String value) { Map map = checkTokenEndpoint.checkToken(value); return ResultMsg.resultSuccess(map); } 復制代碼
這種方式是不是很優雅?也很符合Spring Security的設計思想,AOP的方式還要對參數解析,重新包裝
好了,關于測試的話自己搞一搞
總結
本篇文章介紹了認證服務中對token的返回格式自定義,總的來說還是比較簡單的,有興趣的也可以去網上找找關于AOP的方式。
作者:碼猿技術專欄 鏈接:https://juejin.cn/post/7112630697335980046