HttpServletRequest.getInputStream()多次讀取問題

轉自：https://www.jianshu.com/p/85feeb30c1ed

HttpServletRequest.getInputStream()多次讀取問題

 

背景

使用POST方法發送數據時，我們習慣於把數據包裝成json格式。

 

 

image.png

有些情況下，我們會在Filter中讀取body數據進行數據校驗，
GET方法獲取參數比較簡單。對於POST方法，可使用如下方法從request中獲取body參數：

 private String getBody(HttpServletRequest request) throws IOException { InputStream in = request.getInputStream(); BufferedReader br = new BufferedReader(new InputStreamReader(in, Charset.forName("UTF-8"))); StringBuffer sb = new StringBuffer(""); String temp; while ((temp = br.readLine()) != null) { sb.append(temp); } if (in != null) { in.close(); } if (br != null) { br.close(); } return sb.toString(); } 

注意，這里有了一次request.getInputStream()調用。

但是在測試時，一直報JSON格式不正確的錯誤。經調查發現，項目中使用了公司基礎組件中的Filter，而該Filter中也解析了body。同時，不出所料，也是通過調用getInputStream()方法獲取的。

原來：

• 一個InputStream對象在被讀取完成后，將無法被再次讀取，始終返回-1；
• InputStream並沒有實現reset方法（可以重置首次讀取的位置），無法實現重置操作；

因此，當自己寫的Filter中調用了一次getInputStream()后，后面再調用getInputStream()讀取的數據都為空，所以才報JSON格式不正確的錯誤。

解決方法

1. 緩存數據
2. 使用HttpServletRequestWrapper進行包裝

緩存數據
所謂緩存數據，其實就是調用ServletRequest的setAttribute(String s, Object o)來存儲數據。

1. 獲取到body后，直接緩存

String body = getBody(request); request.setAttribute("body", body); 

優點：
方便
缺點：
不能控制第三方Filter

2. 其他地方需要使用body時，只需調用getAttribute方法就能獲取數據了：

request.getAttribute("body"); 

HttpServletRequestWrapper包裝

public class RequestWrapper extends HttpServletRequestWrapper { private final byte[] body; public RequestWrapper(HttpServletRequest request) throws IOException { super(request); body = getBodyStringFromReq(request).getBytes(Charset.forName("UTF-8")); } public String getBodyString() { try { return new String(body, "UTF-8"); } catch (UnsupportedEncodingException ex) { return new String(body); } } private String getBodyStringFromReq(ServletRequest request) { StringBuilder sb = new StringBuilder(); InputStream inputStream = null; BufferedReader reader = null; try { inputStream = 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(); } } 

在Filter中使用時，FilterChain.doFilter()傳入Wrapper對象：

public class TestFilter implements Filter { @Override public void destroy() { } @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { RequestWrapper requestWrapper = new RequestWrapper((HttpServletRequest)request); String body = requestWrapper.getBodyString(); chain.doFilter(requestWrapper, response); //傳入Wrapper對象 } @Override public void init(FilterConfig arg0) throws ServletException { } } 

這樣，位於后面的Filter就可以擁有唯一一次調用HttpServletRequest.getInputStream()的機會了。

優點：
不影響第三方Filter

缺點：
多寫了這么多代碼，麻煩了一些

參考