如何在Spring Cloud Gateway提交响应前修改响应体？

我懂你在基于Spring 5、Spring Reactor和Netty的Spring Cloud Gateway项目里，想要在响应返回客户端前执行自定义操作的需求，而且你已经尝试用beforeCommit方法来实现了。不过你给出的代码片段没写完，我来帮你完善这个方案，确保它能正确跑起来。

先给你一个完整的GatewayFilter实现示例，这是最常用的方式：

@Component
public class PreResponseActionFilter implements GatewayFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpResponse response = exchange.getResponse();
        
        // 先让请求走完网关的过滤链，再在响应提交前插入自定义操作
        return chain.filter(exchange)
                .doOnSuccess(aVoid -> {
                    response.beforeCommit(() -> {
                        try {
                            // 这里放你的自定义操作逻辑，比如日志记录、响应头修改、数据统计等
                            executePreCommitAction();
                            // 如果需要的话设置响应状态码
                            response.setStatusCode(HttpStatus.OK);
                        } catch (Exception e) {
                            // 一定要处理异常，不然会导致响应处理异常却无日志
                            return Mono.error(new RuntimeException("响应前操作执行失败", e));
                        }
                        return Mono.empty();
                    });
                });
    }

    private void executePreCommitAction() {
        // 示例操作：打印日志
        System.out.println(String.format("对请求路径[%s]执行响应前自定义操作", exchange.getRequest().getPath()));
    }

    @Override
    public int getOrder() {
        // 设置为最低优先级，确保这个过滤器在所有响应相关处理之后执行
        return Ordered.LOWEST_PRECEDENCE;
    }
}

如果想让这个逻辑全局生效（对所有路由请求都起作用），可以改成GlobalFilter实现：

@Component
public class GlobalPreResponseFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpResponse response = exchange.getResponse();
        
        return chain.filter(exchange)
                .then(Mono.fromRunnable(() -> {
                    response.beforeCommit(() -> {
                        try {
                            executeGlobalPreCommitAction(exchange);
                        } catch (Exception e) {
                            throw new RuntimeException("全局响应前操作执行失败", e);
                        }
                        return Mono.empty();
                    });
                }));
    }

    private void executeGlobalPreCommitAction(ServerWebExchange exchange) {
        // 这里实现全局的响应前逻辑
    }

    @Override
    public int getOrder() {
        return Ordered.LOWEST_PRECEDENCE;
    }
}

还有几个关键注意点要提醒你：

• 异步处理耗时操作：绝对不要在beforeCommit里做同步的耗时操作，这会阻塞Netty的IO线程，严重影响网关性能。如果有耗时逻辑，一定要用异步方式包装，比如：

  response.beforeCommit(() -> {
      return Mono.fromCallable(() -> {
          // 耗时的业务逻辑，比如调用外部接口
          doTimeConsumingAction();
          return null;
      }).subscribeOn(Schedulers.boundedElastic());
  });
  

• 异常处理必须到位：自定义操作里的异常一定要捕获并包装成Mono.error，否则异常会被静默吞掉，导致响应异常却难以排查。
• 过滤器顺序：设置Ordered.LOWEST_PRECEDENCE能保证这个过滤器在所有响应处理逻辑之后执行，避免干扰其他网关组件的正常工作。

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