Spring Cloud Gateway 2023.0.1 版本中请求体缓存属性读取问题解析

在 Spring Cloud Gateway 2023.0.1 版本升级过程中，开发者可能会遇到一个关于请求体缓存属性读取的问题。本文将深入分析该问题的背景、原因以及解决方案，帮助开发者更好地理解和使用 Spring Cloud Gateway 的请求体缓存机制。

问题背景

在 Spring Cloud Gateway 中，开发者可以通过 CacheRequestBody 过滤器来缓存请求体内容，以便在后续的过滤器链中重复使用。缓存后的请求体可以通过 ServerWebExchangeUtils.CACHED_REQUEST_BODY_ATTR 属性从 ServerWebExchange 中获取。

在从 2023.0.0 升级到 2023.0.3 版本后，部分开发者发现无法再从全局过滤器中获取到缓存的请求体内容，而此前在 2023.0.0 版本中这是可以正常工作的。

问题分析

配置示例

典型的网关配置可能如下所示：

spring:
  cloud:
    gateway:
      routes:
      - id: service1
        uri: https://service1
        predicates:
        - Path=/service1/**
        filters:
        - name: CacheRequestBody
          args:
            bodyClass: java.lang.String

开发者通常会在全局过滤器中尝试读取缓存的请求体：

@Order(1)
@Component
public class CustomFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String bodyString = exchange.getAttribute(ServerWebExchangeUtils.CACHED_REQUEST_BODY_ATTR);
        // 处理bodyString
    }
}

根本原因

在 2023.0.1 版本中，Spring Cloud Gateway 引入了对全局过滤器排序的完整支持。虽然之前版本中可以使用 @Order 注解，但其行为可能不够稳定。这一变化影响了过滤器的执行顺序，可能导致全局过滤器在 CacheRequestBody 过滤器之前执行，从而无法获取到缓存的请求体。

解决方案

要解决这个问题，开发者需要确保全局过滤器的执行顺序正确：

1. 调整过滤器顺序：确保读取缓存请求体的全局过滤器在 CacheRequestBody 过滤器之后执行。可以通过调整 @Order 注解的值来实现。

2. 明确执行时机：如果需要在请求处理前读取请求体，考虑使用路由过滤器而非全局过滤器，或者在全局过滤器中明确检查缓存是否已存在。

3. 版本兼容性检查：在升级时，仔细检查版本变更日志，特别是关于过滤器执行顺序的变更。

最佳实践

1. 明确依赖关系：在设计过滤器时，明确各个过滤器之间的依赖关系，特别是对请求体缓存的依赖。

2. 测试验证：在升级后，应充分测试所有依赖请求体缓存的场景，确保功能正常。

3. 文档参考：在实现复杂过滤器逻辑时，参考官方文档了解各个版本的行为差异。

总结

Spring Cloud Gateway 2023.0.1 版本对过滤器排序机制的改进虽然带来了更稳定的行为，但也可能导致一些依赖特定执行顺序的场景出现问题。理解这一变化并适当调整过滤器实现，可以帮助开发者顺利迁移到新版本，同时保持应用的稳定性。

对于需要处理请求体的场景，建议开发者仔细规划过滤器的执行顺序，并在升级前充分测试相关功能，以确保平滑过渡。