JAVA && Spring && SpringBoot2.x — 学习目录
1. 如何将Filter加入到SpringBoot中
- 使用
@WebFilter+@ServletComponentScan，注册过滤器； - 使用
@Bean方式，将过滤器放入到SpringBean中； - 使用
@Component注解，将过滤器放入到SpringBean中； - 使用
@Bean+FilterRegistrationBean自定义对Filter进行添加；
1.1 方式一：扫描拦截器
在使用嵌入式容器中（内置Tomcat），类上含有@WebServlet、@WebFilter和@WebListener注解时，可以通过启动类上的@ServletComponentScan注解进行扫描。
需要注意的是：@ServletComponentScan 在独立容器中没有任何效果，而是使用容器的内置发现机制。
1.2. 方式二：将Filter注册为Spring Bean
任何的Servlet、Filter或者Listener实例都是在容器中注册的，可以使用@Component或者@Bean。
默认情况下，如果上下文只包含一个Servlet，则将其映射为/，在多个Servlet bean的情况下，bean名称用作路径前缀，过滤器映射到/*。
@Bean
public MyFilter getMyFilter() {
return new MyFilter();
}
自定义Filter通过@Bean注解后，被SpringBoot自动注册到容器的Filter chain中，并且拦截路径为/*，这样导致的结果是：所有的URL都会被自定义的Filter过滤。
注意：该方式可以被取消注册。
1.3 方式三：FilterRegistrationBean
可以使用ServletRegistrationBean、FilterRegistrationBean以及ServletListenerRegistrationBean类进行完全的控制。
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还没有创建。）
2. 取消方式二的注册
Spring Boot对Filter、Servlet提供了相应的注册类，来进行精细化的配置，我们可以使用注册类来取消Filter的自动注册。
@Bean
public FilterRegistrationBean registration(MyFilter filter) {
FilterRegistrationBean registration = new FilterRegistrationBean(filter);
registration.setEnabled(false);
return registration;
}
