Spring Cloud Gateway MVC中POST请求重试时请求体丢失问题解析

问题背景

在Spring Cloud Gateway MVC项目中，当使用重试(Retry)过滤器处理POST或PUT等带有请求体的HTTP请求时，发现重试后的请求会丢失请求体内容。这个问题主要出现在Spring Boot 3.2.4和Spring Cloud Gateway MVC 4.1.0版本中。

问题本质

问题的核心在于HTTP请求体的处理机制。在Java Servlet规范中，HTTP请求体(InputStream)只能被读取一次。当Gateway第一次处理请求时，已经读取了请求体内容，而在重试时再次尝试读取同一个InputStream对象，自然无法获取到数据。

技术细节分析

1. 请求体处理流程：

   • 原始请求到达Gateway时，请求体以InputStream形式存在
   • 第一次转发请求时，InputStream被完整读取并发送到下游服务
   • 当需要重试时，同一个请求对象被再次使用，但InputStream已不可读

2. RetryFilter实现：

   • RetryFilterFunctions中直接使用原始请求对象进行重试
   • 没有对请求体进行缓存处理
   • 重试时使用的HttpServletRequest对象包含的是已消费的InputStream

3. 与WebFlux版本的差异：

   • WebFlux版本已经解决了类似问题
   • MVC版本由于基于Servlet API，处理方式有所不同

解决方案

Spring Cloud Gateway团队已经提供了解决方案，通过以下两个步骤配合使用：

1. 启用请求体缓存： 在Retry过滤器配置中设置cacheBody属性为true，这会指示过滤器缓存请求体内容。

@Bean
public RouterFunction<ServerResponse> quotes() {
    return route("quotes")
        .route(path("/quotes/**"), http(quotingService))
        .filter(retry(config -> config.setRetries(2)
                                   .addMethods(HttpMethod.POST)
                                   .setCacheBody(true)))
        .build();
}

2. 添加请求体适配过滤器： 必须同时使用BodyFilterFunctions.adaptCachedBody()过滤器，它会处理缓存的请求体数据。

@Bean
public RouterFunction<ServerResponse> quotes() {
    return route("quotes")
        .route(path("/quotes/**"), http(quotingService))
        .filter(BodyFilterFunctions.adaptCachedBody())
        .filter(retry(config -> config.setRetries(2)
                                   .addMethods(HttpMethod.POST)
                                   .setCacheBody(true)))
        .build();
}

实现原理

1. 请求体缓存：

   • 在第一次处理请求时，将InputStream内容读取并缓存在请求属性中
   • 使用MvcUtils.cacheAndReadBody()方法实现缓存功能

2. 请求体适配：

   • 从请求属性中获取缓存的请求体数据
   • 在重试时重新构建可读的InputStream
   • 确保每次重试都能获得完整的请求体内容

最佳实践

1. 对于所有可能重试的POST/PUT请求路由，都应该启用cacheBody配置
2. 确保adaptCachedBody过滤器在重试过滤器之前执行
3. 注意缓存大请求体可能带来的内存消耗问题
4. 在生产环境中合理设置重试次数和超时时间

总结

Spring Cloud Gateway MVC中的请求体重试问题是一个典型的流式数据处理挑战。通过引入请求体缓存和适配机制，开发者可以确保在重试场景下请求数据的完整性。这一解决方案不仅修复了功能缺陷，也为处理类似场景提供了可借鉴的模式。