1.1、獲取http請求參數是一種剛需
我想有的小伙伴肯定有過獲取http請求的需要，比如想
- 前置獲取參數，統計請求數據
- 做服務的接口簽名校驗
- 敏感接口監控日志
- 敏感接口防重復提交
等等各式各樣的場景，這時你就需要獲取 HTTP 請求的參數或者請求body，一般思路有兩種，一種就是自定義個AOP去攔截目標方法，第二種就是使用攔截器。整體比較來說，使用攔截器更靈活些，因為每個接口的請求參數定義不同，使用AOP很難細粒度的獲取到變量參數，本文主線是采用攔截器來獲取HTTP請求。
1.2、定義攔截器獲取請求
基于 spring-boot-starter-parent 2.1.9.RELEASE
看起來這個很簡單，這里就直接上code，定義個攔截器
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
/** * @author axin * @summary HTTP請求攔截器 */@Slf4jpublic class RequestInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { //獲取請求參數 String queryString = request.getQueryString(); log.info("請求參數:{}", queryString); //獲取請求body byte[] bodyBytes = StreamUtils.copyToByteArray(request.getInputStream()); String body = new String(bodyBytes, request.getCharacterEncoding()); log.info("請求體：{}", body); return true; }} |
然后把這個攔截器配置一下中：
|
1
2
3
4
5
6
7
8
9
10
11
|
/** * WebMVC配置，你可以集中在這里配置攔截器、過濾器、靜態資源緩存等 */@Configurationpublic class WebMvcConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new RequestInterceptor()).addPathPatterns("/**"); }} |
定義個接口測試一下
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
/** * @author axin * @summary 提交測試接口 */@Slf4j@RestControllerpublic class MyHTTPController { @GetMapping("/v1/get") public void get(@RequestParam("one") String one, @RequestParam("two") BigDecimal number) { log.info("參數:{},{}", one, number); } @PostMapping("/v1/post") public void check(@RequestBody User user) { log.info("{}", JSON.toJSONString(user)); }} |
GET請求獲取請求參數示例：
POST請求獲取請求Body示例：
我們發現攔截器在獲取HTTP請求的body時出現了 400 （Required request body is missing: public void com.axin.world.controller.MyHTTPController.check(com.axin.world.domain.User)）；同時也發現攔截器竟然走了兩遍，這又是咋回事呢？
1.3、為什么攔截器會重復調兩遍呢？
其實是因為 tomcat截取到異常后就轉發到/error頁面，就在這個轉發的過程中導致了springmvc重新開始DispatcherServlet的整個流程，所以攔截器執行了兩次，我們可以看下第二次調用時的url路徑：
1.4、ServletInputStream(CoyoteInputStream) 輸入流無法重復調用
而之前出現的 Required request body is missing 錯誤 其實是ServletInputStream被讀取后無法第二次再讀取了，所以我們要把讀取過的內容存下來，然后需要的時候對外提供可被重復讀取的ByteArrayInputStream。
對于MVC的過濾器來說，我們就需要重寫 ServletInputStream 的 getInputStream()方法。
1.5、自定義 HttpServletRequestWrapper
為了 重寫 ServletInputStream 的 getInputStream()方法，我們需要自定義一個 HttpServletRequestWrapper ：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
/*** @author Axin* @summary 自定義 HttpServletRequestWrapper 來包裝輸入流*/public class AxinHttpServletRequestWrapper extends HttpServletRequestWrapper { /** * 緩存下來的HTTP body */ private byte[] body; public AxinHttpServletRequestWrapper(HttpServletRequest request) throws IOException { super(request); body = StreamUtils.copyToByteArray(request.getInputStream()); } /** * 重新包裝輸入流 * @return * @throws IOException */ @Override public ServletInputStream getInputStream() throws IOException { InputStream bodyStream = new ByteArrayInputStream(body); return new ServletInputStream() { @Override public int read() throws IOException { return bodyStream.read(); } /** * 下面的方法一般情況下不會被使用，如果你引入了一些需要使用ServletInputStream的外部組件，可以重點關注一下。 * @return */ @Override public boolean isFinished() { return false; } @Override public boolean isReady() { return true; } @Override public void setReadListener(ReadListener readListener) { } }; } @Override public BufferedReader getReader() throws IOException { InputStream bodyStream = new ByteArrayInputStream(body); return new BufferedReader(new InputStreamReader(getInputStream())); }} |
然后定義一個 DispatcherServlet子類來分派 上面自定義的 AxinHttpServletRequestWrapper ：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
/*** @author Axin* @summary 自定義 DispatcherServlet 來分派 AxinHttpServletRequestWrapper*/public class AxinDispatcherServlet extends DispatcherServlet { /** * 包裝成我們自定義的request * @param request * @param response * @throws Exception */ @Override protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception { super.doDispatch(new AxinHttpServletRequestWrapper(request), response); }} |
然后配置一下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
/** * WebMVC配置，你可以集中在這里配置攔截器、過濾器、靜態資源緩存等 */@Configurationpublic class WebMvcConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new RequestInterceptor()).addPathPatterns("/**"); } @Bean @Qualifier(DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_BEAN_NAME) public DispatcherServlet dispatcherServlet() { return new AxinDispatcherServlet(); }} |
再調用一下 POST請求：
請求成功！
1.5、總結一下 展望一下
如果你想對HTTP請求做些騷操作，那么前置獲取HTTP請求參數是前提，為此文本給出了使用MVC攔截器獲取參數的樣例。
在獲取HTTP Body 的時候，出現了 Required request body is missing 的錯誤，同時攔截器還出現執行了兩遍的問題，這是因為 ServletInputStream被讀取了兩遍導致的，tomcat截取到異常后就轉發到 /error 頁面 被攔截器攔截到了，攔截器也就執行了兩遍。
為此我們通過自定義 HttpServletRequestWrapper 來包裝一個可被重讀讀取的輸入流，來達到期望的攔截效果。
在獲取到HTTP的請求參數后，我們可以前置做很多操作，比如常用的服務端接口簽名驗證，敏感接口防重復請求等等。
個人水平有限，如果文章有邏輯錯誤或表述問題還請指出，歡迎一起交流。
到此這篇關于SpringBoot攔截器如何獲取http請求參數的文章就介紹到這了,更多相關SpringBoot攔截器獲取http請求參數內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家！
原文鏈接：https://www.cnblogs.com/keeya/p/13634015.html
