SpringBoot 中使用 Filter 的正確姿勢

點(diǎn)擊藍(lán)色“程序員黃小斜”關(guān)注我喲

加個(gè)“星標(biāo)”，每天和你一起多進(jìn)步一點(diǎn)點(diǎn)！

Filter 是 JavaEE 中 Servlet 規(guī)范的一個(gè)組件，位于包javax.servlet 中，它可以在 HTTP 請求到達(dá) Servlet 之前，被一個(gè)或多個(gè)Filter處理。

它的工作流程如圖：

Filter的這個(gè)特性在生產(chǎn)環(huán)境中有很廣泛的應(yīng)用，如：修改請求和響應(yīng)、防止xss攻擊、包裝二進(jìn)制流使其可以多次讀，等等。

實(shí)際工作中，我們都是使用 SpringBoot 進(jìn)行業(yè)務(wù)開發(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ù)處理請求，必須添加?filterChain.doFilter()
????????filterChain.doFilter(servletRequest,servletResponse);
????}
}

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

其中doFilter()需要自己實(shí)現(xiàn)，其余兩個(gè)是default的，可以不用實(shí)現(xiàn)。

注意：如果Filter要使請求繼續(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ù)處理請求，必須添加?filterChain.doFilter()
????????filterChain.doFilter(servletRequest,servletResponse);
????}
}

沒錯(cuò)就這么簡單，這樣 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 注解方式配置簡單，支持自定義 Filter 順序。缺點(diǎn)是只能攔截所有URL，不能通過配置去攔截指定的 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ù)處理請求，必須添加?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 的執(zhí)行順序。

3. JavaConfig 配置方式

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

通過 Java 代碼顯式配置 Filter ，功能強(qiáng)大，配置靈活。只需要把每個(gè)自定義的 Filter 聲明成 Bean 交給 Spring 管理即可，還可以設(shè)置匹配的 URL 、指定 Filter 的先后順序。

3. 三種方式對比

以上介紹完 SpringBoot 中三種 Filter的使用姿勢，非常簡單，下面列個(gè)表格總結(jié)一下：

實(shí)際使用過程中，可以按照業(yè)務(wù)需求選擇合適的使用方式，比如：如果編寫的過濾器要攔截所有請求，不需要指定URL，那選擇最簡單的 @Component+@Order 就非常合適。

為方便同學(xué)們實(shí)戰(zhàn)練習(xí)，本文代碼已上傳至GitHub^[1]

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

5年前，榨干程序員老公1300萬資產(chǎn)，逼其跳樓自殺的翟欣欣如今怎樣了？

扒了一下西安一碼通的接口，這特么不崩才怪呢~

互聯(lián)網(wǎng)校招黑名單！

—?【 THE END 】—
公眾號(hào)[程序員黃小斜]全部博文已整理成一個(gè)目錄，請?jiān)诠娞?hào)里回復(fù)「m」獲??！
最近面試BAT，整理一份面試資料《Java面試BATJ通關(guān)手冊》，覆蓋了Java核心技術(shù)、JVM、Java并發(fā)、SSM、微服務(wù)、數(shù)據(jù)庫、數(shù)據(jù)結(jié)構(gòu)等等。
獲取方式：點(diǎn)“在看”，關(guān)注公眾號(hào)并回復(fù) PDF?領(lǐng)取，更多內(nèi)容陸續(xù)奉上。
文章有幫助的話，在看，轉(zhuǎn)發(fā)吧。
謝謝支持喲 (*^__^*）