解决HttpServletRequest的输入流只能读取一次的问题
背景
通常对安全性有要求的接口都会对请求参数做一些签名验证,而我们一般会把验签的逻辑统一放到过滤器或拦截器里,这样就不用每个接口都去重复编写验签的逻辑。
在一个项目中会有很多的接口,而不同的接口可能接收不同类型的数据,例如表单数据和json数据,表单数据还好说,调用request的getParameterMap就能全部取出来。而json数据就有些麻烦了,因为json数据放在body中,我们需要通过request的输入流去读取。
但问题在于request的输入流只能读取一次不能重复读取,所以我们在过滤器或拦截器里读取了request的输入流之后,请求走到controller层时就会报错。而本文的目的就是介绍如何解决在这种场景下遇到HttpServletRequest的输入流只能读取一次的问题。
注:本文代码基于SpringBoot框架
HttpServletRequest的输入流只能读取一次的原因
我们先来看看为什么HttpServletRequest的输入流只能读一次,当我们调用getInputStream()
方法获取输入流时得到的是一个InputStream对象,而实际类型是ServletInputStream,它继承于InputStream。
InputStream的read()
方法内部有一个postion,标志当前流被读取到的位置,每读取一次,该标志就会移动一次,如果读到最后,read()
会返回-1,表示已经读取完了。如果想要重新读取则需要调用reset()
方法,position就会移动到上次调用mark的位置,mark默认是0,所以就能从头再读了。调用reset()
方法的前提是已经重写了reset()
方法,当然能否reset也是有条件的,它取决于markSupported()
方法是否返回true。
InputStream默认不实现reset()
,并且markSupported()
默认也是返回false,这一点查看其源码便知:
我们再来看看ServletInputStream,可以看到该类没有重写mark()
,reset()
以及markSupported()
方法:
综上,InputStream默认不实现reset的相关方法,而ServletInputStream也没有重写reset的相关方法,这样就无法重复读取流,这就是我们从request对象中获取的输入流就只能读取一次的原因。
使用HttpServletRequestWrapper + Filter解决输入流不能重复读取问题
既然ServletInputStream不支持重新读写,那么为什么不把流读出来后用容器存储起来,后面就可以多次利用了。那么问题就来了,要如何存储这个流呢?
所幸JavaEE提供了一个 HttpServletRequestWrapper类,从类名也可以知道它是一个http请求包装器,其基于装饰者模式实现了HttpServletRequest界面,部分源码如下:
从上图中的部分源码可以看到,该类并没有真正去实现HttpServletRequest的方法,而只是在方法内又去调用HttpServletRequest的方法,所以我们可以通过继承该类并实现想要重新定义的方法以达到包装原生HttpServletRequest对象的目的。
首先我们要定义一个容器,将输入流里面的数据存储到这个容器里,这个容器可以是数组或集合。然后我们重写getInputStream方法,每次都从这个容器里读数据,这样我们的输入流就可以读取任意次了。
实现代码:
package com.eshore.ismp.filter; import org.springframework.util.StreamUtils; import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets; /**
* Created by lihaodi on 2016/4/7.
*/
public class RequestWrapper extends HttpServletRequestWrapper { private byte[] requestBody; public RequestWrapper(HttpServletRequest request) throws IOException {
super(request);
requestBody = StreamUtils.copyToByteArray(request.getInputStream());
} @Override
public BufferedReader getReader() {
return new BufferedReader(new InputStreamReader(getInputStream(), StandardCharsets.UTF_8));
} @Override
public ServletInputStream getInputStream() {
if (requestBody == null) {
requestBody = new byte[0];
}
final ByteArrayInputStream bais = new ByteArrayInputStream(requestBody);
return new ServletInputStream() {
@Override
public boolean isFinished() {
return false;
} @Override
public boolean isReady() {
return false;
} @Override
public void setReadListener(ReadListener readListener) { } @Override
public int read() throws IOException {
return bais.read();
}
};
}
}
最新文章
- 点单登录原理和java实现简单的单点登录
- struts-OGNL
- Intellij IDEA tomcat相关
- [刘阳Java]_Java环境搭建_第2讲
- bsgrid
- eclipse安装tomcate插件步骤
- 如何让WIN32应用程序支持MFC类库
- 客户端动态调用cxf websevice 异常
- SQL流程控制语句学习(三):while break continue
- [Mugeda HTML5技术教程之2] Mugeda HTML5富媒体平台简介
- 分享到QQ空间、新浪微博、腾讯微博的代码!(收藏)
- [转]标准C++字符串string以及MFC6.0字符串CString的tokenize和split函数
- 类虚函数表原理实现分析(当我们将虚表地址[n]中的函数替换,那么虚函数的实现就由我们来控制了)
- meta--------link
- Python爬虫框架Scrapy安装使用步骤
- nagios安装及监控Linux主机
- js验证input输入框(字母,数字,符号,中文)
- ettercap+urlsnarf+driftnet+wireshark监听妹子上网
- mysql方言不支持blob类型解决方案
- Python+requests+unittest+excel实现接口自动化测试框架
热门文章
- tensorflow基础-数据类型
- python-基础-def(*agrs,**kwagrs)
- [译]Vulkan教程(15)图形管道基础之RenderPass
- 秒懂:tomcat的maxConnections、maxThreads、acceptCount 图解
- FreeRTOS操作系统教程发布,支持F103,F407和F429,配套145个例子,1200页教程
- Vue 路由导航解析流程
- win7怎么使用远程桌面连接(win10类似,同样适用)
- ThinkPHP调用其他控制器的方法,助手函数action()
- PalletOne调色板跨链的ETH提币实现
- (转)格拉布斯准则(Grubbs Criterion)处理数据异常