【Spring Boot】Web开发 — 过滤器

过滤器

本节介绍如何使用Spring Boot实现自定义过滤器，在开发Web项目时，经常需要过滤器（Filter）来处理一些请求，包括字符集转换、过滤敏感词汇等场景。

1.过滤器简介

过滤器是Java Servlet规范中定义的，能够在HTTP请求发送给Servlet之前对Request（请求）和Response（返回）进行检查和修改，从而起到过滤的作用。通过对Web服务器管理的所有Web资源（如JSP、Servlet、静态图片文件或静态HTML文件等）过滤，实现特殊的功能，例如，实现URL级别的权限访问控制、过滤敏感词汇、排除有XSS威胁的字符等。

Spring Boot内置了很多过滤器，比如处理编码的OrderedCharacterEncodingFilter和请求转化的HiddenHttpMethodFilter，也支持根据实际需求自定义过滤器。自定义过滤器有两种实现方式：第一种是使用@WebFilter，第二种是使用FilterRegistrationBean。经过实践之后，发现使用@WebFilter自定义的过滤器优先级顺序不能生效，因此推荐使用第二种方案。

过滤器和拦截器的功能类似，但技术实现差距比较大，两者的区别包括以下几个方面：

1）过滤器依赖于Servlet容器，属于Servlet规范的一部分，而拦截器则是独立存在的，可以在任何情况下使用。

2）过滤器的执行由Servlet容器回调完成，而拦截器通常通过动态代理的方式来执行。

3）过滤器的生命周期由Servlet容器管理，而拦截器可以通过IoC容器来管理，因此可以通过注入等方式来获取其他Bean的实例，因此使用更方便。

拦截器和过滤器的执行顺序是：先过滤器后拦截器。具体执行过程为：过滤前→拦截前→执行→拦截后→过滤后。

2.使用FilterRegistrationBean实现过滤器

Spring Boot提供了FilterRegistrationBean类实现过滤器注入，实现自定义过滤器的步骤如下：

1）添加自定义Filter类，实现Filter接口，并实现其中的doFilter()方法。

2）添加@Configuration注解，将自定义过滤器加入过滤链。

接下来以监控请求执行时间为例，通过自定义过滤器实现系统性能监控的功能。

步骤如下：

步骤01 创建拦截器，示例代码如下：

    @Component
    public class ConsumerTimerFilter implements Filter {
        @Override
        public void init(FilterConfig arg0) throws ServletException {
        }
        @Override
        public void destroy() {
        }
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            System.out.println("timer Filter begin");
            long start = new Date().getTime();
            chain.doFilter(request, response);
            long end = new Date().getTime();
            System.out.println("timer Filter end,cost time:" + (end - start));
        }
    }

@Component注解确保被Spring Boot管理。上面的示例代码实现了doFilter()方法记录所有HTTP请求的时间。

步骤02 将过滤器注入系统配置中。

通过FilterRegistrationBean类将定义的ConsumerTimerFilter过滤器注入系统中，并配置过滤的地址和执行顺序，示例代码如下：

    @Configuration
    public class WebConfig {
        @Bean
        public FilterRegistrationBean consumerLoginFilterRegistration() {
            FilterRegistrationBean<ConsumerLohinFilter> registration = new FilterRegistrationBean<>();
            registration.setFilter(ConsumerLoginFilter());
            registration.addUrlPatterns("/*");
            registration.setName("consumerLoginFilter");
            registration.setOrder(2);
            return registration;
        }  
    }

使用registration.setOrder(2)进行排序，数字越小越先执行。当有多个过滤器时，通过设置Order属性决定过滤器的执行顺序。

添加完后启动项目，在浏览器中输入地址http://localhost:8080/getUsers，就会看到控制台打印如下信息：

timer Filter begin
timer Filter end,cost time:17

如上所示，后台输出了请求的消耗时间，说明刚刚自定义的过滤器已经对所有的URL进行了过滤处理。