关于Filter的一些使用总结

最近在项目中看到filter使用有很多种，于是自己写下这个笔记作为记录。
项目中定义的方式有2种：
直接继承Filter

public class MyFilter implements Filter{
    ...
}

继承OncePerRequestFilter

public class MyOncePerRequestFilter implements OncePerRequestFilter{
    ...
}

因为OncePerRequestFilter继承Filter ，这2种定义的方式其实差不多，本意都是每个请求只执行一次此过滤器。spring中filter都是继承OncePerRequestFilter，查过一些文档得到答案是，Filter是servlet实现的，即时web容器实现的，而不是版本的Filter实现方式可能不一致。
如，servlet2.3与servlet2.4也有一定差异

在servlet-2.3中，Filter会过滤一切请求，包括服务器内部使用forward转发请求和<%@ include file="/index.jsp"%>的情况。

到了servlet-2.4中Filter默认下只拦截外部提交的请求，forward和include这些内部转发都不会被过滤，但是有时候我们需要 forward的时候也用到Filter。

而spring使用OncePerRequestFilter方式是为了兼容不同的web container，特意而为之（jsr168），所以默认filter继承OncePerRequestFilter是一个比较稳妥的选择

另外注册Filter的方式也有多种，因为项目使用spring-boot,本地使用内嵌tomcat进行调试，而部署到服务器使用war的方式部署。
项目使用了这几种方式进行注册
本地debug环境

@Configuration
@Conditional(DebugEnvCondition.class)
public class FilterConfiguration {
    @Bean
    public FilterRegistrationBean myFilter() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new MyFilter());
        registration.setOrder(Integer.MAX_VALUE - 1);
        registration.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.FORWARD);
        registration.setAsyncSupported(true);
        registration.addUrlPatterns("/*");
        return registration;
    }
}

war包使用web.xml的方式进行注册

    <filter>
        <filter-name>myFilter</filter-name>
        <filter-class>com.test.MyFilter</filter-class>
        <async-supported>true</async-supported>
    </filter>

    <filter-mapping>
        <filter-name>debugFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

有的filter类上会加上WebFilter进行注解

@WebFilter(filterName = "myFilter", urlPatterns = "/*",
                dispatcherTypes = {DispatcherType.REQUEST, DispatcherType.FORWARD}, asyncSupported = true)
public class MyFilter extends OncePerRequestFilter 

常规使用方式其实是不用web.xml的方式也是可以的
用WebFilter注解，然后再启动类上加ServletComponentScan注解

SpringBootApplication 上使用@ServletComponentScan 注解后
Servlet可以直接通过@WebServlet注解自动注册
Filter可以直接通过@WebFilter注解自动注册
Listener可以直接通过@WebListener 注解自动注册

单独使用WebFilter注解后如果使用war包部署到外包tomcat下，这样是可以注册到filterChain中，使filter生效，只是本地调试不作用。
第三方的Filter一般是通过**FilterAutoConfiguration进行注册，也是上面本地debug方式，只是环境没有限制在debug环境中，通过这种方式注册到servlet的filter链表中