花式玩 Spring Boot!过滤器竟有 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 注解中可以配置过滤器的拦截规则。这个注解要生效,种注册还需要我们在项目启动类上配置 @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 的优先级,如果存在多个 Filter 时,无法通过 @Order 指定优先级。

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 容器中即可。而且这种方式还有一个优势,就是如果存在多个 Filter,可以通过 @Order 注解指定多个 Filter 的优先级,像下面这样:

@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);     } } 

虽然解决了优先级问题,但是大家发现这种方式好像没有办法设置 Filter 的拦截规则!是的,直接定义 Bean 的话,默认的拦截规则就是 /* 即拦截所有请求,开发者无法进行自定义配置。

那么有没有办法即配置拦截规则,又配置优先级呢?接下来介绍的第三种方案可以鱼与熊掌兼得。

3.FilterRegistrationBean

第三种方案还是高防服务器将 Filter 封装成一个 Bean,但这个 Bean 是 FilterRegistrationBean,通过 FilterRegistrationBean 我们既可以配置 Filter 的优先级,也可以配置 Filter 的拦截规则。

一般在项目中,我们都是使用 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 实现了 ServletContextInitializer 接口,在 Servlet 启动时,RegistrationBean#onStartup 方法会被调用,进而完成 Filter、Servlet 以及 Listener 的注册。 enabled 属性可以理解为一个开关,设置为 false 相当于关闭组件注册。

RegistrationBean 有众多的实现类,我们之前使用的 FilterRegistrationBean 只是其中之一:

实现类的作用一目了然:

ServletListenerRegistrationBean 用来注册监听器。 ServletRegistrationBean 用来注册 Servlet。 DispatcherServletRegistrationBean 用来注册 DispatcherServlet。 FilterRegistrationBean 用来注册过滤器。企商汇 DelegatingFilterProxyRegistrationBean 则用来注册 DelegatingFilterProxy,DelegatingFilterProxy 在 Spring Security、Spring Session、Shiro 等整合时非常有用。

5.小结

今天就和小伙伴们分享一下 Spring Boot 中过滤器的三种注册方式,顺带和大家分享了一下 FilterRegistrationBean 的继承体系,小伙伴们可以根据 FilterRegistrationBean 的继承体系中的实现类,自行尝试一下 Servlet 和 Listener 的注册方式~本文案例下载地址:https://github.com/lenve/javaboy-code-samples

本文转载自微信公众号「江南一点雨」,可以通过以下二维码关注。转载本文请联系江南一点雨公众号。

滇ICP备2023000592号-31