spring 过滤器 Filter

简介

依赖于servlet容器。在实现上基于函数回调，可以对几乎所有请求进行过滤，但是缺点是一个过滤器实例只能在容器初始化时调用一次。

使用过滤器的目的是用来做一些过滤操作，获取我们想要获取的数据。

WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如JSP，Servlet，静态图片文件或静态HTML文件进行拦截，从而实现一些特殊功能。例如实现URL级别的权限控制、过滤敏感词汇、压缩响应信息、过滤器中修改字符编码等一些高级功能。

Filter工作原理

当客户端发出Web资源的请求时，Web服务器根据应用程序配置文件设置的过滤规则进行检查，若客户请求满足过滤规则，则对客户请求／响应进行拦截，对请求头和请求数据进行检查或改动，并依次通过过滤器链，最后把请求／响应交给请求的Web资源处理。请求信息在过滤器链中可以被修改，也可以根据条件让请求不发往资源处理器，并直接向客户机发回一个响应。当资源处理器完成了对资源的处理后，响应信息将逐级逆向返回。同样在这个过程中，用户可以修改响应信息，从而完成一定的任务

常见问题

Web开发中，自定义过滤器被执行两次的原因分析。
导致原因：第一次打印的是我请求的Servlet，第二次打印的是/favicon.ico

1、@WebFilter配置Filter过滤器

@Configuration//将此Filter交给Spring容器管理
@WebFilter(urlPatterns = "/*", filterName = "logFilter2")
@Order(1)//指定过滤器的执行顺序,值越大越靠后执行
public class LogCostFilter2 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
    System.out.println("过滤器2-init");
}

@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    System.out.println("过滤器2-doFilter-前");
    long start = System.currentTimeMillis();
    filterChain.doFilter(servletRequest, servletResponse);
    System.out.println("LogFilter2 Execute cost=" + (System.currentTimeMillis() - start));
    System.out.println("过滤器2-doFilter-后");
}

@Override
public void destroy() {
    System.out.println("过滤器2-destroy");
}

}

2、FilterRegistrationBean配置Filter过滤器

public class LogCostFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
    System.out.println("过滤器1-init");
}

@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    System.out.println("过滤器1-doFilter-前");
    long start = System.currentTimeMillis();
    filterChain.doFilter(servletRequest,servletResponse);
    System.out.println("LogFilter1 Execute cost="+(System.currentTimeMillis()-start));
    System.out.println("过滤器1-doFilter-后");
}

@Override
public void destroy() {
    System.out.println("过滤器1-destroy");
}
}

使用FilterRegistrationBean来完成配置

@Configuration
public class FilterConfig {

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

}

测试用例

@GetMapping("/filter/{id}")
public void filter(@PathVariable("id") Long id) {
    System.out.println("Controller方法--前");
    UserEntity userEntity = userService.findUserById(id);
    System.out.println("Controller方法--后");
}

运行结构