业务场景:需要打印所有的api请求的信息到log中,在Filter中拦截了所有的api请求,但是打印的信息中需要包含api请求的body,如果在Filter中使用request.getInputStream()来获取流来得到body中的信息,可以达到预期效果,但是流的获取只能获取一次,之后再获取就获取不到了,导致controller无法拿到参数。
解决办法:HttpServletRequestWrapper,该类是HttpServletRequest的封装类,我们可以自定义一个类,继承HttpServletRequestWrapper,重写其中的getInputStream方法,让其可以重复获取我们想要的流,并且在Filter中的filterChain.doFilter(ServlerRequest, ServletResponse)方法中,传入我们的自定义类的实例,而不是原来的HttpServletRequest对象,由于我们的类是继承自HttpServletRequestWrapper类,所以当参数传入此方法是没有问题的。由于我们自定义类中的getInputStream方法已经被重写为可多次获取的版本,所以也就不用担心controller无法获取到数据。
具体实现:
//自定义的ServletRequest类
import org.apache.commons.io.IOUtils;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
public class MyResettableServletRequest extends HttpServletRequestWrapper {
//保存流中的数据
private byte[] data;
public MyResettableServletRequest(HttpServletRequest request) throws Exception{
super(request);
//从流中获取数据
data = IOUtils.toByteArray(request.getInputStream());
}
public ServletInputStream getInputStream(){
//在调用getInputStream函数时,创建新的流,包含原先数据流中的信息,然后返回
return new MyServletInputStream(new ByteArrayInputStream(data));
}
class MyServletInputStream extends ServletInputStream{
private InputStream inputStream;
public MyServletInputStream(InputStream inputStream){
this.inputStream = inputStream;
}
@Override
public int read() throws IOException {
return inputStream.read();
}
}
}
//在Filter中使用
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
MyResettableServletRequest myRequest = new MyResettableServletRequest(request);
String bodyParam = IOUtils.toString(myRequest.getInputStream());
/**
* 打印log
*/
filterChain.doFilter(myRequest, servletResponse);
}
总结:原生的HttpServletRequest类是有许多的缺陷的,比如无法重复获取其中的流,无法通过setAttribute方法来改写属性,当我们遇到这样的情况时,一个很好的解决办法就是使用装饰者模式,重写一个类,继承自Wrapper类,将其中的方法重写以满足我们的需求。