Spring boot中使用servlet filter

Spring boot中使用servlet filter

liuyuhang原創，未經允許請勿轉載！

 

在web項目中經常需要一些場景，如參數過濾防止sql注入，防止頁面攻擊，空參數矯正等，

也可以做成token驗證，session驗證，點擊率統計等。

為了這種業務，經常會需要寫過濾器（Filter）。

servlet提供的默認過濾器比較好用，配置也還算方便；

轉入springboot開發后，注解也並不復雜，原理依舊。

 

使用filter的步驟並不復雜，主要分為幾個步驟：

　　1、新建class 實現Filter抽象類（javax.servlet.Filter）

　　2、override三個方法（init，doFilter，destroy）

　　3、編寫ParameterRequestWrapper類繼承HttpServletRequestWrapper類（稍后說明原因）

　　4、ParameterRequestWrapper類構造器

　　5、構造器中復寫父類構造器並將request.getParameterMap加入子類成員變量

　　6、編寫addParam方法留用

　　7、修改參數並調用ParameterRequestWrapper實例保存params

　　8、調用doFilter方法中的FilterChain變量，將修改后的request重新封裝

　　9、在springboot入口方法中添加注解@ServletComponentScan注冊filter

其中1、2步驟為必須的，其余的步驟為修改request參數使用的封裝方式。

 

1、新建class實現Filter抽象類（javax.servlet.Filter）；

2、override三個方法（init，doFilter，destroy）；代碼如下：

package lyh.java.filterAndInteceptor;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;

import org.springframework.core.annotation.Order;

@Order(1)//多個filter的時候,該序號越小,越早執行
@WebFilter(filterName = "FirstFilter", urlPatterns = "/*")//url過濾配置,並非包配置
public class MyMvcFilter implements Filter{

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        //這里寫init邏輯,該init將在服務器啟動時調用
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        //request處理邏輯
        //request在封裝邏輯
        //chain重新寫回request和response
    }

    @Override
    public void destroy() {
        //這里寫destroy邏輯,該destroy邏輯將在服務器關閉時調用
    }
}

 

9、在springboot入口方法中添加注解@ServletComponentScan注冊filter，代碼如下：

package lyh.java;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.boot.web.servlet.ServletComponentScan;

import lyh.java.config.DataSourceConfig;

@SpringBootConfiguration//springboot基礎配置注解
@ServletComponentScan//springboot servlet filter
public class Run {

    public static void main(String[] args) throws Exception {
        SpringApplication.run(Run.class, args);
    }
}

 

到這里，就完成了Filter的簡單創建了，可以自行測試使用

 

創建Filter，一般目的是為了過濾一些參數，如果是為了中斷該訪問，應該是創建Interceptor

對於java中的mvc，過濾或者修改參數，針對的主要是request中的parameterMap的修改。

當然還有很多好用的操作，這里不做討論了。

 

修改request實例，思路上有兩個步驟是必須要考慮的：

①如何獲取request中的parameterMap並且修改？

②如何將修改后的parameterMap重新傳遞回去，使得controller能夠不受影響？

 

對於如何解決以上兩個問題，思路上也要經過兩個步驟：

①常用的是request.getParameter或request.getParamerterMap方法，但是ServletRequest是一個接口；

該接口定義了getParameterMap抽象方法，只要找到該接口的實現類，繼承該類，利用java繼承原理，

相互繼承的類，調用父類方法的時候，若子類復寫了該方法，則默認調用子類方法。

以此來實現request的重新封裝。

②在子類中定義add方法，來添加新的param，同時該param與request中原有的param進行校對，去重，

保證子類的覆蓋父類的，這樣獲取param的時候，不會有所察覺。

 

在一番查找之后，發現了一個類，來專門處理request對象的，截圖如下

注意類注解：Methods default to calling through to the wrapped request object.意為request默認調用該封裝對象

注意截圖中的構造器，該構造器傳入servletRequest對象，因此該帶參構造器肯定要被子類重寫

 

