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生成License的实现示例
Jun 16 Java/Android
总结一下关于在Java8中使用stream流踩过的一些坑
Jun 24 Java/Android
探讨Java中的深浅拷贝问题
Jun 26 Java/Android
Springboot集成阿里云OSS上传文件系统教程
Jun 28 Java/Android
Java生成读取条形码和二维码的简单示例
Jul 09 Java/Android
dubbo服务整合zipkin详解
Jul 26 Java/Android
JAVA API 实用类 String详解
Oct 05 Java/Android
Java 数据结构七大排序使用分析
Apr 02 Java/Android
Java的Object类的九种方法
Apr 13 Java/Android
SpringBoot使用ip2region获取地理位置信息的方法
Jun 21 Java/Android
SpringBoot接入钉钉自定义机器人预警通知
Jul 15 Java/Android
Spring Boot 的创建和运行示例代码详解
Jul 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
几种有用的变型 PHP中循环语句的用法介绍
2012/01/30 PHP
ThinkPHP的URL重写问题
2014/06/22 PHP
php中ob_get_length缓冲与获取缓冲长度实例
2014/11/20 PHP
WordPress开发中的get_post_custom()函数使用解析
2016/01/04 PHP
JavaScript的Cookies
2008/01/16 Javascript
浅谈Javascript中深复制
2014/12/01 Javascript
JQuery鼠标移到小图显示大图效果的方法
2015/06/10 Javascript
深入剖析JavaScript编程中的对象概念
2015/10/21 Javascript
JS上传图片预览插件制作(兼容到IE6)
2016/08/07 Javascript
jQuery validate 验证radio实例
2017/03/01 Javascript
vue-quill-editor实现图片上传功能
2017/08/08 Javascript
Sublime Text新建.vue模板并高亮(图文教程)
2017/10/26 Javascript
解决微信小程序防止无法回到主页的问题
2018/09/28 Javascript
JS判断浏览器类型与操作系统的方法分析
2020/04/30 Javascript
Vue 中如何将函数作为 props 传递给组件的实现代码
2020/05/12 Javascript
解决vant的Toast组件时提示not defined的问题
2020/11/11 Javascript
[01:43]倾听DOTA2英雄之声 魅惑魔女国服配音鉴赏
2013/06/06 DOTA
[00:35]DOTA2上海特级锦标赛 VP战队宣传片
2016/03/04 DOTA
python Pandas 读取txt表格的实例
2018/04/29 Python
tesserocr与pytesseract模块的使用方法解析
2019/08/30 Python
python统计mysql数据量变化并调用接口告警的示例代码
2020/09/21 Python
canvas实现滑动验证的实现示例
2020/08/11 HTML / CSS
丹麦优惠购物网站:PLUSSHOP
2019/03/24 全球购物
请写出 float x 与"零值"比较的 if 语句
2016/01/04 面试题
工业设计专业推荐信
2013/10/29 职场文书
校本教研工作方案
2014/01/14 职场文书
人事专员工作职责
2014/02/22 职场文书
《陋室铭》教学反思
2014/02/26 职场文书
教师节促销方案
2014/03/22 职场文书
银行贷款收入证明
2014/10/17 职场文书
2014年禁毒工作总结
2014/11/24 职场文书
考勤制度通知
2015/04/25 职场文书
原告离婚代理词
2015/05/23 职场文书
《合作意向书》怎么写?
2019/08/20 职场文书
Vue+Element UI实现概要小弹窗的全过程
2021/05/30 Vue.js
js前端面试常见浏览器缓存强缓存及协商缓存实例
2022/06/21 Javascript