如何在 Spring Cloud OAuth2 中优雅地实现自定义 Token 返回格式

2023-11-02 18:25:06

在现代化软件开发中，OAuth2 协议作为一种广泛采用的授权框架，为应用程序和服务之间安全地交换访问令牌铺平了道路。Spring Cloud OAuth2 是一个强大的库，它为在 Spring Boot 应用程序中实施 OAuth2 提供了全面的支持。然而，默认情况下，OAuth2 返回的 Token 格式可能并不总能满足特定的业务需求。本文将深入探讨如何优雅地实现 Spring Cloud OAuth2 中自定义 Token 返回格式的技巧。

理解 OAuth2 Token 响应

在 OAuth2 授权流程中，当客户端成功获得访问令牌时，服务器会返回一个包含以下属性的 Token 响应：

访问令牌（access_token）：授予对受保护资源的访问权限。
令牌类型（token_type）：指定令牌的类型（例如“bearer”）。
过期时间（expires_in）：令牌到期之前剩余的秒数。
刷新令牌（refresh_token）：用于获取新访问令牌的可选令牌。
作用域（scope）：令牌授予的访问权限列表。

默认情况下，Spring Cloud OAuth2 返回一个包含这些属性的 JSON Web 令牌（JWT）。

自定义 Token 返回格式

要自定义 Token 返回格式，我们需要扩展 OAuth2AccessTokenConverter 类并重写其 convertAccessToken 方法。该方法负责将授权服务器生成的 OAuth2AccessToken 对象转换为响应中返回的实际 Token 格式。

以下是一个自定义 Token 转换器的示例，它将 Token 响应转换为包含附加属性“custom_field”的 JSON 对象：

public class CustomTokenConverter extends OAuth2AccessTokenConverter {

    @Override
    public Map<String, ?> convertAccessToken(OAuth2AccessToken token, OAuth2Authentication authentication) {
        Map<String, Object> response = super.convertAccessToken(token, authentication);
        response.put("custom_field", "custom value");
        return response;
    }

}

配置自定义 Token 转换器

配置自定义 Token 转换器涉及在 Spring Boot 应用程序中添加以下配置：

spring.security.oauth2.resource.token-info-uri=http://localhost:8080/oauth/check_token
spring.security.oauth2.resource.token-info-client-id=client-id
spring.security.oauth2.resource.token-info-client-secret=client-secret
spring.security.oauth2.resource.jwt.token-converter-bean-name=customTokenConverter