一、背景說明
由于在項目進行前后端分離改造時，請求由多種傳參方式統一定義為JSON格式傳輸，在改造過程中需要前后版本兼容。如果能在Controller接收參數之前將JSON格式參數進行解析成原有參數，對Request請求參數進行重寫，這樣能可以大大減少開發成本。
二、調研
抱著對Request請求參數目標出發，對@InitBinder和HttpServletRequestWrapper進行了研究，最終使用HttpServletRequestWrapper解決了當前問題。
1、@InitBinder
初次接觸時是用在對Date類型參數進行轉換，常用方法如下所示：
|
1
2
3
4
5
6
7
8
9
|
@InitBinderprotected void initBinder(WebDataBinder binder) { SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd"); dateFormat.setLenient(true); //根據時間類型進行轉換 binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, true)); //指定參數字段名稱進行轉換 binder.registerCustomEditor(Date.class, "registerDate",new CustomDateEditor(dateFormat, true));} |
注：如果Controller的方法沒有一個參數時，@initBinder標注的方法并不會執行(這個也比較好理解)
也可以通過自定義Editor對參數進行解析，詳見：http://www.ythuaji.com.cn/article/155117.html
但是通過@InitBinder并不能滿足我的要求，因為registerCustomEditor需要知道將要轉換成的參數類型，由于我得Controller參數類型因方法不同而不同。
2、HttpServletRequestWrapper
通過重寫HttpServletRequest或者繼承HttpServletRequestWrapper對HttpServletRequest進行裝飾，可以對請求請求參數進行修改。
重寫HttpServletRequest 工作量較大(其中方法較多)，繼承HttpServletRequestWrapper對HttpServletRequest進行裝飾實現起來比較簡單，僅需要對不滿足你的需求接口進行重寫就可以(首選)。
重寫HttpServletRequest，代碼如下所示：
|
1
2
3
4
5
6
7
8
9
|
public class MyHttpServletRequest implements HttpServletRequest { @Override public String getAuthType() @Override public Cookie[] getCookies() @Override public long getDateHeader(String s) //.......} |
自定義HttpServletRequest裝飾器HttpServletRequestWrapper和Filter過濾器，代碼如下所示：
|
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
package com.timer.web.interceptor; import com.alibaba.fastjson.JSONObject;import com.timer.common.utils.JsonUtil;import org.springframework.web.filter.OncePerRequestFilter;import javax.servlet.FilterChain;import javax.servlet.ServletException;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletRequestWrapper;import javax.servlet.http.HttpServletResponse;import java.io.IOException;import java.util.Enumeration;import java.util.Map;import java.util.Vector;import java.util.concurrent.ConcurrentHashMap; public class MyParametersFilter extends OncePerRequestFilter { @Override protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException { MyParametersWrapper myParametersWrapper = new MyParametersWrapper(httpServletRequest); filterChain.doFilter(myParametersWrapper, httpServletResponse); } /** * 繼承HttpServletRequestWrapper，創建裝飾類，以達到修改HttpServletRequest參數的目的 */ private class MyParametersWrapper extends HttpServletRequestWrapper { private static final String OTHER_PARAM = "other"; private Map<String, String[]> parameterMap; // 所有參數的Map集合 /** * other 參數所包含的參數信息 */ private Map<String, String[]> otherMap; public MyParametersWrapper(HttpServletRequest request) { super(request); parameterMap = request.getParameterMap(); otherMap = new ConcurrentHashMap<>(); /** * 判斷other參數是否為空 */ if(null != parameterMap.get(BODY_PARAM)){ otherConversion(parameterMap.get(BODY_PARAM)); } } /** * 將other參數轉為map參數 * @param others */ private void otherConversion(String[] others){ if(null != others && others.length > 0){ JSONObject obj = null; for(String other : others){ try { obj = JsonUtil.parseObject(other); if(null != obj){ for(Map.Entry<String, Object> entry : obj.entrySet()){ otherMap.put(entry.getKey(),new String []{String.valueOf(entry.getValue())}); } } }catch (Throwable e){ logger.error("otherConversion.is.system.error",e); } } } } // 重寫幾個HttpServletRequestWrapper中的方法 /** * 獲取所有參數名 * * @return 返回所有參數名 */ @Override public Enumeration<String> getParameterNames() { Vector<String> vector = new Vector<String>(parameterMap.keySet()); vector.addAll(otherMap.keySet()); return vector.elements(); } /** * 獲取指定參數名的值，如果有多個參數時默認取第一個 * * @param name 指定參數名 * @return 指定參數名的值 */ @Override public String getParameter(String name) { String[] values = parameterMap.get(name); try { if (values == null) { if (null != otherMap) { values = otherMap.get(name); } } }catch (Throwable e){ logger.error("getParameter.is.system.error",e); } if(null == values){ return null; } return values.length > 0 ? values[0] :super.getParameter(name); } /** * 獲取指定參數名的所有值的數組 */ @Override public String[] getParameterValues(String name) { String[] values = parameterMap.get(name); try{ if (values == null) { if(null != otherMap){ values = otherMap.get(name); } } }catch (Throwable e){ logger.error("getParameterValues.is.system.error",e); } return values != null ? values : super.getParameterValues(name); } }} |
疑問一：為什么要單獨定義一個otherMap用于存儲解析后的參數
因為request.getParameterMap() 獲取到的繼承了ParameterMap類，該類由于防止并發問題單獨定義了boolean locked屬性，如果貿然向其中進行新增值時會出現parameterMap.locked異常
疑問二：getParameterNames、getParameter、getParameterValues三個方法都在哪里會用到
1) getParameterNames方法：
getParameterNames會用在Controller的方法參數是自定義實體時使用到，例子如下所示：
|
1
2
3
4
5
|
@RequestMapping(value = "/index")@ResponseBodypublic String index(MyVo param) { //......} |
在進行HttpServletRequest參數轉為MyVo實體時會用到 getParameterNames方法，所以在以上代碼中需要將OtherMap的keys賦正常返回。
2) getParameter方法：
getParameter方法會在使用@RequestParam()注解和 request.getParameter("")時用到，間接調用getParameter方法。
3) getParameterValues方法：
getParameterValues方法會在使用request.getParameterValues("")時用到，間接調用getParameterValues方法。
其中JsonUtil如下所示：
|
1
2
3
4
5
6
7
8
9
10
11
|
import com.alibaba.fastjson.JSON;public class JsonUtil { public static JSONObject parseObject(String jsonText) { try { return JSON.parseObject(jsonText); } catch (Exception e) { logger.error("解析字符串:{} json出錯:{}", jsonText, e); } return null; }} |
使用過濾器：
|
1
2
3
4
5
6
7
8
|
<filter> <filter-name>myParametersFilter</filter-name> <filter-class>com.timer.web.interceptor.MyParametersFilter</filter-class></filter><filter-mapping> <filter-name>myParametersFilter</filter-name> <url-pattern>/*</url-pattern></filter-mapping> |
三、總結
HttpServletRequestWrapper 裝飾器可以在請求Controller方法前，對方法參數進行修改，可用于修改參數前綴、添加公參、參數格式重新排版等。
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持服務器之家。
原文鏈接：https://blog.csdn.net/TimerBin/article/details/83067915
