springboot使用之多個(gè)filter的執(zhí)行順序以及配置方式
springboot 多個(gè)filter的執(zhí)行順序以及配置
當(dāng)項(xiàng)目中有多個(gè)filter時(shí)，為了便于管理，可以創(chuàng)建一個(gè)配置文件，對(duì)所有的filter進(jìn)行管理。
有的方法可能同時(shí)需要多個(gè)filter依次對(duì)其進(jìn)行過(guò)濾，這時(shí)候便需要對(duì)filter的執(zhí)行進(jìn)行優(yōu)先級(jí)的排序。如下：
新建一個(gè)配置文件ComponentFilterOrderConfig.java
先生成一個(gè)過(guò)濾器的bean，再把過(guò)濾器的bean注入到FilterRegistrationBean中，并設(shè)置一些屬性，過(guò)濾的url，執(zhí)行的順序之類的（order的數(shù)值越小，優(yōu)先級(jí)越高）即可。
在MyHiddenHttpMethodFilter.java和TokenAuthorFilter.java里面不需要在添加注解@WebFilter(urlPatterns={})或@Configuration @Component等注解
@Configuration
public class ComponentFilterOrderConfig {
@Bean
public Filter MyHiddenHttpMethodFilter(){
return new MyHiddenHttpMethodFilter();//自定義的過(guò)濾器
}
@Bean
public Filter tokenAuthorFilter(){
return new TokenAuthorFilter();//自定義的過(guò)濾器
}
@Bean
public FilterRegistrationBean filterRegistrationBean1(){
FilterRegistrationBean filterRegistrationBean=new FilterRegistrationBean();
filterRegistrationBean.setFilter(MyHiddenHttpMethodFilter());
filterRegistrationBean.addUrlPatterns("/app/approval/*");
filterRegistrationBean.setOrder(6);//order的數(shù)值越小 則優(yōu)先級(jí)越高
return filterRegistrationBean;
}
@Bean
public FilterRegistrationBean filterRegistrationBean2(){
FilterRegistrationBean filterRegistrationBean=new FilterRegistrationBean();
filterRegistrationBean.setFilter(tokenAuthorFilter());
filterRegistrationBean.addUrlPatterns("/app/*");
filterRegistrationBean.setOrder(7);
return filterRegistrationBean;
}
}
SpringBoot 使用 Filter 的正確姿勢(shì)
Filter 是 JavaEE 中 Servlet 規(guī)范的一個(gè)組件，位于包javax.servlet 中，它可以在 HTTP 請(qǐng)求到達(dá) Servlet 之前，被一個(gè)或多個(gè)Filter處理。
它的工作流程如圖：
Filter的這個(gè)特性在生產(chǎn)環(huán)境中有很廣泛的應(yīng)用，如：修改請(qǐng)求和響應(yīng)、防止xss攻擊、包裝二進(jìn)制流使其可以多次讀，等等。
實(shí)際工作中，我們都是使用 SpringBoot 進(jìn)行業(yè)務(wù)開(kāi)發(fā)，本文總結(jié)三種 Filter 用法，SpringBoot 版本采用目前最新的 v2.3.1.RELEASE
1. 編寫Filter
要編寫 Filter ，只需要實(shí)現(xiàn)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");
// 要繼續(xù)處理請(qǐng)求，必須添加 filterChain.doFilter()
filterChain.doFilter(servletRequest,servletResponse);
}
}
Filter 接口有三個(gè)方法：init(),doFilter(),destroy()。
其中doFilter()需要自己實(shí)現(xiàn)，其余兩個(gè)是default的，可以不用實(shí)現(xiàn)。
注意：如果Filter要使請(qǐng)求繼續(xù)被處理，就一定要調(diào)用filterChain.doFilter()！
2. 配置Filter被 Spring 管理
讓自定義的 Filter 被 Spring 的 IOC 容器管理，有三種實(shí)現(xiàn)方式，各有優(yōu)缺點(diǎn)。下面課代表給大家總結(jié)一下：
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");
// 要繼續(xù)處理請(qǐng)求，必須添加 filterChain.doFilter()
filterChain.doFilter(servletRequest,servletResponse);
}
}
沒(méi)錯(cuò)就這么簡(jiǎn)單，這樣 MyFilter 就生效了，寫個(gè)Controller 調(diào)用一下就可以看到效果。
當(dāng)有多個(gè)Filter時(shí)，這里的@Order(1)注解會(huì)指定執(zhí)行順序，數(shù)字越小，越優(yōu)先執(zhí)行，如果只寫@Order，默認(rèn)順序值是Integer.MAX_VALUE。
@Component + @Order 注解方式配置簡(jiǎn)單，支持自定義 Filter 順序。缺點(diǎn)是只能攔截所有URL，不能通過(guò)配置去攔截指定的 URL。
2.@WebFilter+@ServletComponentScan
在 MyFilter上添加@WebFilter注解，并在啟動(dòng)類上增加@ServletComponentScan("com.zhengxl.filterdemo.filter")注解，參數(shù)就是Filter所在的包路徑，相當(dāng)于告訴 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");
// 要繼續(xù)處理請(qǐng)求，必須添加 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 注解方式支持對(duì) Filter 匹配指定URL，但是不支持指定 Filter 的執(zhí)行順序。
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;
}
}
通過(guò) Java 代碼顯式配置 Filter ，功能強(qiáng)大，配置靈活。只需要把每個(gè)自定義的 Filter 聲明成 Bean 交給 Spring 管理即可，還可以設(shè)置匹配的 URL 、指定 Filter 的先后順序。
3. 三種方式對(duì)比
以上介紹完 SpringBoot 中三種 Filter的使用姿勢(shì)，非常簡(jiǎn)單，下面列個(gè)表格總結(jié)一下：
| 使用方式 | 排序 | 指定URL |
|---|---|---|
| @Component @Order | 1 | 0 |
| @WebFilter @ServletComponentScan | 0 | 1 |
| JavaConfig | 1 | 1 |
實(shí)際使用過(guò)程中，可以按照業(yè)務(wù)需求選擇合適的使用方式，比如：如果編寫的過(guò)濾器要攔截所有請(qǐng)求，不需要指定URL，那選擇最簡(jiǎn)單的 @Component+@Order 就非常合適。
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
mybatis抽取基類BaseMapper增刪改查的實(shí)現(xiàn)
目前項(xiàng)目當(dāng)中使用mapper.xml文件方式對(duì)數(shù)據(jù)庫(kù)進(jìn)行操作,但是每個(gè)里邊都有增/刪/改/查,為了方便開(kāi)發(fā),把這些公共的代碼提取出來(lái),不用當(dāng)做基類,不用每個(gè)Mapper文件都寫了，本文就詳細(xì)的介紹一下實(shí)現(xiàn)方法2021-09-09
Java中static修飾的靜態(tài)變量、方法及代碼塊的特性與使用
這篇文章主要介紹了Java中static修飾的靜態(tài)變量、方法及代碼塊的特性與使用,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04
在Mybatis中JdbcType類型是一個(gè)枚舉類型，它包含了所有的JDBC數(shù)據(jù)類型，如VARCHAR、INTEGER、DATE等，本文主要介紹了淺談MyBatis所有的jdbcType類型，具有一定的參考價(jià)值，感興趣的可以了解一下2023-06-06
原生Java操作mysql數(shù)據(jù)庫(kù)過(guò)程解析
這篇文章主要介紹了原生Java操作mysql數(shù)據(jù)庫(kù)過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-11-11
這篇文章主要為大家介紹了java重試機(jī)制使用RPC必須考慮冪等性原理解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-03-03
java算法實(shí)現(xiàn)紅黑樹(shù)完整代碼示例
這篇文章主要介紹了java算法實(shí)現(xiàn)紅黑樹(shù)完整代碼示例，具有一定參考價(jià)值，需要的朋友可以了解下。2017-11-11
RESTful是一種web軟件風(fēng)格，它不是標(biāo)準(zhǔn)也不是協(xié)議，它不一定要采用,只是一種風(fēng)格，它倡導(dǎo)的是一個(gè)資源定位(url)及資源操作的風(fēng)格，這篇文章主要介紹了SpringBoot使用RESTful接口2022-10-10
java JVM原理與常識(shí)知識(shí)點(diǎn)
在本文中小編給大家分享的是關(guān)于java的JVM原理和java常識(shí)，有興趣的朋友們可以學(xué)習(xí)下2018-12-12
Java多態(tài)實(shí)現(xiàn)原理詳細(xì)梳理總結(jié)
這篇文章主要介紹了Java多態(tài)實(shí)現(xiàn)原理詳細(xì)梳理總結(jié)，多態(tài)是繼封裝、繼承之后，面向?qū)ο蟮牡谌筇匦?，本文只總結(jié)了多態(tài)的實(shí)現(xiàn)原理，需要的朋友可以參考一下2022-06-06
Java實(shí)現(xiàn)五子棋的基礎(chǔ)方法
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)五子棋的基礎(chǔ)方法，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-09-09