手把手教你SpringBoot過濾器N種注冊方式
要說在 Spring Boot 中注冊過濾器有三種方式，你都能想到哪些呢?今天松哥就來和大家聊一聊 Spring Boot 中注冊過濾器的三種方式!
其實本來是想和大家聊 Spring Security 過濾器鏈的問題的，結果看源碼看著看著就跑題了，索性就先和大家聊一聊 Spring Boot 中注冊過濾器的三種方式，算是給 后面的 Spring Security 打一點基礎。
1.@WebFilter
通過 @WebFilter 注解來標記一個過濾器，這種方式相信大家很容易想到。這是將 Servlet 中的那一套東西直接拿到 Spring Boot 上用。
具體做法就是通過 @WebFilter 注解來標記一個 Filter，如下：
@WebFilter(urlPatterns = "/*")
public class MyFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
System.out.println("-----doFilter-----");
chain.doFilter(request, response);
}
}
在 @WebFilter 注解中可以配置過濾器的攔截規(guī)則。這個注解要生效，還需要我們在項目啟動類上配置 @ServletComponentScan 注解，如下：
@SpringBootApplication
@ServletComponentScan
public class FilterdemoApplication {
public static void main(String[] args) {
SpringApplication.run(FilterdemoApplication.class, args);
}
}
@ServletComponentScan 注解雖然名字帶了 Servlet，但是實際上它不僅僅可以掃描項目中的 Servlet 容器，也可以掃描 Filter 和 Listener。
這是我們在 Spring Boot 中使用過濾器的第一種方式，在實際項目中，這種方式使用較少，因為這種方式有一個很大的弊端就是無法指定 Filter 的優(yōu)先級，如果存在多個 Filter 時，無法通過 @Order 指定優(yōu)先級。
2.@Bean
第二種方式就是將過濾器配置成 Bean，注冊到 Spring 容器中去。這種方法不再需要 @ServletComponentScan 注解，只要一個 Bean 即可，如下：
@Component
public class MyFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
System.out.println("-----doFilter-----");
chain.doFilter(request, response);
}
}
這種方式看起來很方便，一個注解將 Filter 納入到 Spring 容器中即可。而且這種方式還有一個優(yōu)勢，就是如果存在多個 Filter，可以通過 @Order 注解指定多個 Filter 的優(yōu)先級，像下面這樣：
@Component
@Order(-1)
public class MyFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
System.out.println("-----doFilter-----");
chain.doFilter(request, response);
}
}
雖然解決了優(yōu)先級問題，但是大家發(fā)現(xiàn)這種方式好像沒有辦法設置 Filter 的攔截規(guī)則!是的，直接定義 Bean 的話，默認的攔截規(guī)則就是 /* 即攔截所有請求，開發(fā)者無法進行自定義配置。
那么有沒有辦法即配置攔截規(guī)則，又配置優(yōu)先級呢?接下來介紹的第三種方案可以魚與熊掌兼得。
3.FilterRegistrationBean
第三種方案還是將 Filter 封裝成一個 Bean，但這個 Bean 是 FilterRegistrationBean，通過 FilterRegistrationBean 我們既可以配置 Filter 的優(yōu)先級，也可以配置 Filter 的攔截規(guī)則。
一般在項目中，我們都是使用 FilterRegistrationBean 來配置過濾器，一起來看一個案例：
@Configuration
public class FilterConfiguration {
@Bean
FilterRegistrationBean<MyFilter> myFilterFilterRegistrationBean() {
FilterRegistrationBean<MyFilter> bean = new FilterRegistrationBean<>();
bean.setFilter(new MyFilter());
bean.setOrder(-1);
bean.setUrlPatterns(Arrays.asList("/*"));
return bean;
}
@Bean
FilterRegistrationBean<MyFilter2> myFilterFilterRegistrationBean2() {
FilterRegistrationBean<MyFilter2> bean = new FilterRegistrationBean<>();
bean.setFilter(new MyFilter2());
bean.setOrder(-2);
bean.setUrlPatterns(Arrays.asList("/hello"));
return bean;
}
}
4.擴展
FilterRegistrationBean 到底是什么來頭呢?這里也和大家分享下。
Spring Boot 為了方便大家向 Servlet 容器中注冊 Servlet、Filter 以及 Listener，提供了一個 Bean 注冊的抽象類 RegistrationBean，如下：
public abstract class RegistrationBean implements ServletContextInitializer, Ordered {
private int order = Ordered.LOWEST_PRECEDENCE;
private boolean enabled = true;
@Override
public final void onStartup(ServletContext servletContext) throws ServletException {
String description = getDescription();
if (!isEnabled()) {
logger.info(StringUtils.capitalize(description) + " was not registered (disabled)");
return;
}
register(description, servletContext);
}
protected abstract String getDescription();
protected abstract void register(String description, ServletContext servletContext);
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
public boolean isEnabled() {
return this.enabled;
}
public void setOrder(int order) {
this.order = order;
}
@Override
public int getOrder() {
return this.order;
}
}
RegistrationBean 實現(xiàn)了 ServletContextInitializer 接口，在 Servlet 啟動時，RegistrationBean#onStartup 方法會被調(diào)用，進而完成 Filter、Servlet 以及 Listener 的注冊。
enabled 屬性可以理解為一個開關，設置為 false 相當于關閉組件注冊。
RegistrationBean 有眾多的實現(xiàn)類，我們之前使用的 FilterRegistrationBean 只是其中之一：
實現(xiàn)類的作用一目了然：
- ervletListenerRegistrationBean 用來注冊監(jiān)聽器。
- ServletRegistrationBean 用來注冊 Servlet。
- DispatcherServletRegistrationBean 用來注冊 DispatcherServlet。
- FilterRegistrationBean 用來注冊過濾器。
- DelegatingFilterProxyRegistrationBean 則用來注冊 DelegatingFilterProxy，DelegatingFilterProxy 在 Spring Security、Spring Session、Shiro 等整合時非常有用。
5.小結
今天就和小伙伴們分享一下 Spring Boot 中過濾器的三種注冊方式，順帶和大家分享了一下 FilterRegistrationBean 的繼承體系，小伙伴們可以根據(jù) FilterRegistrationBean 的繼承體系中的實現(xiàn)類，自行嘗試一下 Servlet 和 Listener 的注冊方式～本文案例下載地址：https://github.com/lenve/javaboy-code-samples
到此這篇關于手把手教你SpringBoot過濾器N種注冊方式的文章就介紹到這了,更多相關SpringBoot過濾器注冊內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
本文主要介紹了SpringBoot封裝JDBC的實現(xiàn)步驟，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-12-12
不論是在問題現(xiàn)場還是跳槽面試，我們面對JVM性能問題，依舊會束手無辭，它需要你對Java虛擬機的實現(xiàn)和優(yōu)化，有極為深刻的理解。所以我在這里整理了一下 JVM的知識點。今天說說虛擬機執(zhí)行引擎和垃圾回收，都是十足的干貨，請各位看官耐心批閱！2021-06-06
這篇文章主要為大家詳細介紹了java實現(xiàn)AES可逆加密算法，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-03-03
本文主要介紹了Java中static的特點。具有很好的參考價值。下面跟著小編一起來看下吧2017-03-03
springboot接收json數(shù)據(jù)時,接收到空值問題
