您好,登錄后才能下訂單哦!
這篇文章主要介紹了springboot中多個(gè)filter執(zhí)行順序以及配置方式的示例分析,具有一定借鑒價(jià)值,感興趣的朋友可以參考下,希望大家閱讀完這篇文章之后大有收獲,下面讓小編帶著大家一起了解一下。
當(dāng)項(xiàng)目中有多個(gè)filter時(shí),為了便于管理,可以創(chuàng)建一個(gè)配置文件,對(duì)所有的filter進(jìn)行管理。
有的方法可能同時(shí)需要多個(gè)filter依次對(duì)其進(jìn)行過濾,這時(shí)候便需要對(duì)filter的執(zhí)行進(jìn)行優(yōu)先級(jí)的排序。如下:
先生成一個(gè)過濾器的bean,再把過濾器的bean注入到FilterRegistrationBean中,并設(shè)置一些屬性,過濾的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();//自定義的過濾器 } @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的數(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; } }
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ù)開發(fā),本文總結(jié)三種 Filter 用法,SpringBoot 版本采用目前最新的 v2.3.1.RELEASE
要編寫 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()!
讓自定義的 Filter 被 Spring 的 IOC 容器管理,有三種實(shí)現(xiàn)方式,各有優(yōu)缺點(diǎn)。下面課代表給大家總結(jié)一下:
在剛剛定義的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); } }
沒錯(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。
在 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í)行順序。
@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 ,功能強(qiáng)大,配置靈活。只需要把每個(gè)自定義的 Filter 聲明成 Bean 交給 Spring 管理即可,還可以設(shè)置匹配的 URL 、指定 Filter 的先后順序。
以上介紹完 SpringBoot 中三種 Filter的使用姿勢,非常簡單,下面列個(gè)表格總結(jié)一下:
使用方式 | 排序 | 指定URL |
---|---|---|
@Component @Order | 1 | 0 |
@WebFilter @ServletComponentScan | 0 | 1 |
JavaConfig | 1 | 1 |
實(shí)際使用過程中,可以按照業(yè)務(wù)需求選擇合適的使用方式,比如:如果編寫的過濾器要攔截所有請(qǐng)求,不需要指定URL,那選擇最簡單的 @Component+@Order 就非常合適。
感謝你能夠認(rèn)真閱讀完這篇文章,希望小編分享的“springboot中多個(gè)filter執(zhí)行順序以及配置方式的示例分析”這篇文章對(duì)大家有幫助,同時(shí)也希望大家多多支持億速云,關(guān)注億速云行業(yè)資訊頻道,更多相關(guān)知識(shí)等著你來學(xué)習(xí)!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請(qǐng)聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。