这篇“Spring Cloud OAuth2怎么实现自定义token返回格式”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Spring Cloud OAuth2怎么实现自定义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.oauth3.provider.endpoint.TokenEndpoint
中,如下:
@RequestMapping(value = "/oauth/token", method=RequestMethod.GET) public ResponseEntity<OAuth3AccessToken> getAccessToken(Principal principal, @RequestParam Map<String, String> parameters) throws HttpRequestMethodNotSupportedException {} @RequestMapping(value = "/oauth/token", method=RequestMethod.POST) public ResponseEntity<OAuth3AccessToken> postAccessToken(Principal principal, @RequestParam Map<String, String> 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<OAuth3AccessToken> postAccessToken(Principal principal, @RequestParam Map<String, String> parameters) throws HttpRequestMethodNotSupportedException { OAuth3AccessToken accessToken = tokenEndpoint.postAccessToken(principal, parameters).getBody(); return ResultMsg.resultSuccess(accessToken); } }
可以看到接口内部不需要自己重写逻辑,只需要调用TokenEndpoint
中的方法
注意:由于对TokenEndpoint中的端点重写了,因此前面定义的对用户名、密码之类的异常捕获的翻译类(OAuthServerWebResponseExceptionTranslator)将会失效,需要在全局异常中进行捕获
上面是/oauth/token
的接口,/oauth/check_token
这个校验token的接口如需自定义也是可以的,对应的类是org.springframework.security.oauth3.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<Map<String,?>> checkToken(@RequestParam("token") String value) { Map<String, ?> map = checkTokenEndpoint.checkToken(value); return ResultMsg.resultSuccess(map); }
以上就是关于“Spring Cloud OAuth2怎么实现自定义token返回格式”这篇文章的内容,相信大家都有了一定的了解,希望小编分享的内容对大家有帮助,若想了解更多相关的知识内容,请关注亿速云行业资讯频道。
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。