攔截器中，request中getReader()和getInputStream()只能呼叫一次，構建可重複讀取inputStream的request.
阿新 • • 發佈：2019-02-12
由於 request中getReader()和getInputStream()只能呼叫一次
在專案中，可能會出現需要針對介面引數進行校驗等問題。
因此，針對這問題，給出一下解決方案
step 1:
新增RepeatedlyReadRequestWrapper 類並繼承 HttpServletRequestWrapper 包裝類
package com.config;
import org.apache.commons.lang3.StringUtils;
import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import step 2:
新增 RepeatedlyReadFilter 實現 filter 過濾器介面方法，當客戶端的請求先 過濾 進入SpringMvc Dispatch 路由前先包裝下
package com.filter;
import com.config.RepeatedlyReadRequestWrapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
/**
* 複製請求資料包body
* 以提供 攔截器下 可數次獲取Body資料包
* @author zhangmz
* @version 1.0.0
* @date 2017/09/21
*/
public class RepeatedlyReadFilter implements Filter {
private static final Logger logger = LoggerFactory.getLogger(RepeatedlyReadFilter.class);
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
logger.debug("複製request.getInputStream流");
ServletRequest requestWrapper = null;
if (request instanceof HttpServletRequest) {
requestWrapper = new RepeatedlyReadRequestWrapper((HttpServletRequest) request);
}
if (null == requestWrapper) {
chain.doFilter(request, response);
} else {
chain.doFilter(requestWrapper, response);
}
}
@Override
public void destroy() {
}
}step 3:
新增攔截器 RepeatedlyReadInterceptor 繼承 HandlerInterceptorAdapter 攔截介面卡
package com.interceptor;
import com.config.RepeatedlyReadRequestWrapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import javax.servlet.ServletInputStream;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.nio.charset.Charset;
/**
* @author zhangmz
* @version 1.0.0
* @date 2017/09/21
*/
public class RepeatedlyReadInterceptor extends HandlerInterceptorAdapter {
private static final Logger logger = LoggerFactory.getLogger(RepeatedlyReadInterceptor.class);
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
/**
* 對來自後臺的請求統一進行日誌處理
*/
RepeatedlyReadRequestWrapper requestWrapper;
if (request instanceof RepeatedlyReadRequestWrapper) {
// 簽名處理過程 start....
requestWrapper = (RepeatedlyReadRequestWrapper) request;
logger.info("請求Body: {} ", getBodyString(requestWrapper));
// 簽名處理過程 end....
}
// 預設記錄後臺介面請求日誌記錄
String url = request.getRequestURL().toString();
String method = request.getMethod();
String uri = request.getRequestURI();
String queryString = request.getQueryString();
logger.info(String.format("請求引數, url: %s, method: %s, uri: %s, params: %s ", url, method, uri, queryString));
return super.preHandle(request, response, handler);
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
RepeatedlyReadRequestWrapper requestWrapper;
if (request instanceof RepeatedlyReadRequestWrapper) {
// 測試再次獲取Body start....
requestWrapper = (RepeatedlyReadRequestWrapper) request;
logger.info("請求Body: {} ", getBodyString(requestWrapper));
// 測試再次獲取Body end....
}
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
}
/**
* 獲取請求Body
*
* @param request
*
* @return
*/
public static 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();
}
/**
* Description: 複製輸入流</br>
*
* @param inputStream
*
* @return</br>
*/
public static 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;
}
}
step 4:
配置過濾器與攔截器 WebMvcConfig
package com.config;
import com.filter.RepeatedlyReadFilter;
import com.interceptor.MyInterceptor;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.*;
/**
* SpringMVC 配置類
*
* @author zhangmz
* @create 2017/6/20
*/
@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new RepeatedlyReadInterceptor()).addPathPatterns("/**");
super.addInterceptors(registry);
}
@Bean
public FilterRegistrationBean repeatedlyReadFilter() {
FilterRegistrationBean registration = new FilterRegistrationBean();
RepeatedlyReadFilter repeatedlyReadFilter = new RepeatedlyReadFilter();
registration.setFilter(repeatedlyReadFilter);
registration.addUrlPatterns("/*");
return registration;
}
}step 5:
新增測試Controller類 TestController
package com.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* @author zhangmz
* @version 1.0.0
* @date 2017/09/21
*/
@Controller
@RequestMapping( "/test" )
public class TestController {
private static final Logger logger = LoggerFactory.getLogger(TestController.class);
@ResponseBody
@RequestMapping( value = "/str", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_UTF8_VALUE )
public String queryStr(@RequestBody String json) {
logger.info("json : {}", json);
return "ok";
}
}控制檯結果：
2017-09-21 15:48:30.582 DEBUG 35564 -- [nio-8080-exec-1] c.filter.RepeatedlyReadFilter : 複製request.getInputStream流
2017-09-21 15:48:30.591 INFO 35564 -- [nio-8080-exec-1] com.interceptor.RepeatedlyReadInterceptor : 請求Body: {"aa":"bb"}
2017-09-21 15:48:30.592 INFO 35564 -- [nio-8080-exec-1] com.interceptor.RepeatedlyReadInterceptor : 請求引數, url: http://localhost:8080/test/str, method: POST, uri: /test/str, params: null
2017-09-21 15:48:30.602 INFO 35564 -- [nio-8080-exec-1] com.controller.TestController : json : {"aa":"bb"}
2017-09-21 15:48:30.609 INFO 35564 -- [nio-8080-exec-1] com.interceptor.RepeatedlyReadInterceptor : 請求Body: {"aa":"bb"}