SpringBoot 中使用 Filter 的正確姿式

Filter 是 JavaEE 中 Servlet 規範的一個組件，位於包javax.servlet 中，它能夠在 HTTP 請求到達 Servlet 以前，被一個或多個Filter處理。

它的工做流程如圖：

Filter的這個特性在生產環境中有很普遍的應用，如：修改請求和響應、防止xss攻擊、包裝二進制流使其能夠屢次讀，等等。

實際工做中，咱們都是使用 SpringBoot 進行業務開發，本文總結三種 Filter 用法，SpringBoot 版本採用目前最新的 v2.3.1.RELEASE

1. 編寫Filter

要編寫 Filter ，只須要實現javax.servlet.Filter接口就能夠了

public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("MyFilter");
        // 要繼續處理請求，必須添加 filterChain.doFilter()
        filterChain.doFilter(servletRequest,servletResponse);
    }
}

Filter 接口有三個方法：init(),doFilter(),destroy()。

其中doFilter()須要本身實現，其他兩個是default的，能夠不用實現。

注意：若是Filter要使請求繼續被處理，就必定要調用filterChain.doFilter()！

2. 配置Filter被 Spring 管理

讓自定義的 Filter 被 Spring 的 IOC 容器管理，有三種實現方式，各有優缺點。下面課表明給你們總結一下：

1. 使用@Component+@Order

在剛剛定義的MyFilter類上加上@Component和@Order註解，便可被Spring管理

@Component
@Order(1)
public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("MyFilter");
        // 要繼續處理請求，必須添加 filterChain.doFilter()
        filterChain.doFilter(servletRequest,servletResponse);
    }
}

沒錯就這麼簡單，這樣 MyFilter 就生效了，寫個Controller 調用一下就能夠看到效果。

當有多個Filter時，這裏的@Order(1)註解會指定執行順序，數字越小，越優先執行，若是隻寫@Order，默認順序值是Integer.MAX_VALUE。

@Component + @Order 註解方式配置簡單，支持自定義 Filter 順序。缺點是隻能攔截全部URL，不能經過配置去攔截指定的 URL。

2.@WebFilter+@ServletComponentScan

在 MyFilter上添加@WebFilter註解，並在啓動類上增長@ServletComponentScan("com.zhengxl.filterdemo.filter")註解，參數就是Filter所在的包路徑，至關於告訴 SpringBoot，去哪裏掃描 Filter

@WebFilter(urlPatterns = "/*")
public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("MyFilter");
        // 要繼續處理請求，必須添加 filterChain.doFilter()
        filterChain.doFilter(servletRequest,servletResponse);
    }
}

@SpringBootApplication
@ServletComponentScan("com.zhengxl.filterdemo.filter")
public class FilterDemoApplication {

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

}

@WebFilter+@ServletComponentScan 註解方式支持對 Filter 匹配指定URL，可是不支持指定 Filter 的執行順序。

3. JavaConfig 配置方式

@Configuration
public class FilterConfig {
    @Bean
    public FilterRegistrationBean registerMyFilter(){
        FilterRegistrationBean<MyFilter> bean = new FilterRegistrationBean<>();
        bean.setOrder(1);
        bean.setFilter(new MyFilter());
        // 匹配"/hello/"下面的全部url
        bean.addUrlPatterns("/hello/*");
        return bean;
    }
    @Bean
    public FilterRegistrationBean registerMyAnotherFilter(){
        FilterRegistrationBean<MyAnotherFilter> bean = new FilterRegistrationBean<>();
        bean.setOrder(2);
        bean.setFilter(new MyAnotherFilter());
        // 匹配全部url
        bean.addUrlPatterns("/*");
        return bean;
    }
}

經過 Java 代碼顯式配置 Filter ，功能強大，配置靈活。只須要把每一個自定義的 Filter 聲明成 Bean 交給 Spring 管理便可，還能夠設置匹配的 URL 、指定 Filter 的前後順序。

3. 三種方式對比

以上介紹完 SpringBoot 中三種 Filter的使用姿式，很是簡單，下面列個表格總結一下：

使用方式	排序	指定URL
@Component @Order	1	0
@WebFilter @ServletComponentScan	0	1
JavaConfig	1	1

實際使用過程當中，能夠按照業務需求選擇合適的使用方式，好比：若是編寫的過濾器要攔截全部請求，不須要指定URL，那選擇最簡單的 @Component+@Order 就很是合適。

爲方便同窗們實戰練習，本文代碼已上傳至
GitHub

PS：其實還有第四種，web.xml配置，不過這都2020年了，用 SpringBoot 的自動裝配或者 JavaConfig 不是更方便嗎？

---

👇關注 Java課表明，獲取最新 Java 乾貨👇