關(guān)于Filter中獲取請求體body后再次讀取的問題
更新時間：2022年03月15日 10:50:58 作者：fayeyiwang
這篇文章主要介紹了關(guān)于Filter中獲取請求體body后再次讀取的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
Filter獲取請求體body再次讀取
工作需要，要將請求和響應(yīng)做一些處理,寫一個filter攔截請求，攔截request中body內(nèi)容后，字符流關(guān)閉，controller取到的請求體內(nèi)容為空。
從Request中獲取輸入流，InputStream只能被讀取一次。
解決方案
給request添加一個包裝類BodyWrapper，繼承HttpServletRequestWrapper，
先從request中取輸入流，讀取流中的數(shù)據(jù)，然后重寫getInputStream（）和getReader（）方法。
chain.doFilter(requestWrapper, response);
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.util.Enumeration;
import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import com.xera.fsafesso.HttpHelper;
public class BodyWrapper extends HttpServletRequestWrapper {undefined
? ? private final byte[] body;
? ? public BodyWrapper(HttpServletRequest request) throws IOException {undefined
? ? ? ? super(request);
? ? ? ? body = HttpHelper.getBodyString(request).getBytes(Charset.forName("UTF-8"));
? ? }
? ? @Override
? ? public BufferedReader getReader() throws IOException {undefined
? ? ? ? return new BufferedReader(new InputStreamReader(getInputStream()));
? ? }
? ? @Override
? ? public ServletInputStream getInputStream() throws IOException {undefined
? ? ? ? final ByteArrayInputStream bais = new ByteArrayInputStream(body);
? ? ? ? return new ServletInputStream(){undefined
? ? ? ? ? ? @Override
? ? ? ? ? ? public int read() throws IOException {undefined
? ? ? ? ? ? ? ? return bais.read();
? ? ? ? ? ? }
? ? ? ? ? ? @Override
? ? ? ? ? ? public boolean isFinished() {undefined
? ? ? ? ? ? ? ? return false;
? ? ? ? ? ? }
? ? ? ? ? ? @Override
? ? ? ? ? ? public boolean isReady() {undefined
? ? ? ? ? ? ? ? return false;
? ? ? ? ? ? }
? ? ? ? ? ? @Override
? ? ? ? ? ? public void setReadListener(ReadListener arg0) {undefined
? ? ? ? ? ? }
? ? ? ? };
? ? }
? ? @Override
? ? public String getHeader(String name) {undefined
? ? ? ? return super.getHeader(name);
? ? }
? ? @Override
? ? public Enumeration<String> getHeaderNames() {undefined
? ? ? ? return super.getHeaderNames();
? ? }
? ? @Override
? ? public Enumeration<String> getHeaders(String name) {undefined
? ? ? ? return super.getHeaders(name);
? ? }
}import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import javax.servlet.ServletRequest;
public class HttpHelper {undefined
? ? ?/**
? ? ?* 獲取請求Body
? ? ?* @param request
? ? ?* @return
? ? ?*/
? ? public static String getBodyString(ServletRequest request) {undefined
? ? ? ? StringBuilder sb = new StringBuilder();
? ? ? ? InputStream inputStream = null;
? ? ? ? BufferedReader reader = null;
? ? ? ? try {undefined
? ? ? ? ? ? inputStream = request.getInputStream();
? ? ? ? ? ? reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName("UTF-8")));
? ? ? ? ? ? String line = "";
? ? ? ? ? ? while ((line = reader.readLine()) != null) {undefined
? ? ? ? ? ? ? ? sb.append(line);
? ? ? ? ? ? }
? ? ? ? } catch (IOException e) {undefined
? ? ? ? ? ? e.printStackTrace();
? ? ? ? } finally {undefined
? ? ? ? ? ? if (inputStream != null) {undefined
? ? ? ? ? ? ? ? try {undefined
? ? ? ? ? ? ? ? ? ? inputStream.close();
? ? ? ? ? ? ? ? } catch (IOException e) {undefined
? ? ? ? ? ? ? ? ? ? e.printStackTrace();
? ? ? ? ? ? ? ? }
? ? ? ? ? ? }
? ? ? ? ? ? if (reader != null) {undefined
? ? ? ? ? ? ? ? try {undefined
? ? ? ? ? ? ? ? ? ? reader.close();
? ? ? ? ? ? ? ? } catch (IOException e) {undefined
? ? ? ? ? ? ? ? ? ? e.printStackTrace();
? ? ? ? ? ? ? ? }
? ? ? ? ? ? }
? ? ? ? }
? ? ? ? return sb.toString();
? ? }
}Filter中寫法如下：
HttpServletRequest httpServletRequest = (HttpServletRequest) request;
? ? ? ? ? ? Map<String, String> requestMap = this.getTypesafeRequestMap(httpServletRequest);
? ? ? ? ? ? requestWrapper = new BodyWrapper(httpServletRequest);
? ? ? ? ? ? String body = HttpHelper.getBodyString(requestWrapper);
? ? ? ? ? ? log.info("loggingFilter---請求路徑 {},請求參數(shù) {},請求體內(nèi)容 {}",httpServletRequest.getRequestURL(),requestMap,body);
? ? ? chain.doFilter(requestWrapper, response);在使用注解的方式（即@WebFilter）聲明過濾器時，
需要再main函數(shù)類上添加@ServletComponentScan（basePackages = "此處寫明類地址，格式為包名+類名（如com.*）
Http請求解決body流一旦被讀取了就無法二次讀取情況
相信大家在工作當(dāng)中，經(jīng)常會遇到需要處理http請求及響應(yīng)body的場景，這里最大的問題應(yīng)該就是body中流以但被讀取就無法二次讀取了。
解決request請求流只能讀取一次的問題
我們編寫一個過濾器，這樣就可以重寫body了
package com.interceptor;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class MyFilter implements Filter {
private static String privateKey ;
public String getPrivateKey() {
return privateKey;
}
public void setPrivateKey(String key) {
privateKey = key;
}
/**
* 排除過濾路徑
*/
List<String> ignore = Arrays.asList("/xxxx");
/**
* 前綴排除 如 /static/goods 排除
*/
List<String> ignorePrefix = Arrays.asList( "/css/", "/pop/", "/js/", "/static/", "/images/", "/favicon.ico");
/**
* 排除過濾路徑
*/
List<String> ignoreSuffix = Arrays.asList("/test");
@Override
public void init(FilterConfig filterConfig) throws ServletException {
//過濾器初始化
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
// 防止流讀取一次后就沒有了, 所以需要將流繼續(xù)寫出去
HttpServletRequest request = (HttpServletRequest) servletRequest;
HttpServletResponse response = (HttpServletResponse) servletResponse;
String uri = request.getServletPath();
response.setContentType("application/json;charset=UTF-8");
ServletRequest requestWrapper = null;
if(canIgnore(uri)) {
requestWrapper = new MyFilterBodyReaderHttpServletRequestWrapper(request);
filterChain.doFilter(requestWrapper, response);
return;
}
try {
requestWrapper = new MyFilterBodyReaderHttpServletRequestWrapper(request, response, privateKey);
} catch (Exception e) {
e.printStackTrace();
return;
}
filterChain.doFilter(requestWrapper, servletResponse);
}
@Override
public void destroy() {
//過濾器銷毀
}
private boolean canIgnore(String uri) {
logger.info("過濾器 request uri : {} ",uri);
boolean isExcludedPage = false;
for (String page : ignore) {
if (uri.equals(page)) {
logger.info("請求路徑不需要攔截，忽略該uri : {} ",uri);
isExcludedPage = true;
break;
}
}
for (String prefix : ignorePrefix) {
if (uri.startsWith(prefix)) {
logger.info("請求路徑前綴[{}]，不攔截該uri : {} ", prefix, uri);
isExcludedPage = true;
break;
}
}
for (String prefix : ignoreSuffix) {
if (uri.endsWith(prefix)) {
logger.info("請求路徑后綴[{}]，不攔截該uri : {} ", prefix, uri);
isExcludedPage = true;
break;
}
}
return isExcludedPage;
}
}
package com.interceptor;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.util.Map;
import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;
import com.alibaba.fastjson.JSON;
/**
* @Description: TODO 過濾器處理requestbody獲取一次就失效
*/
public class MyFilterBodyReaderHttpServletRequestWrapper extends HttpServletRequestWrapper {
private final byte[] body;
/**
* TODO 重寫requestbody
* @param request
* @throws IOException
*/
public MyFilterBodyReaderHttpServletRequestWrapper(HttpServletRequest request) throws IOException {
super(request);
String sessionStream = getBodyString(request);
body = sessionStream.getBytes(Charset.forName("UTF-8"));
}
/**
* TODO 攔截解密，校驗，重寫requestbody
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public MyFilterBodyReaderHttpServletRequestWrapper(HttpServletRequest request,HttpServletResponse response, String clientKey, Boolean ignoreCheckSign) throws Exception {
super(request);
String sessionStream = getBodyString(request);
Map paramMap = (Map) JSON.parse(sessionStream);
/**
*自己項目中與合作方的加解密內(nèi)容
*如：String data= (String) paramMap.get("data");
* String json=xxxxxutil.decrypt(參數(shù));
*/
body = json.getBytes(Charset.forName("UTF-8"));
}
/**
* TODO 獲取請求Body
* @param request
* @return
* @throws
*/
public String getBodyString(final ServletRequest request) {
StringBuilder sb = new StringBuilder();
InputStream inputStream = null;
BufferedReader reader = null;
try {
inputStream = cloneInputStream(request.getInputStream());
reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName("UTF-8")));
String line = "";
while ((line = reader.readLine()) != null) {
sb.append(line);
}
}
catch (IOException e) {
e.printStackTrace();
}
finally {
if (inputStream != null) {
try {
inputStream.close();
}
catch (IOException e) {
e.printStackTrace();
}
}
if (reader != null) {
try {
reader.close();
}
catch (IOException e) {
e.printStackTrace();
}
}
}
return sb.toString();
}
/**
* TODO 無參獲取請求Body
* @return
* @throws
*/
public String getBodyString() {
if (body == null) {
return null;
}
String str = new String(body);
return str;
}
/**
* TODO 復(fù)制輸入流
* @param inputStream
* @return
* @throws
*/
public InputStream cloneInputStream(ServletInputStream inputStream) {
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
byte[] buffer = new byte[1024];
int len;
try {
while ((len = inputStream.read(buffer)) > -1) {
byteArrayOutputStream.write(buffer, 0, len);
}
byteArrayOutputStream.flush();
}
catch (IOException e) {
e.printStackTrace();
}
InputStream byteArrayInputStream = new ByteArrayInputStream(byteArrayOutputStream.toByteArray());
return byteArrayInputStream;
}
@Override
public BufferedReader getReader() throws IOException {
return new BufferedReader(new InputStreamReader(getInputStream()));
}
@Override
public ServletInputStream getInputStream() throws IOException {
final ByteArrayInputStream bais = new ByteArrayInputStream(body);
return new ServletInputStream() {
@Override
public int read() throws IOException {
return bais.read();
}
@Override
public boolean isFinished() {
return false;
}
@Override
public boolean isReady() {
return false;
}
@Override
public void setReadListener(ReadListener readListener) {
}
};
}
} 以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
java.nio全稱java non-blocking IO，是指jdk1.4 及以上版本里提供的新api（New IO），使用它可以提供非阻塞式的高伸縮性網(wǎng)絡(luò)。下面我們來簡單了解一下吧2019-05-05
java 數(shù)據(jù)結(jié)構(gòu)基本算法希爾排序
這篇文章主要介紹了數(shù)據(jù)結(jié)構(gòu)基本算法希爾排序的相關(guān)資料,需要的朋友可以參考下2017-08-08
關(guān)于MyBatis plus條件構(gòu)造器的逐條詳解
什么是條件構(gòu)造器呢？簡單來說，條件構(gòu)造器就是用來生成我們查數(shù)據(jù)庫的sql。它可以簡化sql代碼的編寫，靈活、方便且易于維護(hù)2021-09-09
在Java中從字符串中刪除空格有很多不同的方法,如trim,replaceAll等,下面這篇文章主要給大家介紹了關(guān)于Java刪除String中空格的多種解決方法,文中通過實例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-06-06
Spring Boot分段處理List集合多線程批量插入數(shù)據(jù)的解決方案
大數(shù)據(jù)量的List集合,需要把List集合中的數(shù)據(jù)批量插入數(shù)據(jù)庫中,本文給大家介紹Spring Boot分段處理List集合多線程批量插入數(shù)據(jù)的解決方案,感興趣的朋友跟隨小編一起看看吧2024-04-04
Java中為什么this可以調(diào)用當(dāng)前實例
本文主要介紹了為什么可以通過this關(guān)鍵字訪問到當(dāng)前對象呢，文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-07-07
10k+點贊的 SpringBoot 后臺管理系統(tǒng)教程詳解
這篇文章主要介紹了10k+點贊的 SpringBoot 后臺管理系統(tǒng)教程詳解,本文通過圖文并茂的形式給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-01-01
這篇文章主要介紹了Java中的堆排序詳解,堆排序的重點,在于排序的方式,堆排序,就是以堆的形式去排序,毫無疑問,了解堆很重要,文中提供了圖解與部分代碼,需要的朋友可以參考下2023-08-08
詳解如何使用Java流API構(gòu)建樹形結(jié)構(gòu)數(shù)據(jù)
在實際開發(fā)中,構(gòu)建樹狀層次結(jié)構(gòu)是常見需求,本文主要為大家詳細(xì)介紹了如何使用Java 8 Stream API將扁平化的菜單數(shù)據(jù)轉(zhuǎn)換為具有層級關(guān)系的樹形結(jié)構(gòu),需要的可以參考下2024-04-04
這篇文章主要介紹了Java數(shù)組集合的深度復(fù)制代碼實例,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-11-11