Spring REST服务如何记录含响应体的完整响应？能否仅靠配置实现？

嘿，我来帮你搞定Spring里记录完整响应体的问题！你已经用RequestLoggingFilter把请求日志（包括请求体）搞定了，响应这边其实可以用类似的思路，但Spring没有内置的响应日志Filter，得自己动手实现或者借助扩展方案，下面给你详细说说：

Spring提供了ContentCachingResponseWrapper类，它可以缓存响应体，解决原生HttpServletResponse无法重复读取响应体的问题。我们可以基于它写一个自定义Filter，和你的请求日志Filter搭配使用。

步骤1：编写响应日志Filter #

import org.springframework.web.filter.OncePerRequestFilter;
import org.springframework.web.util.ContentCachingResponseWrapper;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

public class ResponseLoggingFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        // 用Spring提供的包装类缓存响应体
        ContentCachingResponseWrapper wrappedResponse = new ContentCachingResponseWrapper(response);

        try {
            // 继续执行请求链，让后端生成响应
            filterChain.doFilter(request, wrappedResponse);
        } finally {
            // 读取缓存的响应体并打印日志
            byte[] responseBodyBytes = wrappedResponse.getContentAsByteArray();
            if (responseBodyBytes.length > 0) {
                String responseBody = new String(responseBodyBytes, StandardCharsets.UTF_8);
                // 自定义日志格式，你可以根据需求调整字段
                logger.info("Response Log - Status: {}, Path: {}, Body: {}",
                        wrappedResponse.getStatus(),
                        request.getRequestURI(),
                        responseBody);
            }
            // 必须调用这个方法！把缓存的响应体写回原始响应，否则客户端收不到内容
            wrappedResponse.copyBodyToResponse();
        }
    }
}

步骤2：把Filter注册为Bean #

在你现有的RequestLoggingFilterConfig里新增这个Filter的Bean配置：

@Configuration
public class RequestLoggingFilterConfig {

    // 你的请求日志Filter（保持不变）
    @Bean
    public CommonsRequestLoggingFilter requestLoggingFilter() {
        CommonsRequestLoggingFilter filter = new CommonsRequestLoggingFilter();
        filter.setIncludeQueryString(true);
        filter.setIncludePayload(true);
        filter.setMaxPayloadLength(10000);
        filter.setIncludeHeaders(false);
        filter.setAfterMessagePrefix("Request logged: ");
        return filter;
    }

    // 新增响应日志Filter Bean
    @Bean
    public ResponseLoggingFilter responseLoggingFilter() {
        return new ResponseLoggingFilter();
    }
}

这样启动应用后，就能和请求日志一起，记录包含响应体的完整响应信息了。

很遗憾，纯配置文件（比如application.yml/application.properties）无法实现。原因是：记录响应体需要先包装HttpServletResponse来缓存响应内容，这个逻辑必须通过代码实现——Spring没有提供内置的响应日志Filter的配置开关，也没法仅靠配置完成响应体的读取和日志输出。

不过如果你想用更“轻量化”的代码方式，可以借助Spring Boot Actuator的httptrace功能：

1. 先添加Actuator依赖（Maven为例）：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

2. 在配置文件里开启httptrace并配置要记录的内容：

management:
  endpoints:
    web:
      exposure:
        include: httptrace
  httptrace:
    include: request-headers,response-headers,request-body,response-body

3. 自定义HttpTraceRepository来打印日志（还是需要少量代码）：

import org.springframework.boot.actuate.trace.http.HttpTrace;
import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;

@Component
public class CustomTraceRepository implements HttpTraceRepository {

    private final List<HttpTrace> traces = new ArrayList<>();

    @Override
    public List<HttpTrace> findAll() {
        return List.copyOf(traces);
    }

    @Override
    public void add(HttpTrace trace) {
        // 打印包含响应体的完整追踪信息
        logger.info("Full HTTP Trace: {}", trace);
        traces.add(trace);
    }
}

但无论哪种方式，都需要至少一部分代码来实现响应体的捕获和日志输出，纯配置文件做不到哦。

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