脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring Cloud OAuth2

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

 更新时间：2022年06月24日 14:04:51   作者：码猿技术专栏  
Spring Security OAuth的token返回格式都是默认的，但是往往这个格式是不适配系统。本文将用一个接口优雅的实现 Spring Cloud OAuth2 自定义token返回格式，需要的可以参考一下

最近读者朋友针对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<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的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • Java之键盘输入语句Scanner解读

    Java之键盘输入语句Scanner解读

    这篇文章主要介绍了Java之键盘输入语句Scanner解读，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-11-11
  • Mybatis插入时返回自增主键方式(selectKey和useGeneratedKeys)

    Mybatis插入时返回自增主键方式(selectKey和useGeneratedKeys)

    这篇文章主要介绍了Mybatis插入时返回自增主键方式(selectKey和useGeneratedKeys)，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-09-09
  • RabbitMQ消息有效期与死信的处理过程

    RabbitMQ消息有效期与死信的处理过程

    利用DLX，当消息在一个队列中变成死信 (dead message) 之后，它能被重新publish到另一个Exchange，这个Exchange就是DLX，本文重点给大家介绍RabbitMQ消息有效期与死信的相关知识，感兴趣的朋友跟随小编一起看看吧
    2022-03-03
  • Spring容器获取Bean的9种方式总结

    Spring容器获取Bean的9种方式总结

    本文为大家整理汇总了常见的获取Bean的方式，并提供一些优劣分析，方便大家在使用到时有更好的选择，同时，也会为大家适当的普及和拓展一些相关知识，需要的可以参考一下
    2023-07-07
  • Java Runtime的使用详解

    Java Runtime的使用详解

    这篇文章主要介绍了Java Runtime的使用详解，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-12-12
  • 解决java.sql.SQLException:索引中丢失 IN或OUT 参数::x问题

    解决java.sql.SQLException:索引中丢失 IN或OUT 参数::x问题

    这篇文章主要介绍了解决java.sql.SQLException:索引中丢失 IN或OUT 参数::x问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • 使用Java发送带附件的附件的示例

    使用Java发送带附件的附件的示例

    这篇文章主要介绍了使用Java发送带附件的附件的方法,使用到了JavaMail这个API,需要的朋友可以参考下
    2015-11-11
  • SpringCloud中的Eureka集群配置方法

    SpringCloud中的Eureka集群配置方法

    这篇文章主要介绍了SpringCloud中的Eureka集群配置,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-09-09
  • java数组的初始化及操作详解

    java数组的初始化及操作详解

    在本文中小编给大家整理了关于java数组的初始化及操作的相关知识点内容，需要的读者们参考下。
    2019-07-07
  • Java效率提升神器jOOR

    Java效率提升神器jOOR

    这篇文章主要介绍了Java效率提升神器jOOR，jOOR是一个第三方库，通过链式DSL接口，简化了反射过程，更多相关内容组要的朋友可以参考一下
    2022-07-07

最新评论