JAVA && Spring && SpringBoot2.x — 学习目录

SpringBoot官网对于Filter的配置说明

any Servlet or Filter beans are registered with the servlet container automatically.

所有的Servlet或者Filter会被Servlet容器自动注册。

创建Filter 拦截器的方式：

1. 使用@Bean注解，将过滤器放入到SpringBean中；
2. 使用@Component注解，将过滤器放入到SpringBean中；
3. 使用WebFilter+@ServletComponentScan，注册过滤器；
4. 使用FilterRegistrationBean自定义对Filter进行添加；

注：方法1,2 添加后默认的过滤路径是/*

对于一般场景来说，使用方式1,2是最简单的，Filter会被自动的注册到Servlet容器中，但是对于特定的需求（例如Shiro的自定义过滤器），若是自定义的Filter通过@Bean注解后，被SpringBoot自动注册到Filter Chain中，这样导致的结果是，所有的URL都会被自定义的Filter过滤，而不是Shiro配置的一部分URL。

1. 如何取消Filter的自动注册

如上所说，方法4，可以通过FilterRegistrationBean来自定义的注册Bean。进行精确的配置，故可以取消Filter的自动注册！

@Bean
public FilterRegistrationBean registration(MyFilter filter) {
    FilterRegistrationBean registration = new FilterRegistrationBean(filter);
    registration.setEnabled(false);
    return registration;
}

注：若是在FilterRegistrationBean方法中设置取消自动注册，那么该拦截器(MyFilter )就不会加入到容器中。

2. 自定义注册filter的方法

2.1 使用FilterRegistrationBean，实例化该类可注册自定义filter

@Configuration
public class ApplicationConfiguration{
    @Bean
    public FilterRegistrationBean myFilter() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        MyFilter myFilter = new MyFilter();
        filterRegistrationBean.setFilter(myFilter);
        List<String> urls = new ArrayList<>();
        urls.add("/users/*");
        filterRegistrationBean.setUrlPatterns(urls);//配置过滤规则
        return filterRegistrationBean;
    }
}

2.2 借助spring的代理类DelegatingFilterProxy和FilterRegistrationBean实现

    @Bean
    public FilterRegistrationBean myFilterBean() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new DelegatingFilterProxy("myFilter"));
        filterRegistrationBean.addInitParameter("targetFilterLifecycle", "true");
        filterRegistrationBean.setEnabled(true);
        filterRegistrationBean.addUrlPatterns("/*");
        return filterRegistrationBean;
    }

2.3 DelegatingFilterProxyRegistrationBean实现

    @Bean
    public DelegatingFilterProxyRegistrationBean delegatingFilterProxyRegistrationBean(){
        DelegatingFilterProxyRegistrationBean bean = new DelegatingFilterProxyRegistrationBean("myFilter");
        bean.addInitParameter("targetFilterLifecycle", "true");
        bean.setEnabled(true);
        bean.addUrlPatterns("/*");
        return bean;
    }

第一种方法和第二种方法本质上是一致的，主要是FilterRegistrationBean [ˌredʒɪˈstreɪʃn]这个类，通过AbstractFilterRegistrationBean接口间接实现了ServletContextInitializer，在SpringBoot中启动容器后会查找实现该接口的bean，并调用onstart()方法将自定义的Filter添加到Servlet容器中。

两者的区别是方法一可以直接设置Filter，该Filter可以不使用Spring管理，直接new出来，正如方法一，也可以使用Spring管理(但要注意自动注册的问题)。

方法二通过DelegatingFilterProxy传入Filter名字，在WebApplicationContext查找该FilterBean，并将DelegatingFilterProxy生成Bean作为Filter的代理对象，这样做的目的：和web.xml时的项目一样，容器加载时先加载代理Filter，不需要直接加载真正的Filter，达到懒加载的效果（注：有web.xml时项目使用代理Filter，必须懒加载，因为web.xml加载filter的时候，spring中真正的bean还没有创建。）

文章参考

springboot自定义filter学习笔记