最近做的spring boot项目中,由于需要查看每次请求的数据,在每个接收方法出打印会比较繁琐,同时每个controller并不是同一个人编写,这样就又不统一了,于是想到这种日志可以在过滤器中打印出来,这样就可以打印所有的请求的数据了,但是由于请求的数据流中流只能被读取一次,此时如果在过滤器中获取了,那么在controller中的HttpServletRequest就无法获取到数据了,这样明显是不合理的,于是又想到可以将请求的数据流进行缓存起来,这样在过滤器中获取数据流打印日志后,可以将刚刚缓存起来的数据流重新用作请求,这样就避免了请求的数据流只能读取一次的问题。
代码如下:
package me.config.filter;
import org.apache.log4j.Logger;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
/**
* 类描述:
*
* @Author:wangjinhui
* @date:2018年12月29日
* @Version:1.1.0
*/
@WebFilter(servletNames = { "dispatcherServlet" })
public class AjaxFilter implements Filter {
private static Logger logger = Logger.getLogger(AjaxFilter.class);
private FilterConfig filterConfig = null;
@Override
public void init(FilterConfig filterConfig) throws ServletException {
this.filterConfig = filterConfig;
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletResponse httpResponse = (HttpServletResponse) servletResponse;
HttpServletRequest request = (HttpServletRequest) servletRequest;
// 设置允许哪些域名应用进行ajax访问 *表示允许所有的都可以访问
httpResponse.setHeader("Access-Control-Allow-Origin", "*");
httpResponse.setHeader("Access-Control-Allow-Methods", "GET,PUT,POST,DELETE");
httpResponse.setHeader("Access-Control-Allow-Headers", "Content-Type");
String url = request.getRequestURI();
ServletRequest requestWrapper = null;
if (request instanceof HttpServletRequest) {
requestWrapper = new MyHttpServletRequestWrapper((HttpServletRequest) request);
}
ByteArrayOutputStream byteOutput = getByteArrayOutputStream(requestWrapper);
logger.info("请求的控制器路径:" + url + "域名端口号:" + request.getRemoteHost() + "请求类型名称:" + request.getMethod()
+ "入参对应值:" + new String(byteOutput.toByteArray(), "UTF-8"));
// 调用后续serlvet
if (null == requestWrapper) {
filterChain.doFilter(request, servletResponse);
} else {
filterChain.doFilter(requestWrapper, servletResponse);
}
}
@Override
public void destroy() {
this.filterConfig = null;
}
public ByteArrayOutputStream getByteArrayOutputStream(ServletRequest requestWrapper) throws IOException {
// 使用流
InputStream reader = requestWrapper.getInputStream();
ByteArrayOutputStream byteOutput = new ByteArrayOutputStream(1024 * 4);
int i = 0;
byte[] b = new byte[1024 * 4];
while ((i = reader.read(b)) != -1) {
byteOutput.write(b, 0, i);
}
return byteOutput;
}
}
package me.config.filter;
import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.*;
/**
* 类描述:缓存getInputStream中的数据,因为getInputStream中的数据只能读取一次
*
* @Author:wangjinhui
* @date:2019年01月02日
* @Version:1.1.0
*/
public class MyHttpServletRequestWrapper extends HttpServletRequestWrapper {
private final byte[] toByteBody;
public MyHttpServletRequestWrapper(HttpServletRequest request) throws IOException {
super(request);
InputStream is = request.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream();
byte[] buffer = new byte[ 1024 ];
int read;
while ((read = is.read(buffer)) > 0) {
baos.write(buffer, 0, read);
}
toByteBody = baos.toByteArray();
}
@Override
public BufferedReader getReader() throws IOException {
return new BufferedReader(new InputStreamReader(getInputStream()));
}
@Override
public ServletInputStream getInputStream() throws IOException {
final ByteArrayInputStream bais = new ByteArrayInputStream(toByteBody);
return new ServletInputStream() {
@Override
public boolean isFinished() {
return false;
}
@Override
public boolean isReady() {
return false;
}
@Override
public void setReadListener(ReadListener listener) {
}
@Override
public int read() throws IOException {
return bais.read();
}
};
}
}
有了这两个文件的代码即可在过滤器中打印所有请求的请求数据内容,不过还需要在spring boot的启动文件上加上注解@ServletComponentScan,有了这个注解时@WebFilter注解才会生效,过滤器才会起作用。