Springboot項目快速實現(xiàn)過濾器功能

更新時間：2023年03月28日 08:57:15 作者：凡夫販夫

上篇文章已經(jīng)給大家介紹了Springboot項目如何快速實現(xiàn)Aop功能，這篇文章給大家介紹Springboot項目如何快速實現(xiàn)過濾器功能，感興趣的小伙伴可以參考閱讀

前言

很多時候，當你以為掌握了事實真相的時間，如果你能再深入一點，你可能會發(fā)現(xiàn)另外一些真相。比如面向切面編程的最佳編程實踐是AOP，AOP的主要作用就是可以定義切入點，并在切入點縱向織入一些額外的統(tǒng)一操作，避免與業(yè)務代碼過度耦合。熟悉java web項目的都知道，另外還有過濾器（filter）、攔截器（interceptor）也有類似AOP的功能特性，那么問題來了：為什么一般說面向切面編程就是指AOP，而不是過濾器和攔截器？過濾器和攔截器在Spring boot中怎么實現(xiàn)？這三者之間有什么區(qū)別？Springboot項目快速實現(xiàn)Aop功能中分享了AOP的相關實現(xiàn)，下面將再用兩到三篇文章，分別和大家分享一下過濾器、攔截器的實現(xiàn)，以及AOP、過濾器、攔截器之間的橫向對比，以便在業(yè)務開發(fā)中，能夠快速、正確選對具體實現(xiàn)方法。

環(huán)境配置

jdk版本:1.8

開發(fā)工具：Intellij iDEA 2020.1

springboot:2.3.9.RELEASE

Filter簡介

Filter，中文意思是過濾器，F(xiàn)ilter的全限定類名是javax.servlet.Filter，可以看出這是與servelt相關的一個接口；SpringMVC核心是DispatcherServlet，而DispatcherServlet又繼承了Servlet，進而可以推測出Filter與SpringMVC也是關聯(lián)關系。

事實上這樣的推測也是正確的，在SpringMVC項目中，filter在瀏覽器與服務器之間起過濾的作用，可以截取客戶端和服務端之間的請求和響應信息，并根據(jù)這些請求-響應信息作一些其他的操作，但是要注意，filter并不能改變請求-響應信息；

核心類

Filter

Filter接口的全限定類名是javax.servlet.Filter，該接口有三個方法，分別是

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

2、doFilter(...)：過濾請求和攔截響應信息的具體實現(xiàn)在這個方法里；

3、destroy(...)：Filter對象被銷毀時觸發(fā)，主要用于做一些收尾工作，如資源的釋放等；

FilterConfig

FilterConfig接口的全限定類名是javax.servlet.FilterConfig，該接口主要有四個方法，分別是：

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

2、getServletContext() 獲取ServletContext對象（即application）；

3、getInitParameter() 獲取Filter的初始化參數(shù)；

4、getInitParameterNames() 獲取所有初始化參數(shù)的名字；

FilterChain

FilterChainr接口的全限定類名是javax.servlet.FilterChain，該接口只有一個方法，是doFilter()方法，用于調用Filter鏈上的下一個過濾器，如果當前過濾器為最后一個或只有一個過濾器，則該過濾器則將請求發(fā)送到目標資源。

MyFilter2是自己實現(xiàn)的過濾器，實現(xiàn)了Filter接口；Filter接口依賴FilterChain接口和FilterConfig接口，其中FilterChain接口的實現(xiàn)類是org.apache.catalina.core.ApplicationFilterChain，F(xiàn)ilterConfig接口的實現(xiàn)類是org.apache.catalina.core.ApplicationFilterConfig；

工作原理

1、項目啟動的時候，先執(zhí)行Filter的構造方法，完成相關Filter對象的注冊；

2、緊接著，F(xiàn)ilter對象的init()方法被調用，開始對Filter做一些初始化操作；

3、項目啟動完成后，客戶端每次向服務端發(fā)起請求時，如果請求地址與過濾器定義的地址匹配，則會執(zhí)行Filter的doFilter()；如果匹配上多個過濾器，則會形成一個鏈路，依次調用各個過濾器對象的doFilter()；服務端作出響應后，也會再次執(zhí)行到各個過濾器對象的doFilter()；請求和響應時，過濾器鏈的執(zhí)行順序是先進后出；

4、服務器停止時調用Filter的destroy()方法，用來釋放資源。

實現(xiàn)方式

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);
    }
}

代碼實現(xiàn)

1、WebFilter注解里，定義一下過濾器的名字，以及要對哪些請求進行過濾，“/*”表示對所有的請求都過濾，在實際業(yè)務中，可具體對待；如果在初始化的時候，需要攜帶一些初始化的參數(shù)，可以在initParams屬性上，使用@WebInitParam注解來定義初始化參數(shù)名稱和具體的值，這些參數(shù)可以在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("http://myFilter1初始化開始");
        String creator = filterConfig.getInitParameter("creator");
        log.info("http://初始化參數(shù)creator:{}",creator);
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("http://myFilter1開始執(zhí)行");
        chain.doFilter(request, response);
        log.info("http://myFilter1結束執(zhí)行");
    }
 
    @Override
    public void destroy() {
        log.info("http://myfilter1被銷毀");
    }
}

@Slf4j
@WebFilter(filterName = "myFilter2", urlPatterns = "/*")
public class MyFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("http://myFilter2初始化開始");
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("http://myFilter2開始執(zhí)行");
        chain.doFilter(request, response);
        log.info("http://myFilter2結束執(zhí)行");
    }
 
    @Override
    public void destroy() {
        log.info("http://myFilter2被銷毀");
    }
}

2、FilterRegistrationBean方式

在Springboot項目的配置類中，使用FilterRegistrationBean來包裝自定義的過濾器，這種方式的最大好處就是可以自定義過濾器的執(zhí)行順序，數(shù)字越小，執(zhí)行時的優(yōu)先級就越高；MyFIlter3和MyFIlter4是使用FilterRegistrationBean方式定義的過濾器；

@Configuration
public class WebConfig {
 
    @Bean
    public FilterRegistrationBean filterRegistration1() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new MyFilter3());
        filterRegistrationBean.addUrlPatterns("/*");//定義過濾器對哪些請求路徑進行過濾，/*表示對所有請求都過濾
        filterRegistrationBean.setOrder(2);//定義過濾器的執(zhí)行優(yōu)先級，數(shù)據(jù)越小優(yōu)先級越高
        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("http://MyFilter3初始化開始");
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("http://MyFilter3開始執(zhí)行");
        chain.doFilter(request,response);
        log.info("http://MyFilter3結束執(zhí)行");
    }
 
    @Override
    public void destroy() {
        log.info("http://MyFilter3被銷毀");
    }
}

@Slf4j
public class MyFilter4 implements Filter {
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("http://MyFilter4初始化開始");
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("http://MyFilter4開始執(zhí)行");
        chain.doFilter(request,response);
        log.info("http://MyFilter4結束執(zhí)行");
    }
 
    @Override
    public void destroy() {
        log.info("http://MyFilter4被銷毀");
    }
}

未定義myFilter3、myFilter4的執(zhí)行優(yōu)先級，即采取自然排序時的執(zhí)行結果：在請求前myFilter3的執(zhí)行時機早于myFilter4，響應后myFilter3的執(zhí)行時機要晚于myFilter4；