springboot 多個filter的執行順序以及配置
當項目中有多個filter時，為了便于管理，可以創建一個配置文件，對所有的filter進行管理。
有的方法可能同時需要多個filter依次對其進行過濾，這時候便需要對filter的執行進行優先級的排序。如下：
新建一個配置文件ComponentFilterOrderConfig.java
先生成一個過濾器的bean，再把過濾器的bean注入到FilterRegistrationBean中，并設置一些屬性，過濾的url，執行的順序之類的（order的數值越小，優先級越高）即可。
在MyHiddenHttpMethodFilter.java和TokenAuthorFilter.java里面不需要在添加注解@WebFilter(urlPatterns={})或@Configuration @Component等注解
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
@Configurationpublic class ComponentFilterOrderConfig { @Bean public Filter MyHiddenHttpMethodFilter(){ return new MyHiddenHttpMethodFilter();//自定義的過濾器 } @Bean public Filter tokenAuthorFilter(){ return new TokenAuthorFilter();//自定義的過濾器 } @Bean public FilterRegistrationBean filterRegistrationBean1(){ FilterRegistrationBean filterRegistrationBean=new FilterRegistrationBean(); filterRegistrationBean.setFilter(MyHiddenHttpMethodFilter()); filterRegistrationBean.addUrlPatterns("/app/approval/*"); filterRegistrationBean.setOrder(6);//order的數值越小 則優先級越高 return filterRegistrationBean; } @Bean public FilterRegistrationBean filterRegistrationBean2(){ FilterRegistrationBean filterRegistrationBean=new FilterRegistrationBean(); filterRegistrationBean.setFilter(tokenAuthorFilter()); filterRegistrationBean.addUrlPatterns("/app/*"); filterRegistrationBean.setOrder(7); return filterRegistrationBean; } } |
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接口就可以了
|
1
2
3
4
5
6
7
8
|
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管理
|
1
2
3
4
5
6
7
8
9
10
|
@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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
@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 配置方式
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
@Configurationpublic 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 就非常合適。
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持服務器之家。
原文鏈接：https://blog.csdn.net/east123321/article/details/80856389
