使用SpringMVC 重寫、擴展HttpServletRequest請求參數(shù)
一、背景說明
由于在項目進(jìn)行前后端分離改造時，請求由多種傳參方式統(tǒng)一定義為JSON格式傳輸，在改造過程中需要前后版本兼容。如果能在Controller接收參數(shù)之前將JSON格式參數(shù)進(jìn)行解析成原有參數(shù)，對Request請求參數(shù)進(jìn)行重寫，這樣能可以大大減少開發(fā)成本。
二、調(diào)研
抱著對Request請求參數(shù)目標(biāo)出發(fā)，對@InitBinder和HttpServletRequestWrapper進(jìn)行了研究，最終使用HttpServletRequestWrapper解決了當(dāng)前問題。
1、@InitBinder
初次接觸時是用在對Date類型參數(shù)進(jìn)行轉(zhuǎn)換，常用方法如下所示：
@InitBinder
protected void initBinder(WebDataBinder binder) {
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
dateFormat.setLenient(true);
//根據(jù)時間類型進(jìn)行轉(zhuǎn)換
binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, true));
//指定參數(shù)字段名稱進(jìn)行轉(zhuǎn)換
binder.registerCustomEditor(Date.class, "registerDate",new CustomDateEditor(dateFormat, true));
}
注：如果Controller的方法沒有一個參數(shù)時，@initBinder標(biāo)注的方法并不會執(zhí)行(這個也比較好理解)
也可以通過自定義Editor對參數(shù)進(jìn)行解析，詳見：http://www.dbjr.com.cn/article/136446.htm
但是通過@InitBinder并不能滿足我的要求，因為registerCustomEditor需要知道將要轉(zhuǎn)換成的參數(shù)類型，由于我得Controller參數(shù)類型因方法不同而不同。
2、HttpServletRequestWrapper
通過重寫HttpServletRequest或者繼承HttpServletRequestWrapper對HttpServletRequest進(jìn)行裝飾，可以對請求請求參數(shù)進(jìn)行修改。
重寫HttpServletRequest 工作量較大(其中方法較多)，繼承HttpServletRequestWrapper對HttpServletRequest進(jìn)行裝飾實現(xiàn)起來比較簡單，僅需要對不滿足你的需求接口進(jìn)行重寫就可以(首選)。
重寫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 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，創(chuàng)建裝飾類，以達(dá)到修改HttpServletRequest參數(shù)的目的
*/
private class MyParametersWrapper extends HttpServletRequestWrapper {
private static final String OTHER_PARAM = "other";
private Map<String, String[]> parameterMap; // 所有參數(shù)的Map集合
/**
* other 參數(shù)所包含的參數(shù)信息
*/
private Map<String, String[]> otherMap;
public MyParametersWrapper(HttpServletRequest request) {
super(request);
parameterMap = request.getParameterMap();
otherMap = new ConcurrentHashMap<>();
/**
* 判斷other參數(shù)是否為空
*/
if(null != parameterMap.get(BODY_PARAM)){
otherConversion(parameterMap.get(BODY_PARAM));
}
}
/**
* 將other參數(shù)轉(zhuǎn)為map參數(shù)
* @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中的方法
/**
* 獲取所有參數(shù)名
*
* @return 返回所有參數(shù)名
*/
@Override
public Enumeration<String> getParameterNames() {
Vector<String> vector = new Vector<String>(parameterMap.keySet());
vector.addAll(otherMap.keySet());
return vector.elements();
}
/**
* 獲取指定參數(shù)名的值，如果有多個參數(shù)時默認(rèn)取第一個
*
* @param name 指定參數(shù)名
* @return 指定參數(shù)名的值
*/
@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);
}
/**
* 獲取指定參數(shù)名的所有值的數(shù)組
*/
@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用于存儲解析后的參數(shù)
因為request.getParameterMap() 獲取到的繼承了ParameterMap類，該類由于防止并發(fā)問題單獨定義了boolean locked屬性，如果貿(mào)然向其中進(jìn)行新增值時會出現(xiàn)parameterMap.locked異常
疑問二：getParameterNames、getParameter、getParameterValues三個方法都在哪里會用到
1) getParameterNames方法：
getParameterNames會用在Controller的方法參數(shù)是自定義實體時使用到，例子如下所示：
@RequestMapping(value = "/index")
@ResponseBody
public String index(MyVo param) {
//......
}
在進(jìn)行HttpServletRequest參數(shù)轉(zhuǎn)為MyVo實體時會用到 getParameterNames方法，所以在以上代碼中需要將OtherMap的keys賦正常返回。
2) getParameter方法：
getParameter方法會在使用@RequestParam()注解和 request.getParameter("")時用到，間接調(diào)用getParameter方法。
3) getParameterValues方法：
getParameterValues方法會在使用request.getParameterValues("")時用到，間接調(diào)用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;
}
}
使用過濾器：
<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>
三、總結(jié)
HttpServletRequestWrapper 裝飾器可以在請求Controller方法前，對方法參數(shù)進(jìn)行修改，可用于修改參數(shù)前綴、添加公參、參數(shù)格式重新排版等。
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
MybatisPlus結(jié)合groupby實現(xiàn)分組和sum求和的步驟
這篇文章主要介紹了MybatisPlus結(jié)合groupby實現(xiàn)分組和sum求和的步驟,這次使用的是LambdaQueryWrapper,使用QueryWrapper相對來說簡單點就不寫了,本文分步驟給大家介紹的非常詳細(xì),感興趣的朋友一起看看吧2023-12-12
java 如何往已經(jīng)存在的excel表格里面追加數(shù)據(jù)的方法
這篇文章主要介紹了java 如何往已經(jīng)存在的excel表格里面追加數(shù)據(jù)的方法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-08-08
這篇文章主要為大家介紹了Java根據(jù)ip地址獲取歸屬地實例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-08-08
springsecurity中http.permitall與web.ignoring的區(qū)別說明
這篇文章主要介紹了springsecurity中http.permitall與web.ignoring的區(qū)別說明，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-08-08
Java數(shù)據(jù)結(jié)構(gòu)之線段樹詳解
線段樹是一種二叉搜索樹，與區(qū)間樹相似，它將一個區(qū)間劃分成一些單元區(qū)間，每個單元區(qū)間對應(yīng)線段樹中的一個葉結(jié)點。本文將介紹線段樹的Java實現(xiàn)代碼，需要的可以參考一下2022-01-01
微信公眾號分為訂閱號和服務(wù)號,無論有沒有認(rèn)證,訂閱號每天都能推送一條消息,也就是每天只能推送一次消息給粉絲,這篇文章主要給大家介紹了關(guān)于Java微信公眾號消息推送實現(xiàn)的相關(guān)資料,需要的朋友可以參考下2022-09-09
這篇文章主要介紹了Java中的split使用方法詳解,Java 中 String 的 split 方法可以將字符串根據(jù)指定的間隔進(jìn)行切割,經(jīng)過切割后得到的返回值是一個字符串?dāng)?shù)組,需要的朋友可以參考下2023-10-10
Java實現(xiàn)八個常用的排序算法：插入排序、冒泡排序、選擇排序、希爾排序等
這篇文章主要介紹了Java如何實現(xiàn)八個常用的排序算法：插入排序、冒泡排序、選擇排序、希爾排序 、快速排序、歸并排序、堆排序和LST基數(shù)排序,需要的朋友可以參考下2015-07-07
Spring學(xué)習(xí)筆記1之IOC詳解盡量使用注解以及java代碼
這篇文章主要介紹了Spring學(xué)習(xí)筆記1之IOC詳解盡量使用注解以及java代碼 的相關(guān)資料,需要的朋友可以參考下2016-07-07
Java應(yīng)用多機器部署解決大量定時任務(wù)問題
這篇文章主要介紹了Java應(yīng)用多機器部署解決大量定時任務(wù)問題,兩臺服務(wù)器同時部署了同一套代碼， 代碼中寫有spring自帶的定時任務(wù)，但是每次執(zhí)行定時任務(wù)時只需要一臺機器去執(zhí)行,需要的朋友可以參考下2019-07-07