在springboot工程中使用filter

Posted 2021-03-07 程序晓猿

在springboot工程中使用filter

一、什么是filter

过滤器实际上就是用来对web资源进行拦截，做一些处理后再交给下一个过滤器或servlet处理 通常都是用来拦截request进行处理的，也可以对返回的response进行拦截处理 。

filter可以在请求到达servlet前或者请求完成响应后进行后续的处理。

二、在springboot工程中使用filter

1. 创建一个filter,并使用注解配置该filter的名称和拦截路径等属性

@WebFilter(filterName = "AFilter",urlPatterns = "/*")
public class AFilter implements Filter {
    public void destroy() {
    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        System.out.println("AFilter 开始执行");
        chain.doFilter(req, resp);
        System.out.println("AFilter 执行完成");
    }

    public void init(FilterConfig config) throws ServletException {

    }

}

上面的代码在doFilter方法中写该过滤器的具体执行逻辑,chain.doFilter用来把请求交给下一个过滤器或者servlet。

1. 在启动类上使用注解@ServletComponentScan来扫描自定义的过滤器

@SpringBootApplication
@ServletComponentScan
public class BillAdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(BillAdminApplication.class,args);
    }
}

这样自定义的过滤器就会被扫描到,就可以起作用。

三、过滤器的执行顺序

如果项目中配置了多个过滤器，并且使用的是注解配置,请求到来时过滤器名称字母顺序靠前的过滤器会先执行；给客户端返回响应时过滤器的执行顺序和请求时的相反。

四、注意

使用以上这种方式来加载自定义过滤器时，不能自定义过滤器的执行顺序,只能通过限定类名顺序来达到目的。

五、使用FilterRegistrationBean 来注册过滤器

当需要自定义过滤器的执行顺序时，可以使用FilterRegistrationBean来实现。

先创建一个过滤器，比如上边的AFilter.java,不再需要注解@WebFilter,

再启动类或者配置类中注入一个如下的bean

@Bean
    public FilterRegistrationBean registrationBean1(){
        FilterRegistrationBean filterRegistrationBean=new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new AFilter());
        filterRegistrationBean.addUrlPatterns("/*");
        filterRegistrationBean.setOrder(2);
        return filterRegistrationBean;
    }

使用这种方式，创建一个filterRegistrationBean对象，再设置其相关属性,可以通过order属性来设置过滤器的执行顺序，order值越小表示过滤器的优先级越高，会先执行。