Spring Boot使用方法小札（4）：使用Serlvet中原生Filter API

在Java Web中除了我们非常熟悉的Servlet，还有Filter和Listener等，在Java Web基础知识之Filter：过滤一切你不想看到的事情和Java Web基础知识之Listener：监控Servlet的每个动作这两篇文章中已经说明了，但是在Spring Boot怎样使用Java Web中原生的Filter组件？这里总结一下使用方式。

在Spring Boot中会自动配置一些Filter以供使用，比如CharacterEncodingFilter、HiddenHttpMethodFilter、HttpPutFormContentFilter、RequestContextFilter、WebRequestLoggingFilter等，如下：

1.自定义Filter

在Spring Boot中使用原生的Filter其实是很简单，只需要将我们自定义的Filter声明为Bean放到Spring容器中即可，当Spring Boot检测到javax.servlet.Filter的实例就会把它自动加入到Filter链中，如下自定义一个Filter：

    public class LoggingFilter implements Filter{
        private static final Logger logger = LoggerFactory.getLogger(LoggingFilter.class);

        @Override
        public void init(FilterConfig filterConfig) throws ServletException {

        }

        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            logger.info("LoggingFilter work");
        }

        @Override
        public void destroy() {

        }
    }

之后在配置类中声明为Bean，如下：

    @Configuration
    public class FilterConfig {

        @Bean
        public Filter loggingFilter(){
            return new LoggingFilter();
        }
    }

这样我们的Filter就可以起作用了，如下：

2.配置自定义Filter

在第一部分我们只是简单的使用了自定义的Filter，至于有关Filter的其他问题，比如Filter影响的URL的路径、多个Filter同时声明时的作用顺序等。

如果想要配置自定义Filter的这些问题，需要将org.springframework.boot.context.embedded.FilterRegistrationBean定义为Bean进行配置，首先定义两个Filter，除了上面的LoggingFilter，还有如下：

    public class AuthenticationFilter implements Filter {
        private static final Logger logger = LoggerFactory.getLogger(LoggingFilter.class);

        @Override
        public void init(FilterConfig filterConfig) throws ServletException {

        }

        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            logger.info("AuthenticationFilter work");
        }

        @Override
        public void destroy() {

        }
    }

在配置类中声明如下：

    @Configuration
    public class FilterConfig {

        @Bean
        public FilterRegistrationBean loggingFilter(){
            FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new LoggingFilter());

            filterRegistrationBean.setOrder(3);
            List<String> urls = new ArrayList<>();
            urls.add("/logging");

            filterRegistrationBean.setUrlPatterns(urls);
            return filterRegistrationBean;
        }

        @Bean
        public FilterRegistrationBean authenticationFilter(){
            FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new AuthenticationFilter());

            filterRegistrationBean.setOrder(2);
            List<String> urls = new ArrayList<>();
            urls.add("/authentication");

            filterRegistrationBean.setUrlPatterns(urls);
            return filterRegistrationBean;
        }
    }

这里使用setUrlPatterns(…)配置Filter影响的urls，它的设定的url是相对于contextPath的，setOrder(…)设置过滤器链中作用的顺序，其实从源码中看是使用了org.springframework.core.Ordered接口来确定顺序，如下：