继承HttpServletRequestWrapper 实现request中流的重复获取

业务场景:需要打印所有的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类,将其中的方法重写以满足我们的需求。

HttpServletRequestWrapper是一个装饰器模式的实现,它允许我们在不改变原始请求的情况下,对请求进行修改。在Interceptor中,我们可以通过HttpServletRequestWrapper来修改request参数。 首先,我们需要自定义一个类继承HttpServletRequestWrapper,重写getParameter方法,以实现修改request参数的功能。具体实现如下: ``` public class MyHttpServletRequestWrapper extends HttpServletRequestWrapper { private Map<String, String[]> params = new HashMap<>(); public MyHttpServletRequestWrapper(HttpServletRequest request) { super(request); this.params.putAll(request.getParameterMap()); } @Override public String getParameter(String name) { String[] values = params.get(name); if (values == null || values.length == 0) { return null; } return values[0]; } @Override public Map<String, String[]> getParameterMap() { return params; } @Override public Enumeration<String> getParameterNames() { return Collections.enumeration(params.keySet()); } public void addParameter(String name, String value) { if (params.containsKey(name)) { String[] values = params.get(name); values = Arrays.copyOf(values, values.length + 1); values[values.length - 1] = value; params.put(name, values); } else { params.put(name, new String[]{value}); } } } ``` 接下来,在Interceptor中,我们可以通过如下代码来使用MyHttpServletRequestWrapperrequest参数进行修改: ``` public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { if (request.getMethod().equalsIgnoreCase("get")) { // 使用MyHttpServletRequestWrapper对请求参数进行修改 MyHttpServletRequestWrapper requestWrapper = new MyHttpServletRequestWrapper(request); requestWrapper.addParameter("key", "value"); // 将修改后的request传给下一个Interceptor或Controller request = requestWrapper; } return true; } ``` 上述代码中,我们先判断请求的方法是否为get,如果是,则使用MyHttpServletRequestWrapper对请求参数进行修改,然后将修改后的request传给下一个Interceptor或Controller。如果请求方法不为get,则直接将原始request传给下一个Interceptor或Controller。 需要注意的是,使用HttpServletRequestWrapperrequest参数进行修改时,只有在下一个Interceptor或Controller真正使用request参数时,修改后的参数才会生效。如果在当前Interceptor中进行了修改,但在下一个Interceptor或Controller中并没有使用修改后的参数,那么修改就会失效。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值