快捷導(dǎo)航

使用SpringMVC 重寫(xiě)、擴(kuò)展HttpServletRequest請(qǐng)求參數(shù)

更新時(shí)間：2021年08月12日 10:12:02 作者：TimerBin

這篇文章主要介紹了使用SpringMVC 重寫(xiě)、擴(kuò)展HttpServletRequest請(qǐng)求參數(shù)，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

一、背景說(shuō)明

由于在項(xiàng)目進(jìn)行前后端分離改造時(shí)，請(qǐng)求由多種傳參方式統(tǒng)一定義為JSON格式傳輸，在改造過(guò)程中需要前后版本兼容。如果能在Controller接收參數(shù)之前將JSON格式參數(shù)進(jìn)行解析成原有參數(shù)，對(duì)Request請(qǐng)求參數(shù)進(jìn)行重寫(xiě)，這樣能可以大大減少開(kāi)發(fā)成本。

二、調(diào)研

抱著對(duì)Request請(qǐng)求參數(shù)目標(biāo)出發(fā)，對(duì)@InitBinder和HttpServletRequestWrapper進(jìn)行了研究，最終使用HttpServletRequestWrapper解決了當(dāng)前問(wèn)題。

1、@InitBinder

初次接觸時(shí)是用在對(duì)Date類(lèi)型參數(shù)進(jìn)行轉(zhuǎn)換，常用方法如下所示：

@InitBinder
protected void initBinder(WebDataBinder binder) {
 SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
 dateFormat.setLenient(true);
    //根據(jù)時(shí)間類(lèi)型進(jìn)行轉(zhuǎn)換
 binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, true));
    //指定參數(shù)字段名稱(chēng)進(jìn)行轉(zhuǎn)換
 binder.registerCustomEditor(Date.class, "registerDate",new CustomDateEditor(dateFormat, true));
}

注：如果Controller的方法沒(méi)有一個(gè)參數(shù)時(shí)，@initBinder標(biāo)注的方法并不會(huì)執(zhí)行(這個(gè)也比較好理解)

也可以通過(guò)自定義Editor對(duì)參數(shù)進(jìn)行解析，詳見(jiàn)：http://chabaoo.cn/article/136446.htm

但是通過(guò)@InitBinder并不能滿(mǎn)足我的要求，因?yàn)閞egisterCustomEditor需要知道將要轉(zhuǎn)換成的參數(shù)類(lèi)型，由于我得Controller參數(shù)類(lèi)型因方法不同而不同。

2、HttpServletRequestWrapper

通過(guò)重寫(xiě)HttpServletRequest或者繼承HttpServletRequestWrapper對(duì)HttpServletRequest進(jìn)行裝飾，可以對(duì)請(qǐng)求請(qǐng)求參數(shù)進(jìn)行修改。

重寫(xiě)HttpServletRequest 工作量較大(其中方法較多)，繼承HttpServletRequestWrapper對(duì)HttpServletRequest進(jìn)行裝飾實(shí)現(xiàn)起來(lái)比較簡(jiǎn)單，僅需要對(duì)不滿(mǎn)足你的需求接口進(jìn)行重寫(xiě)就可以(首選)。

重寫(xiě)HttpServletRequest，代碼如下所示：

public class MyHttpServletRequest implements HttpServletRequest {
    @Override
    public String getAuthType()
 @Override
     public Cookie[] getCookies() 
 @Override
    public long getDateHeader(String s) 
    //.......
}

自定義HttpServletRequest裝飾器HttpServletRequestWrapper和Filter過(guò)濾器，代碼如下所示：

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)建裝飾類(lèi)，以達(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);
                    }
                }
            }
        }
 
        // 重寫(xiě)幾個(gè)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ù)名的值，如果有多個(gè)參數(shù)時(shí)默認(rèn)取第一個(gè)
         *
         * @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);
        }
    }
}

疑問(wèn)一：為什么要單獨(dú)定義一個(gè)otherMap用于存儲(chǔ)解析后的參數(shù)

因?yàn)閞equest.getParameterMap() 獲取到的繼承了ParameterMap類(lèi)，該類(lèi)由于防止并發(fā)問(wèn)題單獨(dú)定義了boolean locked屬性，如果貿(mào)然向其中進(jìn)行新增值時(shí)會(huì)出現(xiàn)parameterMap.locked異常

疑問(wèn)二：getParameterNames、getParameter、getParameterValues三個(gè)方法都在哪里會(huì)用到

1) getParameterNames方法：

getParameterNames會(huì)用在Controller的方法參數(shù)是自定義實(shí)體時(shí)使用到，例子如下所示：

@RequestMapping(value = "/index")
@ResponseBody
public String index(MyVo param) {
 //......
}

在進(jìn)行HttpServletRequest參數(shù)轉(zhuǎn)為MyVo實(shí)體時(shí)會(huì)用到 getParameterNames方法，所以在以上代碼中需要將OtherMap的keys賦正常返回。

2) getParameter方法：

getParameter方法會(huì)在使用@RequestParam()注解和 request.getParameter("")時(shí)用到，間接調(diào)用getParameter方法。

3) getParameterValues方法：

getParameterValues方法會(huì)在使用request.getParameterValues("")時(shí)用到，間接調(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出錯(cuò):{}", jsonText, e);
  }
  return null;
 }
}

使用過(guò)濾器：

<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>