Spring Cloud Gateway表单过滤器字符追加问题分析

问题背景

在Spring Cloud Gateway项目中，当开发者使用表单数据提交并同时携带查询参数时，可能会遇到一个关于请求体长度校验失败的问题。这个问题特别出现在禁用RemoveContentLengthFilter过滤器的情况下，使用JDK默认的REST客户端时会抛出异常，提示请求体字节数与预期不符。

问题复现条件

要复现该问题需要满足以下条件：

1. 配置属性spring.cloud.gateway.mvc.remove-content-length-request-headers-filter.enabled=false，即禁用RemoveContentLengthFilter
2. 使用POST方法提交表单数据
3. 请求URL中同时包含查询参数，例如/post?foo=fooquery
4. 使用JDK默认的REST客户端

问题现象

当满足上述条件时，系统会抛出异常：

Too many bytes in request body. Expected: 7, got: 8

问题根源分析

通过深入代码分析，发现问题出在FormContentFilter的实现中。该过滤器负责处理表单数据，将请求参数转换为请求体。在转换过程中，对于同时存在于查询参数和表单数据中的参数，虽然逻辑上应该跳过这些参数的处理，但代码仍然会不必要地追加分隔符&。

具体来说，在getRequestWithBodyFromRequestParameters方法中：

1. 方法会遍历所有表单参数
2. 对于每个参数，检查它是否同时存在于查询参数中（isQueryParam标志）
3. 如果是查询参数，理论上应该跳过处理
4. 但无论是否跳过，代码都会在参数迭代器还有下一个元素时追加&字符
5. 这导致最终的请求体比预期多出一个字符，从而引发长度校验失败

解决方案

正确的做法应该是：

1. 在处理每个参数前，先判断它是否是查询参数
2. 只有处理了非查询参数后，才需要考虑追加分隔符
3. 可以通过引入一个布尔变量来跟踪是否实际处理了参数，从而决定是否需要追加分隔符

技术影响

这个问题虽然看似简单，但影响了几方面：

1. 请求处理正确性：错误的请求体可能导致后端服务无法正确解析
2. 性能影响：不必要的字符追加和长度校验失败会导致额外的处理开销
3. 兼容性问题：特别是在需要精确控制请求体内容的场景下

最佳实践建议

对于使用Spring Cloud Gateway的开发者，建议：

1. 除非有特殊需求，否则不要轻易禁用RemoveContentLengthFilter
2. 在处理表单提交时，尽量避免查询参数和表单数据中包含同名参数
3. 如果必须同时使用查询参数和表单数据，确保参数名称不重复

总结

Spring Cloud Gateway的表单过滤器在处理同时包含查询参数和表单数据的请求时，存在字符追加逻辑的缺陷。这个问题会导致请求体长度与预期不符，进而引发客户端异常。通过调整参数处理逻辑，确保只在必要时追加分隔符，可以解决这一问题。理解这一机制有助于开发者更好地处理表单提交场景，避免类似问题的发生。