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 相关文章推荐
启动Tomcat时出现大量乱码的解决方法
Jun 21 Java/Android
Java elasticsearch安装以及部署教程
Jun 28 Java/Android
使用@Value值注入及配置文件组件扫描
Jul 09 Java/Android
Java生成读取条形码和二维码的简单示例
Jul 09 Java/Android
java固定大小队列的几种实现方式详解
Jul 15 Java/Android
Android基于Fresco实现圆角和圆形图片
Apr 01 Java/Android
springboot应用服务启动事件的监听实现
Apr 06 Java/Android
零基础学java之带参数以及返回值的方法
Apr 10 Java/Android
JavaScript正则表达式实现注册信息校验功能
May 30 Java/Android
Spring中的@Transactional的工作原理
Jun 05 Java/Android
springboot读取resources下文件的方式详解
Jun 21 Java/Android
spring 项目实现限流方法示例
Jul 15 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
ajax实现无刷新分页(php)
2010/07/18 PHP
codeigniter框架批量插入数据
2014/01/09 PHP
PHP处理Oracle的CLOB实例
2014/11/03 PHP
PHP使用JSON和将json还原成数组
2015/02/12 PHP
通过Email发送PHP错误的方法
2015/07/20 PHP
PHP操作MySQL中BLOB字段的方法示例【存储文本与图片】
2017/09/15 PHP
Yii2.0实现的批量更新及批量插入功能示例
2019/01/29 PHP
JS和jquery获取各种屏幕的宽度和高度的代码
2013/08/02 Javascript
解决jquery操作checkbox火狐下第二次无法勾选问题
2014/02/10 Javascript
简单的jquery左侧导航栏和页面选中效果
2014/08/21 Javascript
JavaScript实现在页面间传值的方法
2015/04/07 Javascript
jquery代码实现多选、不同分享功能
2015/07/31 Javascript
使用plupload自定义参数实现多文件上传
2016/07/19 Javascript
js编写的treeview使用方法
2016/11/11 Javascript
Web前端框架bootstrap实战【第一次接触使用】
2016/12/28 Javascript
angularjs获取到My97DatePicker选中的值方法
2018/10/02 Javascript
[02:03]《现实生活中的DOTA2》—林书豪&DOTA2职业选手出演短片
2015/08/18 DOTA
python求解水仙花数的方法
2015/05/11 Python
Python 逐行分割大txt文件的方法
2017/10/10 Python
详解python异步编程之asyncio(百万并发)
2018/07/07 Python
程序员写Python时的5个坏习惯,你有几条?
2018/11/26 Python
在Python中字典根据多项规则排序的方法
2019/01/21 Python
python去重,一个由dict组成的list的去重示例
2019/01/21 Python
python实现nao机器人身体躯干和腿部动作操作
2019/04/29 Python
CSS3制作轮播图的一种方法
2019/11/11 HTML / CSS
旧时光糖果:Old Time Candy
2018/02/05 全球购物
Lentiamo荷兰:在线订购隐形眼镜、隐形眼镜液和太阳镜
2019/10/25 全球购物
历史专业个人求职信范文
2013/12/07 职场文书
迟到检讨书900字
2014/01/14 职场文书
《雷鸣电闪波尔卡》教学反思
2014/02/23 职场文书
小学英语教师先进事迹
2014/05/28 职场文书
安全生产目标管理责任书
2014/07/25 职场文书
青年岗位能手事迹材料
2014/12/23 职场文书
导游词之泰山玉皇顶
2019/12/23 职场文书
go使用Gin框架利用阿里云实现短信验证码功能
2021/08/04 Golang
vue自定义右键菜单之全局实现
2022/04/09 Vue.js