Springboot项目实现过滤器功能-526互联

核心类

Filter

Filter接口的全限定类名是javax.servlet.Filter，该接口有三个方法，分别是

1、init(...)：用于初始化Filter；

2、doFilter(...)：过滤请求和拦截响应信息的具体实现在这个方法里；

3、destroy(...)：Filter对象被销毁时触发，主要用于做一些收尾工作，如资源的释放等；

FilterConfig

FilterConfig接口的全限定类名是javax.servlet.FilterConfig，该接口主要有四个方法，分别是：

1、getFilterName() 获取Filter的名字；

2、getServletContext() 获取ServletContext对象（即application）；

3、getInitParameter() 获取Filter的初始化参数；

4、getInitParameterNames() 获取所有初始化参数的名字；

FilterChain

FilterChainr接口的全限定类名是javax.servlet.FilterChain，该接口只有一个方法，是doFilter()方法，用于调用Filter链上的下一个过滤器，如果当前过滤器为最后一个或只有一个过滤器，则该过滤器则将请求发送到目标资源。

MyFilter2是自己实现的过滤器，实现了Filter接口；Filter接口依赖FilterChain接口和FilterConfig接口，其中FilterChain接口的实现类是org.apache.catalina.core.ApplicationFilterChain，FilterConfig接口的实现类是org.apache.catalina.core.ApplicationFilterConfig；

实现方式

Springboot项目中一般有两种方式：

1、@WebFilter注解，即javax.servlet.annotation.WebFilter；

2、FilterRegistrationBean，即org.springframework.boot.web.servlet.FilterRegistrationBean；

两种方式，都需要在启动类上增加注解@ServletComponentScan，用于开启servlet相关bean的扫描，其中包含有过滤器（Filter）；

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

代码实现

1、WebFilter注解里，定义一下过滤器的名字，以及要对哪些请求进行过滤，“/*”表示对所有的请求都过滤，在实际业务中，可具体对待；

如果在初始化的时候，需要携带一些初始化的参数，可以在initParams属性上，使用@WebInitParam注解来定义初始化参数名称和具体的值，这些参数可以在filter对象初始化的时候获取到；

MyFIlter1和MyFIlter2使用的注解方式定义的过滤器；

@Slf4j
@WebFilter(filterName = "myFilter1", urlPatterns = "/*", initParams = {@WebInitParam(name = "creator", value = "fanfu")})
public class MyFilter1 implements Filter {
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("//myFilter1初始化开始");
        String creator = filterConfig.getInitParameter("creator");
        log.info("//初始化参数creator:{}",creator);
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("//myFilter1开始执行");
        chain.doFilter(request, response);
        log.info("//myFilter1结束执行");
    }
 
    @Override
    public void destroy() {
        log.info("//myfilter1被销毁");
    }
}

@Slf4j
@WebFilter(filterName = "myFilter2", urlPatterns = "/*")
public class MyFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("//myFilter2初始化开始");
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("//myFilter2开始执行");
        chain.doFilter(request, response);
        log.info("//myFilter2结束执行");
    }
 
    @Override
    public void destroy() {
        log.info("//myFilter2被销毁");
    }
}

2、FilterRegistrationBean方式

在Springboot项目的配置类中，使用FilterRegistrationBean来包装自定义的过滤器，这种方式的最大好处就是可以自定义过滤器的执行顺序，数字越小，执行时的优先级就越高；MyFIlter3和MyFIlter4是使用FilterRegistrationBean方式定义的过滤器；

@Configuration
public class WebConfig {
 
    @Bean
    public FilterRegistrationBean filterRegistration1() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new MyFilter3());
        filterRegistrationBean.addUrlPatterns("/*");//定义过滤器对哪些请求路径进行过滤，/*表示对所有请求都过滤
        filterRegistrationBean.setOrder(2);//定义过滤器的执行优先级，数据越小优先级越高
        return filterRegistrationBean;
    }
 
    @Bean
    public FilterRegistrationBean filterRegistration2() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new MyFilter4());
        filterRegistrationBean.addUrlPatterns("/*");
        filterRegistrationBean.setOrder(1);
        return filterRegistrationBean;
    }
}

@Slf4j
public class MyFilter3 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    log.info("//MyFilter3初始化开始");
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("//MyFilter3开始执行");
        chain.doFilter(request,response);
        log.info("//MyFilter3结束执行");
    }
 
    @Override
    public void destroy() {
        log.info("//MyFilter3被销毁");
    }
}

@Slf4j
public class MyFilter4 implements Filter {
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("//MyFilter4初始化开始");
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("//MyFilter4开始执行");
        chain.doFilter(request,response);
        log.info("//MyFilter4结束执行");
    }
 
    @Override
    public void destroy() {
        log.info("//MyFilter4被销毁");
    }
}

未定义myFilter3、myFilter4的执行优先级，即采取自然排序时的执行结果：在请求前myFilter3的执行时机早于myFilter4，响应后myFilter3的执行时机要晚于myFilter4；