JSON 數(shù)據(jù)讀一次就沒了,怎么辦?
對于前端傳來的 JSON 數(shù)據(jù),我們在服務(wù)端基本上都是通過 IO 流來解析,如果是古老的 Servlet,那么我們直接解析 IO 流;如果是在 SpringMVC 中,我們往往通過 @RequestBody 注解來解析。
如果通過 IO 流來解析參數(shù),默認情況下,IO 流讀一次就結(jié)束了,就沒有了。而往往有些場景,需要我們多次讀取參數(shù),我舉一個例子:
接口冪等性的處理,同一個接口,在短時間內(nèi)接收到相同參數(shù)的請求,接口可能會拒絕處理。那么在判斷的時候,就需要先把請求的參數(shù)提取出來進行判斷,如果是 JSON 參數(shù),此時就會有問題,參數(shù)提前取出來了,將來在接口中再去獲取 JSON 參數(shù),就會發(fā)現(xiàn)沒有了。
我們來看看這個問題怎么解決,這也是最近松哥在做的 TienChin 項目的一個小知識點,和大家分享下。
新建一個 Spring Boot 項目,引入 Web 依賴,我們一起來看下面的問題。
1. 問題演示
假設(shè)我現(xiàn)在有一個處理接口冪等性的攔截器,在這個攔截器中,我需要先獲取到請求的參數(shù),然后進行比對等等,我這里先簡單模擬一下,比如我們項目中有如下攔截器:
public class IdempotenceInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String s = request.getReader().readLine();
System.out.println("s = " + s);
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
}
}
在這個攔截器中先把請求的參數(shù)拎出來,瞅一眼。通過 IO 流讀取出來的參數(shù)最大特點是一次性,也就是讀一次就失效了。
然后我們配置一下這個攔截器:
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new IdempotenceInterceptor()).addPathPatterns("/**");
}
}
最后再來看看 Controller 接口:
@RestController
public class HelloController {
@PostMapping("/hello")
public void hello(@RequestBody String msg) throws IOException {
System.out.println("msg = " + msg);
}
}
在接口參數(shù)上我們加了 @RequestBody 注解,這個底層也是通過 IO 流來讀取數(shù)據(jù)的,但是由于 IO 流在攔截器中已經(jīng)被讀取過一次了,所以到了接口中再去讀取就會出錯。報錯信息如下:
然而很多時候,我們希望 IO 流能夠被多次讀取,那么怎么辦呢?
2. 問題解決
這里我們可以利用裝飾者模式對 HttpServletRequest 的功能進行增強,具體做法也很簡單,我們重新定義一個 HttpServletRequest:
public class RepeatedlyRequestWrapper extends HttpServletRequestWrapper {
private final byte[] body;
public RepeatedlyRequestWrapper(HttpServletRequest request, ServletResponse response) throws IOException {
super(request);
request.setCharacterEncoding("UTF-8");
response.setCharacterEncoding("UTF-8");
body = request.getReader().readLine().getBytes("UTF-8");
}
@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 int available() throws IOException {
return body.length;
}
@Override
public boolean isFinished() {
return false;
}
@Override
public boolean isReady() {
return false;
}
@Override
public void setReadListener(ReadListener readListener) {
}
};
}
}
這段代碼并不難,很好懂。
首先在構(gòu)造 RepeatedlyRequestWrapper 的時候,就通過 IO 流將數(shù)據(jù)讀取出來并存入到一個 byte 數(shù)組中,然后重寫 getReader 和 getInputStream 方法,在這兩個讀取 IO 流的方法中,都從 byte 數(shù)組中返回 IO 流數(shù)據(jù)出來,這樣就實現(xiàn)了反復(fù)讀取了。
接下來我們定義一個過濾器,讓這個裝飾后的 Request 生效:
public class RepeatableFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
ServletRequest requestWrapper = null;
if (request instanceof HttpServletRequest
&& StringUtils.startsWithIgnoreCase(request.getContentType(), MediaType.APPLICATION_JSON_VALUE)) {
requestWrapper = new RepeatedlyRequestWrapper((HttpServletRequest) request, response);
}
if (null == requestWrapper) {
chain.doFilter(request, response);
} else {
chain.doFilter(requestWrapper, response);
}
}
@Override
public void destroy() {
}
}
判斷一下,如果請求數(shù)據(jù)類型是 JSON 的話,就把 HttpServletRequest “偷梁換柱”改為 RepeatedlyRequestWrapper,然后讓過濾器繼續(xù)往下走。
最后再配置一下這個過濾器:
@Bean
FilterRegistrationBean<RepeatableFilter> repeatableFilterBean() {
FilterRegistrationBean<RepeatableFilter> bean = new FilterRegistrationBean<>();
bean.addUrlPatterns("/*");
bean.setFilter(new RepeatableFilter());
return bean;
}
好啦大功告成。
以后,我們的 JSON 數(shù)據(jù)就可以通過 IO 流反復(fù)讀取了。