博客

1. 过滤器概念

过滤器作用是对客户端发送给 Servlet 的请求以及对 Servlet 返回给客户端的响应做一些定制化的处理，例如校验请求的参数、设置请求/响应的 Header、修改请求/响应的内容等。

Filter 引入了过滤链（Filter Chain）的概念，一个 Web 应用可以部署多个 Filter，这些 Filter 会组成一种链式结构，客户端的请求在到达 Servlet 之前会一直在这个链上传递，不同的 Filter 负责对请求/响应做不同的处理。 Filter 的处理流程如下图所示

2. 过滤器创建方式

2.1 @WebFilter注解+@ServletComponentScan注解

代码：

@WebFilter
@Slf4j
public class MyFilter implements Filter {
    @Autowired
    private TestService testService;

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("过滤器MyFilter过滤的:url{}",((HttpServletRequest)request).getRequestURI());
        log.info("TestServiceBEAN：{}存在",testService==null?"不":"");
        chain.doFilter(request,response);
    }
}

@ServletComponentScan的作用是自动装配BEAN——将@WebServlet、@WebFilter、@WebListener注解标注的类自动注册到Spring容器中。

2.2 手写配置类创建

配置类作用相当于@WebFilter注解

2.3 过滤器中注入BEAN失败问题

前面我们刚用配置类方式创建了一个filter，其中TestService这个BEAN通过@Autowired注入失败，这就是过滤器中无法获取BEAN说法的由来。其实此说法是不准确的，我们用注解方式创建的MyFilter过滤器不就成功注入了吗？

TestFilter过滤器中无法注入BEAN的原因是我们没有将TestFilter注册为BEAN。

/**
 *
 * OncePerRequestFilter继承自Filter的实现类GenericFilterBean,方法更丰富，推荐使用
 */
@Slf4j
@Component
public class TestFilter extends OncePerRequestFilter {

    @Autowired
    private TestService testService;

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        log.info("过滤器TestFilter过滤的:url{}",request.getRequestURI());
        log.info("TestServiceBEAN：{}存在",testService==null?"不":"");
        filterChain.doFilter(request,response);
    }
}

@Configuration
public class FilterConfig {

    @Autowired
    private TestFilter testFilter;

    @Bean
    public FilterRegistrationBean registFilter() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(testFilter);
        registration.addUrlPatterns("/mvc/*");
        registration.setOrder(1);
        return registration;
    }

}

我们也可以不写配置类

所以过滤器中无法获取IOC中的BEAN这种说法是错误的。值得注意的是，如果用仍new的方式在某些过滤器链配置（如security）中添加过滤器，那么访问此配置类不过滤路径时过滤器可以获取BEAN，访问配置类过滤路径无法获取BEAN。

2.4 @Component和@WebFilter同时使用导致重复过滤

出现上述问题的原因是：@WebFilter相当于将过滤器直接注入到了FilterRegistrationBean，而使用@Component是间接将过滤器注入到了FilterRegistrationBean，两种不同途径产生了两个重复的BEAN。