Spring Framework中HTTP请求/响应日志合并方案探讨

在Spring Framework的日常使用中，日志记录是开发者监控和调试应用的重要工具。Spring框架本身提供了CommonsRequestLoggingFilter等组件来帮助开发者记录HTTP请求和响应信息，但默认情况下这些日志是分开记录的。

传统日志记录方式的问题

Spring框架现有的请求日志记录机制通常会将请求和响应信息分别记录在不同的日志条目中。这种分离式的日志记录方式虽然简单直接，但在某些场景下会带来不便：

1. 请求和响应信息关联困难，特别是在高并发场景下
2. 日志量增加，增加了存储和分析的负担
3. 不利于快速定位完整的请求-响应生命周期

合并日志的技术实现

要实现请求和响应信息的合并记录，可以考虑以下技术方案：

自定义过滤器实现

通过继承OncePerRequestFilter并配合Spring提供的包装类，可以实现请求和响应信息的合并记录：

public class UnifiedLoggingFilter extends OncePerRequestFilter {
    
    @Override
    protected void doFilterInternal(HttpServletRequest request, 
                                   HttpServletResponse response, 
                                   FilterChain filterChain) throws ServletException, IOException {
        
        ContentCachingRequestWrapper wrappedRequest = new ContentCachingRequestWrapper(request);
        ContentCachingResponseWrapper wrappedResponse = new ContentCachingResponseWrapper(response);
        
        try {
            filterChain.doFilter(wrappedRequest, wrappedResponse);
        } finally {
            // 获取请求信息
            String requestMethod = wrappedRequest.getMethod();
            String requestURI = wrappedRequest.getRequestURI();
            String queryString = wrappedRequest.getQueryString();
            String requestBody = getContentAsString(wrappedRequest.getContentAsByteArray(), 
                                                  wrappedRequest.getCharacterEncoding());
            
            // 获取响应信息
            int status = wrappedResponse.getStatus();
            String responseBody = getContentAsString(wrappedResponse.getContentAsByteArray(), 
                                                    wrappedResponse.getCharacterEncoding());
            
            // 合并记录日志
            logger.info(formatLogMessage(requestMethod, requestURI, queryString, 
                                       requestBody, status, responseBody));
            
            // 确保响应内容被写入客户端
            wrappedResponse.copyBodyToResponse();
        }
    }
    
    private String formatLogMessage(String method, String uri, String query, 
                                  String reqBody, int status, String respBody) {
        return String.format(">> INCOMING >> AFTER REQUEST\n" +
                           "Request: %s %s%s\n  Body: %s\n" +
                           "Response: Status %d\n  Body: %s",
                           method, uri, query != null ? "?" + query : "",
                           reqBody.isEmpty() ? "<empty body>" : reqBody,
                           status, respBody);
    }
    
    private String getContentAsString(byte[] buf, String charsetName) {
        if (buf == null || buf.length == 0) return "";
        try {
            return new String(buf, charsetName != null ? charsetName : "UTF-8");
        } catch (UnsupportedEncodingException ex) {
            return "[unknown]";
        }
    }
}

实现要点说明

1. 请求/响应包装：使用ContentCachingRequestWrapper和ContentCachingResponseWrapper来缓存请求和响应内容
2. 异常处理：确保在异常情况下也能记录日志并正确返回响应
3. 字符编码处理：正确处理不同编码的请求和响应体
4. 性能考虑：注意大请求体的内存消耗问题

性能与安全考量

实现合并日志记录时需要考虑以下因素：

1. 内存使用：缓存大请求体或响应体可能导致内存压力
2. 敏感信息：日志中可能包含敏感数据，需要适当过滤
3. 性能开销：额外的包装和内容复制操作会增加少量处理时间

适用场景建议

合并日志记录特别适合以下场景：

1. 开发调试阶段需要完整查看API交互
2. 低流量生产环境的问题诊断
3. 关键业务接口的监控审计

对于高流量生产环境，建议谨慎评估性能影响，或考虑采样记录部分请求。

总结

虽然Spring Framework核心没有直接提供请求响应合并日志的功能，但通过自定义过滤器可以相对容易地实现这一需求。开发者可以根据实际业务场景和性能要求，灵活调整实现细节，获得更好的可观测性体验。