Springboot项目快速实现过滤器功能

Myth丶恋晨 2024-03-25 21:44 60阅读 0赞

## **前言** ##

很多时候，当你以为掌握了事实真相的时间，如果你能再深入一点，你可能会发现另外一些真相。比如面向切面编程的最佳编程实践是AOP，AOP的主要作用就是可以定义切入点，并在切入点纵向织入一些额外的统一操作，避免与业务代码过度耦合。熟悉java web项目的都知道，另外还有过滤器（filter）、拦截器（interceptor）也有类似AOP的功能特性，那么问题来了：为什么一般说面向切面编程就是指AOP，而不是过滤器和拦截器？过滤器和拦截器在Spring boot中怎么实现？这三者之间有什么区别？[Springboot项目快速实现Aop功能][Springboot_Aop]中分享了AOP的相关实现，下面将再用两到三篇文章，分别和大家分享一下过滤器、拦截器的实现，以及AOP、过滤器、拦截器之间的横向对比，以便在业务开发中，能够快速、正确选对具体实现方法。

## **环境配置** ##

jdk版本:1.8

开发工具：Intellij iDEA 2020.1

springboot:2.3.9.RELEASE

## **Filter简介** ##

Filter， 中文意思是过滤器，Filter的全限定类名是javax.servlet.Filter，可以看出这是与servelt相关的一个接口；SpringMVC核心是DispatcherServlet，而DispatcherServlet又继承了Servlet，进而可以推测出Filter与SpringMVC也是关联关系。

![4c5f20cb2ec040988741d3e4052b0bb0.png][]

事实上这样的推测也是正确的，在SpringMVC项目中，filter在浏览器与服务器之间起过滤的作用，可以截取客户端和服务端之间的请求和响应信息，并根据这些请求-响应信息作一些其他的操作，但是要注意，filter并不能改变请求-响应信息；

## **核心类** ##

### **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；

![1a611c4e42dd4646a32fe7fb0b9f3bba.png][]

## **工作原理** ##

1、项目启动的时候，先执行Filter的构造方法，完成相关Filter对象的注册；

2、紧接着，Filter对象的init()方法被调用，开始对Filter做一些初始化操作；

3、项目启动完成后，客户端每次向服务端发起请求时，如果请求地址与过滤器定义的地址匹配，则会执行Filter的doFilter()；如果匹配上多个过滤器，则会形成一个链路，依次调用各个过滤器对象的doFilter()；服务端作出响应后，也会再次执行到各个过滤器对象的doFilter()；请求和响应时，过滤器链的执行顺序是先进后出；

4、服务器停止时调用Filter的destroy()方法，用来释放资源。

![36028a6509d84b81820135464e9be279.png][]

## **实现方式** ##

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；

![56166d4faedd4771baf581ad09c260b5.png][]

定义myFilter4的优先级高于myFilter3时，执行结果：在请求前myFilter4的执行时机早于myFilter3，响应后的myFilter4的执行时机要晚于myFilter3；

![8e02fea9f513495db29b31f06b866d7d.png][]

## **总结** ##

过滤器的实现是比较简单，通过梳理这个过程，我get到以下几个点：

1、过滤器是用于SpringMVC项目中，即与servlet相关的项目；

2、过滤器的执行时机是在请求前和响应后，有两种实现方式，即@WebFilter注解和FilterRegistrationBean；如果对过滤器的执行顺序没有限制要求，则可以使用第一种；如果对过滤器的执行顺序有明确限制，则可以使用第二种；

3、如果有多个过滤器对象时，会形成一个过滤器链，过滤器的执行顺序是先进后出；

4、过滤器可以过滤请求和拦截响应，但是不能改变请求值和响应值；

[Springboot_Aop]: https://blog.csdn.net/fox9916/article/details/129654377
[4c5f20cb2ec040988741d3e4052b0bb0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/79a7fbfc885b47a3b68844b02f4b884f.png
[1a611c4e42dd4646a32fe7fb0b9f3bba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f9228efe22004b4fa3e2af34085f02b5.png
[36028a6509d84b81820135464e9be279.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/c81910cb82ab482bb65d2816ef9f2e53.png
[56166d4faedd4771baf581ad09c260b5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/9e409ba870e342e299a6e60efe071e91.png
[8e02fea9f513495db29b31f06b866d7d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/04ce669858384d6cb5532b9fd2099df4.png