背景知识

项目组需要打印所有Restful接口的请求及响应报文，而通过HttpServletRequest获取输入流InputStream最多只能获取一次，重复获取会抛异常——Required Request Body is Missing。

相关技术知识点：

调用时许(待完善)：

编码实现

• BodyLogInputStream.java

public class BodyLogInputStream extends ServletInputStream {
	private final ByteArrayInputStream is;
	public BodyLogInputStream(byte[] body) {
		is = new ByteArrayInputStream(body);
	}
	@Override
	public boolean isFinished() {
		return true;
	}
	@Override
	public boolean isReady() {
		return true;
	}
	@Override
	public void setReadListener(ReadListener readListener){
		
	}
	@Override
	public int read() throws IOException {
		return is.read();
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

• BodyLogOutputStream.java

public class BodyLogOutputStream extends ServletOutputStream {
	private final ByteArrayOutputStream os;
	public BodyLogOutputStream(ByteArrayOutputStream os){
		this.os = os;
	}
	@Override
	public boolean isReady() { return true; }
	@Override
	public void setWriteListener(WriteListener writeListener){ }
	@Override
	public void write(int b) throws IOException {
		os.write(b);
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

• BodyLogRequestWrapper.java

public class BodyLogRequestWrapper extends HttpServletRequestWrapper {
	private final byte[] body;
	public BodyLogRequestWrapper(HttpServletRequest request, byte[] body){
		super(request);
		this.body = body;
	}
	@Override
	public ServletInputStream getInputStream() throw IOException {
		return new BodyLogInputStream(data);
	}
}
1
2
3
4
5
6
7
8
9
10
11

• BodyLogResponseWrapper.java

public class BodyLogResponseWrapper extends HttpServletResponseWrapper {
	private final ByteArrayOutputStream os;
	public BodyLogResponseWrapper (HttpServletResponse response){
		super(response);
		os = new ByteArrayOutputStream();
	}
	@Override
	public ServletOutputStream getOutputStream() throws IOException {
		return new BodyLogOutputStream(os);
	}
	/**
	* 钩子函数 获取写入OutputStream中的字节数组
	*/
	public byte[] getBytes() throws IOException {
		return BodyLogUtil.getBytes(os);
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

• BodyLogUtil.java

public class BodyLogUtil {
	public static byte[] getBytes(ByteArrayOutputStream os) throws IOException {
		os.flush();
		byte[] bytes = os.toByteArray();
		os.close();
		return bytes;
	}
	
	public static byte[] getBytes(InputStream is) throws IOException{
		ByteArrayOutputStream os = new ByteArrayOutputStream();
		byte[] buffer = new byte[1024];
		int n = -1;
		while( -1 != (n = is.read(buffer))) {
			os.write(buffer, 0, n);
		}
		is.close();
		return getBytes(os);
	}
	public static void setBytes(OutputStream os,byte[] bytes) throws IOException{
		os.write(bytes);
		os.close();
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

• BodyLogFilter.java

public class BodyLogFilter implements Filter {
	private final static Logger logger = LoggerFactory.getLogger(BodyLogFilter.class);
	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		
	}
	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
		//获取请求报文
		byte[] requestData = BodyLogUtil.getBytes(servletRequest.getInputStream());
		logger.info("请求报文:{}",new String(requestData,Charset.forName(servletRequest.getCharacterEncoding())));
	
		//组装RequestWrapper与ResponseWrapper
		BodyLogRequestWrapper requestWrapper = new BodyLogRequestWrapper((HttpServletReuqest)servletRequest, requestData);
		BodyLogResponseWrapper responseWrapper = new BodyLogResponseWrapper((HttpServletResponse)servletResponse);
		filterChain.doFilter(requestWrapper, responseWrapper);
		
		//获取响应报文
		byte[] responseData = responseWrapper.getBytes();
		logger.info("响应报文:{}",new String(responseData,Charset.forName(servletRequest.getCharacterEncoding())));
		
		//回写Reponse
		BodyLogUtil.setBytes(servletResponse.getOutputStream(), responseData);

	}

	@Override
	publiv void destroy() {
		
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31