使用SpringMVC 重寫、擴充套件HttpServletRequest請求引數
一、背景說明
由於在專案進行前後端分離改造時，請求由多種傳參方式統一定義為ON格式傳輸，在改造過程中需要前後版本相容。如果能在Controller接收引數之前將JSON格式引數進行解析成原有引數，對Request請求引數進行重寫，這樣能可以大大減少開發成本。
二、調研
抱著對Request請求引數目標出發，對@InitBinder和HttpServletRequestWrapper進行了研究，最終使用HttpServletRequestWrapper解決了當前問題。
1、@InitBinder
初次接觸時是用在對Date型別引數進行轉換，常用方法如下所示：
@InitBinder
protected 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",true));
}注：如果Controller的方法沒有一個引數時，@initBinder標註的方法並不會執行(這個也比較好理解)
也可以通過自定義Editor對引數進行解析，詳見：https://www.jb51.net/article/136446.htm
但是通過@InitBinder並不能滿足我的要求，因為registerCustomEditor需要知道將要轉換成的引數型別，由於我得Controller引數型別因方法不同而不同。
2、HttpServletRequestWrapper
通過重寫HttpServletRequest或者繼承HttpServletRequestWrapper對HttpServletRequest進行裝飾，可以對請求請求引數進行修改。
重寫HttpServletReqwww.cppcns.comuest 工作量較大(其中方法較多)，繼承HttpServletRequestWrapper對HttpServletRequest進行裝飾實現起來比較簡單，僅需要對不滿足你的需求介面進行重寫就可以(首選)。
重寫HttpServletRequest，程式碼如下所示：
public class MyHttpServletRequest implements HttpServletRequest {
@Override
public String getAuthType()
@Override
public Cookie[] getCookies()
@Override
public long getDateHeader(String s)
//.......
}自定義HttpServletRequest裝飾器HttpServletRequestWrapper和Filter過濾器，程式碼如下所示：
package com.timer.web.interceptor;
import com.alibaba.fastjson.JSONObject;
import com.timer.common.utils.JsonUtil;
import org.springframework.web.filter.OncePerRequestFilter;
import x.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[]> otherhttp://www.cppcns.comMap;
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();
}
/**
* 獲取指定引數名的值，如果有多個引數時預設www.cppcns.com取第一個
*
* @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的方法引數是自定義實體時使用到，例子如下所示：
@RequestMapping(value = "/index")
@ResponseBody
public String index(MyVo param) {
//......
}
在進行HttpServletRequest引數轉為MyVo實體時會用到 getParameterNames方法，所以在以上程式碼中需要將OtherMap的keys賦正常返回。
2) getParameter方法：
getParameter方法會在使用@RequestParam()註解和 request.getParameter("")時用到，間接呼叫getParameter方法。
3) getParameterValues方法：
getParameterValues方法會在使用request.getParameterValues("")時用到，間接呼叫getParameterValues方法。
其中JsonUtil如下所示：
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;
}
}
使用過濾器：
<filwww.cppcns.comter> <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方法前，對方法引數進行修改，可用於修改引數字首、新增公參、引數格式重新排版等。
以上為個人經驗，希望能給大家一個參考，也希望大家多多支援我們。