springboot中创建Filter有四种方法,具体如下
第一种
@WebFilter(filterName = "myFilter",urlPatterns = "/*")
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
}
@Override
public void destroy() {
}
}
@SpringBootApplication
@EnableAutoConfiguration
@EnableWebMvc
@ServletComponentScan(basePackages = "com.my.test.filter")//所扫描的包路径必须包含该Filter
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application .class, args);
}
}
特别注意:@ServletComponentScan
所扫描的包路径必须包含该Filter
第二种
@Configuration
public class FilterConfig {
@Bean
public FilterRegistrationBean filterRegistrationBean(){
FilterRegistrationBean bean = new FilterRegistrationBean();
bean.setFilter(new MyFilter2());
bean.addUrlPatterns("/*");
return bean;
}
}
第三种
@Bean("proxyFilter")
public Filter filter (){
return new Filter() {
@Override
public void init(javax.servlet.FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
}
@Override
public void destroy() {
}
};
}
@Bean
public DelegatingFilterProxyRegistrationBean delegatingFilterProxyRegistrationBean(){
DelegatingFilterProxyRegistrationBean bean = new DelegatingFilterProxyRegistrationBean("proxyFilter");
bean.addUrlPatterns("/*");
return bean;
}
方法四
@Bean("myFilter")
public Filter filter (){
return new Filter() {
@Override
public void init(javax.servlet.FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
}
@Override
public void destroy() {
}
};
}
说明:
- 第二种和第三种类似,均实现了
AbstractFilterRegistrationBean
接口,而该接口间接实现了ServletContextInitializer
,springboot在启动容器后会查找实现该接口的bean,并调用onStartup()
方法添加自定义的Filter,两则的区别DelegatingFilterProxyRegistrationBean
通过传入的proxyFilter名字,在WebApplicationContext
查找该Fillter Bean,并通过DelegatingFilterProxy
生成基于该Bean的代理Filter对象,
而FilterRegistrationBean
则是直接设置一个Filter,因此该Filter可以有spring容器管理,也可不用spring管理
注意:如果Filter声明为一个Bean,则不需要定义为FilterRegistrationBean
,也会被spring发现并添加,就是方法四,该方式无法定义拦截规则等,默认全局,慎用
void init(FilterConfig paramFilterConfig)
– 当容器初始化 Filter 时调用,该方法在 Filter 的生命周期只会被调用一次,一般在该方法中初始化一些资源,FilterConfig 是容器提供给 Filter 的初始化参数,在该方法中可以抛出 ServletException 。init 方法必须执行成功,否则 Filter 可能不起作用,出现以下两种情况时,web 容器中 Filter 可能无效: 1)抛出 ServletException 2)超过 web 容器定义的执行时间。doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, FilterChain paramFilterChain)
– Web 容器每一次请求都会调用该方法。该方法将容器的请求和响应作为参数传递进来, FilterChain 用来调用下一个 Filter。
参考 :https://www.jianshu.com/p/3d421fbce734