於是，編寫一個類，繼承該類，同時修改構造器，復寫getParameter方法，提供一個map作為request內容的緩存；

使得復寫的getParameter能夠從此緩存中獲取param即可，代碼如下，注釋完善，不再贅述：

package lyh.java.tools;

import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;

/**
 * 重寫ParameterRequestWrapper繼承HttpServletRequestWrapper並重寫部分方法
 * 構造器調用父類構造器
 * 重寫param作為緩存
 * 重寫getParameter獲取子類緩存
 * 增加兩個add方法修改該緩存
 * @author Liuyuhang
 *
 */
public class ParameterRequestWrapper extends HttpServletRequestWrapper {
    
    /**
     * 初始化params,作為getParameter方法獲取的參數列表,內首先包含req中的paramMap,再修改
     */
    private Map<String , String[]> params = new HashMap<String, String[]>();
     
    /**
     * 重載構造器,並調用父類構造器,將參數寫入子類params
     * @param request
     */
    public ParameterRequestWrapper(HttpServletRequest request) {
        super(request);// 將request交給父類，以便於調用對應方法的時候，將其輸出，其實父親類的實現方式和第一種new的方式類似
        this.params.putAll(request.getParameterMap());//將參數表，賦予給當前的Map以便於持有request中的參數
    }

    /**
     * 重寫getParameter，代表參數從當前類中的map獲取
     */
    @Override
    public String getParameter(String name) {
        String[]values = params.get(name);
        if(values == null || values.length == 0) {
            return null;
        }
        return values[0];
    }
    
    /**
     * 獲取子類param緩存的方法
     */
    public Map<String,String[]> getParamsMap(){
        return this.params;
    }
    /**
     * 寫入一個map的方法
     * @param map
     */
    public void addParamsMap(Map<String , Object> map) {
        for(Map.Entry<String , Object>entry : map.entrySet()) {
            addParam(entry.getKey() , entry.getValue());
        }
    }
    /**
     * 寫入一個參數的方法
     * @param name
     * @param obj
     */
    public void addParam(String name , Object obj) {
        if(obj != null) {
            if(obj instanceof String[]) {
                params.put(name , (String[])obj);
            }else if(obj instanceof String) {
                params.put(name , new String[] {(String)obj});
            }else {
                params.put(name , new String[] {String.valueOf(obj)});
            }
        }
    }

}

 

 返回Filter類中的doFilter方法，對該方法進行加工。思路是：

①封裝ServletRequest實例為子類抽象HttpServletRequest對象實例，調用剛剛寫的方法的構造器

將ParameterRequestWrapper實例化得實例對象rpw；

②獲取該prw的param，一一過濾，如字符串trim，修改null或者空字符串，修改時間日期格式，

獲取token來進行身份驗證之類。

③調用doFilter中的FilterChain參數，將重新寫過的request和response寫回。

 

具體代碼如下：

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws IOException, ServletException {
        //將request封裝為子類
        HttpServletRequest httpReq = (HttpServletRequest) req;
        //調用復寫的構造器重新封裝request
        ParameterRequestWrapper prw = new ParameterRequestWrapper(httpReq);
        //這里寫requtst過濾內容的邏輯,如字符串trim，修改null或者空字符串，修改時間日期格式，獲取token來進行身份驗證之類。
        prw.addParam("user", "Filter-user");
        //調用chain執行filter並寫回參數
        chain.doFilter(prw, resp);
    }

 

寫個類測試下。代碼如下：

package lyh.java.controller;

import javax.servlet.http.HttpServletRequest;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController//restFull Controller注解,返回json格式
public class hello {
    
    @RequestMapping("/hello")
    public String helloTest(HttpServletRequest req) throws Exception {
        String user = req.getParameter("user");
        System.out.println("user:"+user);
        return "hello world!  "+user;
    }
    
    
}

運行結果如下：

完工！

以上！✧(∗≧ꇴ≦)人(≧ꈊ≦∗)✧