SpringBoot v2.2以上重復(fù)讀取Request Body內(nèi)容的解決方案
更新時間：2021年10月26日 14:39:00 作者：jlcon
這篇文章主要介紹了SpringBoot v2.2以上重復(fù)讀取Request Body內(nèi)容的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
SpringBoot v2.2以上重復(fù)讀取Request Body內(nèi)容
一、需求
項目有兩個場景會用到從Request的Body中讀取內(nèi)容。
- 打印請求日志
- 提供Api接口，在api方法執(zhí)行前，從Request Body中讀取參數(shù)進行驗簽，驗簽通過后在執(zhí)行api方法
二、解決方案
2.1 自定義RequestWrapper
public class MyRequestWrapper extends HttpServletRequestWrapper {
private final String body;
public MyRequestWrapper(HttpServletRequest request) throws IOException {
super(request);
this.body = RequestReadUtils.read(request);
}
public String getBody() {
return body;
}
@Override
public ServletInputStream getInputStream() throws IOException {
final ByteArrayInputStream bais = new ByteArrayInputStream(body.getBytes());
return new ServletInputStream() {
...略
};
}
@Override
public BufferedReader getReader() throws IOException {
return new BufferedReader(new InputStreamReader(this.getInputStream()));
}
}
RequestReadUtils（網(wǎng)上抄的）
private static final int BUFFER_SIZE = 1024 * 8;
public static String read(HttpServletRequest request) throws IOException {
BufferedReader bufferedReader = request.getReader();
for (Enumeration<String> iterator = request.getHeaderNames(); iterator.hasMoreElements();) {
String type = iterator.nextElement();
System.out.println(type+" = "+request.getHeader(type));
}
System.out.println();
StringWriter writer = new StringWriter();
write(bufferedReader,writer);
return writer.getBuffer().toString();
}
public static long write(Reader reader,Writer writer) throws IOException {
return write(reader, writer, BUFFER_SIZE);
}
public static long write(Reader reader, Writer writer, int bufferSize) throws IOException
{
int read;
long total = 0;
char[] buf = new char[bufferSize];
while( ( read = reader.read(buf) ) != -1 ) {
writer.write(buf, 0, read);
total += read;
}
return total;
}
2.2 定義Filter
@WebFilter
public class TestFilter implements Filter{
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain){
HttpServletRequest request = (HttpServletRequest) servletRequest;
HttpServletResponse response = (HttpServletResponse) servletResponse;
MyRequestWrapper wrapper = WebUtils.getNativeRequest(request, MyRequestWrapper.class);
chain.doFilter(wrapper == null ? new MyRequestWrapper(request) :wrapper,servletRequest);
}
}
三、遇到問題
使用的SpringBoot v2.1.x版本
- Form提交無問題
- 獲取RequestBody無問題
使用SpringBoot v2.2.0以上版本（包括v2.3.x）
- Form提交無法獲取參數(shù)
- 獲取RequestBody無問題
四、問題排查
經(jīng)過排查，v2.2.x對比v2.1.x的不同在于一下代碼差異：
BufferedReader bufferedReader = request.getReader();
-----------------
char[] buf = new char[bufferSize];
while( ( read = reader.read(buf) ) != -1 ) {
writer.write(buf, 0, read);
total += read;
}
當(dāng)表單提交時
- v2.1.x無法read到內(nèi)容，讀取結(jié)果為-1
- v2.2.x、v2.3.x能夠讀取到內(nèi)容
當(dāng)表單提交時（x-www-form-urlencoded），inputStream讀取一次后后續(xù)不會觸發(fā)wrapper的getInputStream操作，所以Controller無法獲取到參數(shù)。
解決方案
MyRequestWrapper改造
public class MyRequestWrapper extends HttpServletRequestWrapper {
private final String body;
public MyRequestWrapper(HttpServletRequest request) throws IOException {
super(request);
this.body = getBodyString(request);
}
public String getBody() {
return body;
}
public String getBodyString(final HttpServletRequest request) throws IOException {
String contentType = request.getContentType();
String bodyString = "";
StringBuilder sb = new StringBuilder();
if (StringUtils.isNotBlank(contentType) && (contentType.contains("multipart/form-data") || contentType.contains("x-www-form-urlencoded"))) {
Map<String, String[]> parameterMap = request.getParameterMap();
for (Map.Entry<String, String[]> next : parameterMap.entrySet()) {
String[] values = next.getValue();
String value = null;
if (values != null) {
if (values.length == 1) {
value = values[0];
} else {
value = Arrays.toString(values);
}
}
sb.append(next.getKey()).append("=").append(value).append("&");
}
if (sb.length() > 0) {
bodyString = sb.toString().substring(0, sb.toString().length() - 1);
}
return bodyString;
} else {
return IOUtils.toString(request.getInputStream());
}
}
@Override
public ServletInputStream getInputStream() throws IOException {
final ByteArrayInputStream bais = new ByteArrayInputStream(body.getBytes());
return new ServletInputStream() {
@Override
public boolean isFinished() {
return false;
}
@Override
public boolean isReady() {
return false;
}
@Override
public int read() {
return bais.read();
}
@Override
public void setReadListener(ReadListener readListener) {
}
};
}
@Override
public BufferedReader getReader() throws IOException {
return new BufferedReader(new InputStreamReader(this.getInputStream()));
}
}
SpringBoot 讀取Request參數(shù)的坑
后端拿參數(shù)相關(guān)
默認配置時，
getInputStream()和getReader()一起使用會報錯
使用兩遍getInputStream()，第二遍會為空
當(dāng)存在@RequestBody等注解時，springMVC已讀取過一遍流，默認單獨使用getInputStream()或getReader()都為空。
解決：寫filter繼承HttpServletRequestWrapper，緩存InputStream，覆蓋getInputStream()和getReader()方法，使用ByteArrayInputStream is = new ByteArrayInputStream(body.getBytes());讀取InputStream。
注意：springboot中，過濾器只需@Component即可生效，另外可在FilterRegistrationBean中配置路徑和優(yōu)先級。
對于攔截器，必須在InterceptorRegistry中調(diào)用addInterceptor方法。（路徑可鏈?zhǔn)教砑樱?/p>
關(guān)于流
只能讀一遍，類似管子。
只承擔(dān)傳輸職責(zé)，而與處理和存儲無關(guān)。
對于byte流而言，進行重復(fù)讀取易于實現(xiàn)，但指針不重置，應(yīng)是為了與InputStream接口定義保持一致。
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
spring boot整合redis實現(xiàn)RedisTemplate三分鐘快速入門
這篇文章主要介紹了spring boot整合redis實現(xiàn)RedisTemplate三分鐘快速入門，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12
這篇文章主要給大家介紹了關(guān)于Mybatis中輸入輸出映射與動態(tài)Sql的相關(guān)資料,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2019-02-02
Spring中BeanFactoryPostProcessors是如何執(zhí)行的
BeanFactoryPostProcessor是Spring容器提供的一個擴展機制,它允許開發(fā)者在Bean的實例化和初始化之前對BeanDefinition進行修改和處理,這篇文章主要介紹了你知道Spring中BeanFactoryPostProcessors是如何執(zhí)行的嗎,需要的朋友可以參考下2023-11-11
Java實現(xiàn)中文字符串與unicode互轉(zhuǎn)工具類
這篇文章主要為大家詳細介紹了Java實現(xiàn)中文字符串與unicode互轉(zhuǎn)的工具類，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-04-04
這篇文章主要介紹了Springboot整合Mybatispuls的相關(guān)資料,本文通過實例代碼給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-11-11
基于Java Springboot + Vue + MyBatis實現(xiàn)音樂播放系統(tǒng)
這篇文章主要介紹了一個完整的音樂播放系統(tǒng)是基于Java Springboot + Vue + MyBatis編寫的，本文給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-08-08
這篇文章主要介紹了Java實現(xiàn)自定義自旋鎖代碼實例,Java自旋鎖是一種線程同步機制,它允許線程在獲取鎖時不立即阻塞,而是通過循環(huán)不斷嘗試獲取鎖,直到成功獲取為止,自旋鎖適用于鎖競爭激烈但持有鎖的時間很短的情況,需要的朋友可以參考下2023-10-10
這篇文章主要介紹了RabbitMQ消息單獨與批量的TTL，TTL全名是Time To Live存活時間，表示當(dāng)消息由生產(chǎn)端存入MQ當(dāng)中的存活時間，當(dāng)時間到達的時候還未被消息就會被自動清除，感興趣的同學(xué)可以參考下文2023-05-05
Java利用FileUtils讀取數(shù)據(jù)和寫入數(shù)據(jù)到文件
這篇文章主要介紹了Java利用FileUtils讀取數(shù)據(jù)和寫入數(shù)據(jù)到文件，下面文章圍繞FileUtils的相關(guān)資料展開怎么讀取數(shù)據(jù)和寫入數(shù)據(jù)到文件的內(nèi)容，具有一定的參考價值，徐婭奧德小伙伴可以參考一下2021-12-12
java線程中synchronized和Lock區(qū)別及介紹
這篇文章主要為大家介紹了java線程中synchronized和Lock區(qū)別及介紹，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-06-06