ContentCachingResponseWrapper简介

ContentCachingResponseWrapper 是 Spring 提供的一个用于缓存 HTTP 响应内容的装饰类,继承自 HttpServletResponseWrapper。它通常用于日志记录、审计、响应内容修改、性能监控等场景。

它不会立即向客户端写入响应内容,而是先缓存到内存中。
 

示例:

@Component
public class ResponseLoggingFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
        throws IOException, ServletException {
        
        ContentCachingResponseWrapper responseWrapper =
            new ContentCachingResponseWrapper((HttpServletResponse) response);

        chain.doFilter(request, responseWrapper);

        // 获取响应内容
        byte[] responseBody = responseWrapper.getContentAsByteArray();
        if (responseBody.length > 0) {
            String bodyStr = new String(responseBody, response.getCharacterEncoding());
            System.out.println("响应内容: " + bodyStr);
        }

        // 必须调用,否则客户端收不到数据
        responseWrapper.copyBodyToResponse();
    }
}

⚠️ 注意事项
内存占用:
     缓存整个响应内容会占用额外内存,对于大文件下载等场景慎用。
性能影响:
     对高并发、低延迟服务可能带来一定性能损耗。
必须调用 copyBodyToResponse():
     否则客户端无法接收到响应数据。

使用问题

在使用 ContentCachingResponseWrapper 与 SSE(Server-Sent Events) 异步推送时,需要注意几个关键点。因为 SSE 是一种长连接、流式响应机制,而 ContentCachingResponseWrapper 默认是为同步请求设计的,它会缓存整个响应内容并在请求结束时一次性输出。

正确做法:判断 URI 或接口注解等方式识别 SSE 请求,直接放行,不使用 ContentCachingResponseWrapper 包装。

替代方案:自定义 Wrapper 实现流式记录
如果你确实需要记录 SSE 的响应内容,可以考虑实现一个自定义的 HttpServletResponseWrapper,每次有数据写入时就记录日志或复制到原始输出流,而不是缓存全部内容。

public class StreamingResponseWrapper extends HttpServletResponseWrapper {
    private final ServletOutputStream outputStream;

    public StreamingResponseWrapper(HttpServletResponse response) throws IOException {
        super(response);
        this.outputStream = new CustomServletOutputStream(response.getOutputStream());
    }

    @Override
    public ServletOutputStream getOutputStream() throws IOException {
        return outputStream;
    }

    static class CustomServletOutputStream extends ServletOutputStream {
        private final DataOutputStream delegate;

        public CustomServletOutputStream(OutputStream out) {
            this.delegate = new DataOutputStream(out);
        }

        @Override
        public void write(int b) throws IOException {
            // 可以在这里记录日志
            delegate.write(b);
        }

        // 实现其他 write 方法...
    }
}


 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值