前言
最近項目中來了一個新的需求：需要搞一個攔截器，對請求接口時傳遞過來的參數做一個加密處理。這個需求本身並不難，但是在實現功能的過程中卻遇到了一個比較「棘手」的問題...
踩坑之路
問題描述
在攔截器中獲取接口參數的時候需要分兩種情況：
情況一：接口使用 @requestParam 接收參數
情況二：接口使用 @RequestBody 接收參數
針對情況一，代碼寫起來就非常簡單了，我們只需要在攔截器中通過request.getParameterMap() 來獲得全部 Parameter 參數就可以了；但是當接口使用 @RequestBody 接收參數時，我們在攔截器中使用同樣的方法獲取參數，就會出現流已關閉的異常，也就導致參數讀取失敗了... 這是因為 Spring 已經對 @RequestBody 提前進行處理，而 HttpServletReqeust 獲取輸入流時僅允許讀取一次，所以會報java.io.IOException: Stream closed。
俗話說「繁瑣問題必有猥瑣解法」，既然 HttpServletReqeust 獲取輸入流時僅允許讀取一次，那麼我們就可以重新構建 ServletRequest ，讓輸入流支持二次讀取就可以了 ( •̀ ω •́ )y
解決方案
既然解決思路已經有了，那麼我們就可以直接寫代碼了，那麼這裡就不再多說，直接上代碼
① 定義過濾器，所有請求先進入過濾器，並將 request 進行處理
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
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;
/***
* HttpServletRequest 過濾器
* 解決: request.getInputStream()只能讀取一次的問題
* 目標: 流可重複讀
*
* @author liziye
*/
@Component
@WebFilter(filterName = "HttpServletRequestFilter", urlPatterns = "/")
@Order(99)
public class HttpServletRequestFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
ServletRequest requestWrapper = null;
if(servletRequest instanceof HttpServletRequest) {
requestWrapper = new RequestWrapper((HttpServletRequest) servletRequest);
}
//獲取請求中的流，將取出來的字符串，再次轉換成流，然後把它放入到新 request對象中
// 在chain.doFiler方法中傳遞新的request對象
if(null == requestWrapper) {
filterChain.doFilter(servletRequest, servletResponse);
} else {
filterChain.doFilter(requestWrapper, servletResponse);
}
}
@Override
public void destroy() {
}
/***
* HttpServletRequest 包裝器
* 解決: request.getInputStream()只能讀取一次的問題
* 目標: 流可重複讀
*/
public class RequestWrapper extends HttpServletRequestWrapper {
/**
* 請求體
*/
private String mBody;
public RequestWrapper(HttpServletRequest request) {
super(request);
// 將body數據存儲起來
mBody = getBody(request);
}
/**
* 獲取請求體
* @param request 請求
* @return 請求體
*/
private String getBody(HttpServletRequest request) {
return HttpContextUtils.getBodyString(request);
}
/**
* 獲取請求體
* @return 請求體
*/
public String getBody() {
return mBody;
}
@Override
public BufferedReader getReader() throws IOException {
return new BufferedReader(new InputStreamReader(getInputStream()));
}
@Override
public ServletInputStream getInputStream() throws IOException {
// 創建字節數組輸入流
final ByteArrayInputStream bais = new ByteArrayInputStream(mBody.getBytes(StandardCharsets.UTF_8));
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();
}
};
}
}
}② 工具類，獲取請求的 body 體
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
/**
* HttpContextUtils
*
* @author liziye
*/
public class HttpContextUtils {
/**
* 獲取query參數
* @param request
* @return
*/
public static Map<String, String> getParameterMapAll(HttpServletRequest request) {
Enumeration<String> parameters = request.getParameterNames();
Map<String, String> params = new HashMap<>();
while (parameters.hasMoreElements()) {
String parameter = parameters.nextElement();
String value = request.getParameter(parameter);
params.put(parameter, value);
}
return params;
}
/**
* 獲取請求Body
*
* @param request
* @return
*/
public static String getBodyString(ServletRequest request) {
StringBuilder sb = new StringBuilder();
InputStream inputStream = null;
BufferedReader reader = null;
try {
inputStream = request.getInputStream();
reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.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();
}
}③ 攔截器中的具體使用
首先判斷本次 request 請求對象是不是 RequestWrapper 類的實例，如果是，則代表本次請求的接口是使用 @RequestBody 來接收的參數，那麼我們就需要用 getBodyString() 方法獲取參數；反之，則代表接口使用 @RequestParam 接收參數，我們直接用 request.getParameterMap() 來獲得全部參數即可。
小結
若您有更好、更獨到的理解，歡迎您在留言區留下您的寶貴想法。希望各位小夥伴動動自己可愛的小手，來一波點讚+關注。