Spring Cloud OAuth2实现自定义token返回格式


Posted in Java/Android onJune 25, 2022

最近读者朋友针对Spring Security OAuth2.0 想要陈某补充一些知识,如下:

Spring Cloud OAuth2实现自定义token返回格式

今天这篇文章就来回答其中一个问题:如何自定义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<OAuth2AccessToken> getAccessToken(Principal principal, @RequestParam
Map<String, String> parameters) throws HttpRequestMethodNotSupportedException {}

@RequestMapping(value = "/oauth/token", method=RequestMethod.POST)
public ResponseEntity<OAuth2AccessToken> 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<OAuth2AccessToken> postAccessToken(Principal principal, @RequestParam
            Map<String, String> 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<Map<String,?>> checkToken(@RequestParam("token") String value)  {
        Map<String, ?> map = checkTokenEndpoint.checkToken(value);
        return ResultMsg.resultSuccess(map);
    }

这种方式是不是很优雅?也很符合Spring Security的设计思想,AOP的方式还要对参数解析,重新包装

好了,关于测试的话自己搞一搞

总结

本篇文章介绍了认证服务中对token的返回格式自定义,总的来说还是比较简单的,有兴趣的也可以去网上找找关于AOP的方式。

以上就是Spring Cloud OAuth2实现自定义token返回格式的详细内容,更多关于Spring Cloud OAuth2的资料请关注三水点靠木其它相关文章!


Tags in this post...

Java/Android 相关文章推荐
springboot @ConfigurationProperties和@PropertySource的区别
Jun 11 Java/Android
详解SpringBoot异常处理流程及原理
Jun 21 Java/Android
java中重写父类方法加不加@Override详解
Jun 21 Java/Android
SpringBoot工程下使用OpenFeign的坑及解决
Jul 02 Java/Android
JUnit5常用注解的使用
Jul 02 Java/Android
Lombok的详细使用及优缺点总结
Jul 15 Java/Android
Java中try catch处理异常示例
Dec 06 Java/Android
SpringBoot中使用Redis作为全局锁示例过程
Mar 24 Java/Android
Java8 Stream API 提供了一种高效且易于使用的处理数据的方式
Apr 13 Java/Android
Springboot中如何自动转JSON输出
Jun 16 Java/Android
Java完整实现记事本代码
Jun 16 Java/Android
Mybatis 一级缓存和二级缓存原理区别
Sep 23 Java/Android
Spring Cloud OpenFeign模版化客户端
Jun 25 #Java/Android
Java服务调用RestTemplate与HttpClient的使用详解
Jun 21 #Java/Android
springboot创建的web项目整合Quartz框架的项目实践
Jun 21 #Java/Android
springboot读取resources下文件的方式详解
Jun 21 #Java/Android
java实现自定义时钟并实现走时功能
Jun 21 #Java/Android
SpringBoot使用ip2region获取地理位置信息的方法
Jun 21 #Java/Android
Android基础入门之dataBinding的简单使用教程
Jun 21 #Java/Android
You might like
web方式ftp
2006/10/09 PHP
php csv操作类代码
2009/12/14 PHP
基于PHP微信红包的算法探讨
2016/07/21 PHP
PHP进阶学习之依赖注入与Ioc容器详解
2019/06/19 PHP
javascript 写类方式之四
2009/07/05 Javascript
javascript算法学习(直接插入排序)
2011/04/12 Javascript
JS 加入收藏夹的代码(主流浏览器通用)
2013/05/13 Javascript
JS this作用域以及GET传输值过长的问题解决方法
2013/08/06 Javascript
js将当前时间格式转换成时间搓(自写)
2013/09/26 Javascript
轻松创建nodejs服务器(10):处理上传图片
2014/12/18 NodeJs
jQuery中wrapAll()方法用法实例
2015/01/16 Javascript
JS实现控制表格行文本对齐的方法
2015/03/30 Javascript
javascript实现秒表计时器的制作方法
2017/02/16 Javascript
分享一道关于闭包、bind和this的面试题
2017/02/20 Javascript
老生常谈javascript中逻辑运算符&amp;&amp;和||的返回值问题
2017/04/13 Javascript
JS实现图片切换特效
2019/12/23 Javascript
JavaScript canvas绘制渐变颜色的矩形
2020/02/18 Javascript
vue 自定义组件的写法与用法详解
2020/03/04 Javascript
[02:24]DOTA2痛苦女王 英雄基础教程
2013/11/26 DOTA
[03:00]《DAC最前线》之欧美新秀VS老将
2015/02/01 DOTA
phpsir 开发 一个检测百度关键字网站排名的python 程序
2009/09/17 Python
python创建列表并给列表赋初始值的方法
2015/07/28 Python
Python在for循环中更改list值的方法【推荐】
2018/08/17 Python
Python numpy.array()生成相同元素数组的示例
2018/11/12 Python
PyQt4 treewidget 选择改变颜色,并设置可编辑的方法
2019/06/17 Python
Python matplotlib生成图片背景透明的示例代码
2019/08/30 Python
Python flask框架实现查询数据库并显示数据
2020/06/04 Python
幼师专业求职推荐信
2013/11/08 职场文书
个人求职信范文分享
2013/12/13 职场文书
运动会开幕式邀请函
2014/01/22 职场文书
趣味活动策划方案
2014/02/08 职场文书
美术教师自我鉴定
2014/02/12 职场文书
2014年超市员工工作总结
2014/11/18 职场文书
2015年元旦联欢晚会活动总结
2014/11/28 职场文书
简单的辞职信范文(2016最新版)
2015/05/12 职场文书
起诉书范文
2015/05/20 职场文书