使用SpringMVC 重寫、擴展HttpServletRequest請求參數
一、背景說明
由于在項目進行前后端分離改造時，請求由多種傳參方式統(tǒng)一定義為JSON格式傳輸，在改造過程中需要前后版本兼容。如果能在Controller接收參數之前將JSON格式參數進行解析成原有參數，對Request請求參數進行重寫，這樣能可以大大減少開發(fā)成本。
二、調研
抱著對Request請求參數目標出發(fā)，對@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",new CustomDateEditor(dateFormat, true));
}
注：如果Controller的方法沒有一個參數時，@initBinder標注的方法并不會執(zhí)行(這個也比較好理解)
也可以通過自定義Editor對參數進行解析，詳見：http://www.fzitv.net/article/136446.htm
但是通過@InitBinder并不能滿足我的要求，因為registerCustomEditor需要知道將要轉換成的參數類型，由于我得Controller參數類型因方法不同而不同。
2、HttpServletRequestWrapper
通過重寫HttpServletRequest或者繼承HttpServletRequestWrapper對HttpServletRequest進行裝飾，可以對請求請求參數進行修改。
重寫HttpServletRequest 工作量較大(其中方法較多)，繼承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 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)建裝飾類，以達到修改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類，該類由于防止并發(fā)問題單獨定義了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;
}
}
使用過濾器：
<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方法前，對方法參數進行修改，可用于修改參數前綴、添加公參、參數格式重新排版等。
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
spring cloud 的監(jiān)控turbine-rabbitmq的示例
這篇文章主要介紹了spring cloud 的監(jiān)控turbine-rabbitmq的示例,小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-05-05
頁碼可以清楚了解總頁數、定位頁數快速尋找自己所要的文段、打印時不會分不清頭中尾。今天這篇文章就將介紹如何通過Java代碼，以編程的方式將添加頁碼到PDF文檔，需要的可以參考一下2023-04-04
詳解Spring Cloud Consul 實現服務注冊和發(fā)現
這篇文章主要介紹了Spring Cloud Consul 實現服務注冊和發(fā)現，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-03-03
本篇文章主要介紹了springboot + mybatis配置多數據源示例，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-03-03
Spring Boot 啟動、停止、重啟、狀態(tài)腳本
今天給大家分享Spring Boot 項目腳本（啟動、停止、重啟、狀態(tài)），通過示例代碼給大家介紹的非常詳細，需要的朋友參考下吧2021-06-06
這篇文章主要介紹了springboot整合sentinel的方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-11-11
這篇文章主要介紹了java中有關構造方法中的輸出，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-10-10
MyBatis-Flex+ShardingSphere-JDBC多數據源分庫分表實現
本文介紹了使用MyBatis-Flex和ShardingSphere-JDBC實現多數據源分庫分表的方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2024-10-10
這篇文章主要介紹了使用JPA雙向多對多關聯關系@ManyToMany，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-06-06
本文主要介紹java高并發(fā)線程的基本操作，這里整理詳細的資料來解釋線程的知識，有需要的學習高并發(fā)的朋友可以參考下2021-10-10