过滤器Filter实现及执行顺序

一、简介

过滤器（Filter）是JavaWeb的一个强大组件，基于servlet规范实现，不依赖任何框架。实现对用户请求的预处理，请求资源包含静态资源，如：js、css、图片等。

在请求到达servlet之前进行拦截，决定是否放行到请求的servlet，或在返回客户端之前，对数据进行处理。常用于权限认证、日志记录。

二、实现方式

2.1 实现原生Filter接口

public class LogFilter implements Filter {

  /**
   * 需要过滤的请求链接，拦截的请求一般设置为全部，但会有个别请求无需处理
   */
  private List<String> excludeUrls;

  @Override
  public void init(FilterConfig filterConfig) throws ServletException {
    System.out.println("初始化LogFilter");
    
    // 初始化参数，在web.xml中配置，excludeUrls需和配置中的name一样
    String value = filterConfig.getInitParameter("excludeUrls");
    if (value == null) {
      excludeUrls = new ArrayList<>();
    } else {
      excludeUrls = Arrays.asList(value.split(","));
    }
  }

  @Override
  public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    HttpServletRequest request = (HttpServletRequest) servletRequest;
    String url = request.getRequestURI();
    if (excludeUrls.contains(url)) {
      filterChain.doFilter(servletRequest, servletResponse);
      return;
    }

    System.out.println("---> LogFilter开始处理请求：" + url);

    long start = System.currentTimeMillis();
    filterChain.doFilter(servletRequest, servletResponse);
    long timeTaken = System.currentTimeMillis() - start;

    System.out.println("<--- LogFilter处理结束，url：" + url + "，耗时：" + timeTaken);
  }

  @Override
  public void destroy() {
    System.out.println("销毁LogFilter");
  }

}

可以在 web.xml配置

<!-- 定义过滤器：名称和类路径 -->
<filter>
  <filter-name>logFilter</filter-name>
  <filter-class>janice.web.filters.LogFilter</filter-class>
  <init-param>
    <param-name>excludeUrls</param-name>
    <param-value>/</param-value>
  </init-param>
</filter>
<!-- 配置过滤器的拦截路径 -->
<filter-mapping>
  <filter-name>logFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>

或使用 注解 @Webfilter 使其生效

@WebFilter(filterName = "logFilter", urlPatterns = "/*", initParams = {
  @WebInitParam(name = "excludeUrls", value = "/")
})

代码如图：

验证

加一个Controller接口，启动服务

可以看出：

1）项目启动时，创建和初始化了过滤器

2）调用测试接口：/test/filter，过滤器进行了处理。本地项目启动时，会默认打开http://localhost:8080/，doFilter未打印日志，请求被过滤

3）关闭应用，过滤器进行销毁

2.2 继承OncePerRequestFilter

OncePerRequestFilter是Spring内置的过滤器，只需要实现doFilterInternal方法

public class LogFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        String url = request.getRequestURI();
        System.out.println("---> LogFilter开始处理请求：" + url);

        long start = System.currentTimeMillis();
        filterChain.doFilter(request, response);
        long timeTaken = System.currentTimeMillis() - start;

        System.out.println("<--- LogFilter处理结束，url：" + url + "，耗时：" + timeTaken);
    }

}

配置方式

1）congfig配置注册成bean

2）加注解 @Component 注册成bean，此种方式好处是 过滤器中可以注入依赖服务了

3）@WebFilter配置，若在SrpingBoot项目中，使用该注解配置不生效，则需要在启动类上加上@ServletComponentScan

@SpringBootApplication
@ServletComponentScan(basePackages = "com.refreshdata")
public class RefreshDataApplication {

    public static void main(String[] args) {
        SpringApplication.run(RefreshDataApplication.class, args);
    }

}

三、执行顺序

1、注解方式（@WebFilter、@Component）：根据类名排序；

2、xml配置方式：根据配置的先后顺序；

3、config配置方式：优先根据设置的顺序，其次根据配置的先后顺序；

4、注解+配置混合：优先配置，再注解；

过滤器执行顺序设置

1）xml中按执行顺序来配置；

2）Config中setOrder()设置执行顺序；

3）注解@Order，设置执行顺序，值越小越先执行；

4）实现OrderedFilter接口，getOrder值越小越先执行；

注意：

1. @WebFilter无法配合@Order(int)和getOrder()设置执行顺序。因为@WebFilter 修饰的过滤器在加载时，直接使用类名来实现自定义Filter顺序；
2. @Component可以配合@Order(int)和getOrder()设置执行顺序，优先执行设置order的过滤器，其次未指定order的过滤器按类名排序执行；

PS：上述结论来自本地实验结果得出，有不正确的地方欢迎指正

结论：一个项目中过滤器的配置最好统一，这样才清楚知道过滤器的执行顺序，执行顺序有时候很重要。

上次团队做全链路跟踪，开发了一个过滤器，给请求进行traceID赋值，结束后打印请求日志，这个应该是在接收到请求时就开始操作，才能让traceID串联整个链路，所以过滤器设置了最高优先级，但上线后发现个别数据出现了乱码，原因是编码过滤器在后面才执行，导致了乱码，后来调整了执行顺序解决了该问题。

四、区别拦截器

1. 过滤器依赖servlet容器，拦截器是spring组件，依赖框架
2. 过滤器拦截所有请求，拦截器只拦截action请求