TokenRelay 过滤器

DeepSeek V3 中英对照 TokenRelay Filter TokenRelay Filter

令牌中继是指 OAuth2 消费者充当客户端，并将传入的令牌转发给传出的资源请求。该消费者可以是纯客户端（如单点登录应用程序）或资源服务器。

Spring Cloud Gateway Server MVC 可以通过 TokenRelay 过滤器将 OAuth2 访问令牌转发到其代理的下游服务。

TokenRelay 过滤器接受一个可选参数 clientRegistrationId。以下示例配置了一个 TokenRelay 过滤器：

@Configuration
class RouteConfiguration {

    @Bean
    public RouterFunction<ServerResponse> gatewayRouterFunctionsTokenRelay() {
        return route("resource")
            .GET("/resource", http())
            .before(uri("https://localhost:9000"))
            .filter(tokenRelay("myregistrationid"))
            .build();
    }
}

或者这个

spring:
  cloud:
    gateway:
      routes:
      - id: resource
        uri: http://localhost:9000
        predicates:
        - Path=/resource
        filters:
        - TokenRelay=myregistrationid

上面的例子指定了一个 clientRegistrationId，可用于获取并转发任何可用 ClientRegistration 的 OAuth2 访问令牌。

Spring Cloud Gateway Server MVC 可以转发当前已认证用户的 OAuth2 访问令牌，当使用 oauth2Login() 对用户进行身份验证时。要将此功能添加到网关，您可以省略 clientRegistrationId 参数，如下所示：

@Configuration
class RouteConfiguration {

    @Bean
    public RouterFunction<ServerResponse> gatewayRouterFunctionsTokenRelay() {
        return route("resource")
            .GET("/resource", http())
            .before(uri("https://localhost:9000"))
            .filter(tokenRelay())
            .build();
    }
}

或者这个

spring:
  cloud:
    gateway:
      server:
        webmvc:
          routes:
            - id: resource
              uri: http://localhost:9000
              predicates:
              - Path=/resource
              filters:
              - TokenRelay=

并且（除了登录用户并获取令牌外）还会将身份验证令牌向下游传递给服务（在本例中为 /resource）。

要为 Spring Cloud Gateway Server MVC 启用此功能，请添加以下依赖项

• org.springframework.boot:spring-boot-starter-oauth2-client

它是如何工作的？该过滤器从当前已认证用户中提取指定 clientRegistrationId 对应的 OAuth2 访问令牌。如果未提供 clientRegistrationId，则使用当前已认证用户自身的访问令牌（在登录时获取），并将提取的访问令牌放入下游请求的请求头中。

备注

Token Relay 过滤器仅在正确设置了 spring.security.oauth2.client.* 属性时才会生效，这些属性会触发创建 OAuth2AuthorizedClientManager bean。

备注

Token Relay 过滤器使用的默认实现基于内存数据存储。如果您需要一个更健壮的解决方案，您需要提供自己的 OAuth2AuthorizedClientService 实现。