Spring Boot Gateway Post Filter无法修改响应体问题排查

你的过滤器不生效主要有以下几个核心问题：

• 响应已提交，无法修改：在chain.filter(exchange).then(Mono.fromRunnable(...))的逻辑里，chain.filter(exchange)执行完成后，原始的后端响应已经被写入并提交了，此时再调用response.setRawStatusCode()和response.writeWith()，因为响应状态和body已经发送给客户端，这些修改根本不会生效。
• Exchange修改未生效：exchange.mutate().response(response).build()只是创建了一个新的ServerWebExchange实例，但没有替换当前过滤器链中正在使用的exchange，所以你的修改不会被响应发送流程感知到。
• 未正确拦截响应体：Spring Cloud Gateway中修改响应体必须通过ServerHttpResponseDecorator包装原始响应，拦截原始的写入操作后替换成自定义内容，直接操作原response对象是无效的。

正确的做法是用ServerHttpResponseDecorator包装响应，在响应写入前拦截并修改状态码和内容，代码示例如下：

public class FileBrowserPostFilter implements GatewayFilter, Ordered {
    @Autowired
    private Gson gson;

    @Autowired
    private FileBrowserService fileBrowserService;

    @Override
    public int getOrder() {
        // 后置过滤器需设置足够小的order值，确保在响应提交前完成拦截
        return -1;
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse originalResponse = exchange.getResponse();

        // 仅处理POST请求
        if (!HttpMethod.POST.equals(request.getMethod())) {
            return chain.filter(exchange);
        }

        // 创建响应装饰器，拦截原始响应写入逻辑
        ServerHttpResponseDecorator decoratedResponse = new ServerHttpResponseDecorator(originalResponse) {
            @Override
            public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
                // 仅当原始响应为2xx成功状态时修改内容
                if (originalResponse.getStatusCode().is2xxSuccessful()) {
                    // 设置目标状态码201
                    this.setStatusCode(HttpStatus.CREATED);
                    // 获取路径并查询数据
                    String path = request.getPath().subPath(4).value();
                    var newItem = fileBrowserService.getItem(path);
                    String newItemJson = gson.toJson(newItem);
                    // 构建新的响应体
                    DataBuffer dataBuffer = originalResponse.bufferFactory()
                            .wrap(newItemJson.getBytes(StandardCharsets.UTF_8));
                    // 配置响应头，确保客户端正确解析
                    getHeaders().setContentType(MediaType.APPLICATION_JSON);
                    getHeaders().setContentLength(newItemJson.getBytes(StandardCharsets.UTF_8).length);
                    // 返回自定义响应体
                    return super.writeWith(Mono.just(dataBuffer));
                }
                // 其他情况返回原始响应
                return super.writeWith(body);
            }
        };

        // 将装饰后的响应替换进exchange，继续执行过滤器链
        return chain.filter(exchange.mutate().response(decoratedResponse).build());
    }
}

• 调整过滤器优先级：把getOrder()返回值改为-1（或更小的负数），确保这个后置过滤器在其他响应处理过滤器之前执行，抢到响应修改的时机，避免响应被提前提交。
• 使用响应装饰器：ServerHttpResponseDecorator是Spring Cloud Gateway官方推荐的响应修改方式，通过拦截writeWith方法，在原始响应写入前完成替换。
• 提前过滤请求方法：避免对非POST请求做无用处理，提升过滤器性能。
• 完善响应头配置：手动设置Content-Type和Content-Length，确保客户端能正确解析JSON格式的响应体。

内容的提问来源于stack exchange，提问作者vincent bui