使用Tomcat自定义Valve包装响应读响应体，解决Response包装器Payload为空问题

要正确捕获Tomcat响应的Payload，核心是自定义HttpServletResponseWrapper并正确拦截输出流，默认的Response包装器不会自动捕获输出内容。以下是具体实现方案：

1. 实现捕获响应内容的Response包装器 #

继承HttpServletResponseWrapper，重写getOutputStream()和getWriter()方法，用ByteArrayOutputStream捕获所有输出：

import javax.servlet.ServletOutputStream;
import javax.servlet.WriteListener;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintWriter;

public class CapturingResponseWrapper extends HttpServletResponseWrapper {

    private ByteArrayOutputStream byteArrayOutputStream;
    private ServletOutputStream servletOutputStream;
    private PrintWriter printWriter;

    public CapturingResponseWrapper(HttpServletResponse response) {
        super(response);
        byteArrayOutputStream = new ByteArrayOutputStream();
    }

    @Override
    public ServletOutputStream getOutputStream() throws IOException {
        if (servletOutputStream == null) {
            servletOutputStream = new CapturingServletOutputStream(byteArrayOutputStream);
        }
        return servletOutputStream;
    }

    @Override
    public PrintWriter getWriter() throws IOException {
        if (printWriter == null) {
            printWriter = new PrintWriter(byteArrayOutputStream);
        }
        return printWriter;
    }

    @Override
    public void flushBuffer() throws IOException {
        if (servletOutputStream != null) {
            servletOutputStream.flush();
        }
        if (printWriter != null) {
            printWriter.flush();
        }
        super.flushBuffer();
    }

    public byte[] getCapturedContent() throws IOException {
        flushBuffer();
        return byteArrayOutputStream.toByteArray();
    }

    private static class CapturingServletOutputStream extends ServletOutputStream {

        private final ByteArrayOutputStream outputStream;

        public CapturingServletOutputStream(ByteArrayOutputStream outputStream) {
            this.outputStream = outputStream;
        }

        @Override
        public void write(int b) throws IOException {
            outputStream.write(b);
        }

        @Override
        public boolean isReady() {
            return true;
        }

        @Override
        public void setWriteListener(WriteListener writeListener) {
            // 异步请求场景需额外实现，同步请求可忽略
        }
    }
}

2. 在Valve中使用包装器捕获响应 #

在ValveBase的invoke方法中，先包装Response，待请求链处理完成后再提取捕获的内容：

import org.apache.catalina.connector.Request;
import org.apache.catalina.connector.Response;
import org.apache.catalina.valves.ValveBase;

import javax.servlet.ServletException;
import java.io.IOException;

public class LoggingValve extends ValveBase {

    @Override
    public void invoke(Request request, Response response) throws IOException, ServletException {
        // 包装原始Response
        CapturingResponseWrapper wrappedResponse = new CapturingResponseWrapper(response);

        // 继续执行后续请求处理链
        getNext().invoke(request, wrappedResponse);

        // 获取并处理响应Payload
        byte[] responsePayload = wrappedResponse.getCapturedContent();
        // 根据响应编码转换为字符串（二进制内容直接用byte数组处理）
        String responseBody = new String(responsePayload, wrappedResponse.getCharacterEncoding());

        // 此处添加日志逻辑，比如写入日志文件或控制台
        System.out.println("Captured Response Body: " + responseBody);
    }
}

关键注意事项 #

• 必须在请求链执行完成后获取内容：只有调用getNext().invoke()之后，业务逻辑才会把响应写入流，此时才能捕获到完整的Payload。
• 处理字符编码：使用wrappedResponse.getCharacterEncoding()确保字符串转换的正确性，避免乱码。
• flush缓冲区：调用flushBuffer()确保所有缓存的响应内容都被写入到ByteArrayOutputStream中。
• 异步请求适配：如果应用使用异步Servlet，需要实现WriteListener来捕获异步输出的内容，否则可能无法获取完整Payload。

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