SpringBoot 自定义过滤器 Filter

简介

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

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

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

Filter工作原理

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

自定义过滤器(方法一)

1. 实现Filter

/**
 * Created by liusj on 2019/6/24
 */
@Log
public class MyFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("过滤器 == MyFilter == init");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        log.info("过滤器 == MyFilter == before");
        filterChain.doFilter(servletRequest,servletResponse);
        log.info("过滤器 == MyFilter == after");
    }

    @Override
    public void destroy() {
        log.info("过滤器 == MyFilter == destroy");
    }
}

2. 配置过滤器

@Configuration
public class FilterConfig {

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

自定义过滤器(方法二)

通过注解配置过滤器

/**
 * Created by liusj on 2019/6/24
 */
@Configuration// 将此Filter交给Spring容器管理
@WebFilter(urlPatterns = "/", filterName = "MyFilter2")
@Order(1)// 指定过滤器的执行顺序，值越大越靠后执行
@Log
public class MyFilter2 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("过滤器 == MyFilter2 == init");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        log.info("过滤器 == MyFilter2 == before");
        filterChain.doFilter(servletRequest,servletResponse);
        log.info("过滤器 == MyFilter2 == after");
    }

    @Override
    public void destroy() {
        log.info("过滤器 == MyFilter2 == destroy");
    }
}

测试

写个请求接口进行测试

@SpringBootApplication
@RestController
@Log
public class Application {

    @RequestMapping(value = "/")
    public String home() {
        log.info("接口请求");
        return "Hello Filter World";
    }

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

}

测试结果

image.png

代码地址：https://github.com/lbshold/springboot/blob/master/filter-demo.zip