淺析SpringBoot中過濾器配置與應(yīng)用場景

更新時間：2025年05月14日 10:46:56 作者：星辰聊技術(shù)

過濾器是 Web 三大組件之一,也是項目中常用的工具,這篇文章主要介紹一下過濾器的概念及在 Spring Boot 中的常用使用方法,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下

1. 什么是過濾器

過濾器是 Web 三大組件之一，也是項目中常用的工具。本文主要介紹過濾器的概念及在 Spring Boot 中的常用使用方法。

過濾器由 Servlet 提供，基于函數(shù)回調(diào)實現(xiàn)鏈?zhǔn)綄W(wǎng)絡(luò)請求和響應(yīng)的攔截與修改。由于基于 Servlet，幾乎可以攔截 Web 服務(wù)器管理的所有資源（JSP、圖片文件、HTML 文件、CSS 文件等）。

定義過濾器需要實現(xiàn)javax.servlet.Filter接口。過濾器不是 Servlet，無法直接生成對客戶端的響應(yīng)，只能攔截已有請求并預(yù)處理不需要或不一致的信息資源。

2. 過濾器流程原理

在 Web 應(yīng)用中，可以開發(fā)編寫多個過濾器，這些過濾器組合稱為過濾器鏈。用戶發(fā)起請求后，請求信息會按過濾器鏈中過濾器的順序依次進入每個過濾器。經(jīng)過每層過濾器時，需通過過濾器的校驗邏輯并放行才能進入下一層過濾器，直至服務(wù)器獲取資源。

服務(wù)器成功獲取資源并響應(yīng)過濾器后，會按反向順序經(jīng)過層層過濾器，最終響應(yīng)用戶。

3. 過濾器分類

Servlet 2.5:

REQUEST: 用戶直接訪問頁面時，WEB 容器會調(diào)用過濾器鏈。
FORWARD: 通過 RequestDispatcher 的 forward 訪問目標(biāo)資源時調(diào)用此過濾器。
INCLUDE: 通過 RequestDispatcher 的 include 方法調(diào)用目標(biāo)資源時調(diào)用。
ERROR: 通過聲明式異常處理機制調(diào)用目標(biāo)資源時調(diào)用過濾器鏈。

Servlet 3.0:

ASYNC: 支持異步處理。

4. 過濾器中需要實現(xiàn)的方法

public void doFilter(ServletRequest, ServletResponse, FilterChain): 實現(xiàn)實際過濾操作。當(dāng)客戶端請求方法與過濾器設(shè)置的 URL 匹配時，Servlet 容器會先調(diào)用過濾器的 doFilter 方法。FilterChain 用于訪問后續(xù)過濾器。

public void init(FilterConfig filterConfig): Web 應(yīng)用啟動時，Web 服務(wù)器創(chuàng)建過濾器實例對象并調(diào)用其 init 方法完成對象初始化（過濾器對象僅創(chuàng)建一次，init 方法僅執(zhí)行一次）。開發(fā)者可通過 init 方法參數(shù)執(zhí)行讀取配置文件等初始化操作。

public void destroy(): Servlet 容器銷毀過濾器實例前調(diào)用此方法。用于釋放過濾器占用的資源。

5. 創(chuàng)建過濾器的兩種方式

方法一：注解方式

創(chuàng)建步驟：

實現(xiàn)Filter接口，添加@WebFilter和@Order注解配置過濾器：

@Order(1)
@WebFilter(filterName = "myFilter", urlPatterns = {"*"})
public class MyCustomFilter1 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) {}

    @Override
    public void destroy() {}
}

在啟動類添加@ServletComponentScan注解：

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

方法二：將過濾器注冊為 Bean

創(chuàng)建步驟：

創(chuàng)建實現(xiàn) Filter 接口的過濾器類：

public class MyCustomFilter2 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain){}

    @Override
    public void destroy() {}
}

創(chuàng)建過濾器配置類，注冊過濾器：

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean customFilter(){
        FilterRegistrationBean<MyCustomFilter1> filterBean = new FilterRegistrationBean<>();
        filterBean.setFilter(new MyCustomFilter1());
        filterBean.setName("FilterController");
        filterBean.addUrlPatterns("/*");
        return filterBean;
    }
}

6. 注解方式的參數(shù)說明與使用示例

（1）參數(shù)說明

@WebFilter可配置多個參數(shù)，部分參數(shù)說明如下：

參數(shù)名稱	參數(shù)類型	參數(shù)描述
filterName	String	過濾器的名稱
displayName	String	要顯示的過濾器名稱
asyncSupported	boolean	設(shè)置過濾器是否支持異步模式
initParams	WebInitParam[]	你可以在初始化時配置一些參數(shù)
servletNames	String[]	設(shè)置要過濾的 Servlets
urlPatterns	String[]	指定要攔截的路徑
value	String[]	urlPatterns 屬性與 urlPatterns 屬性的作用相同，兩者都指定要攔截的路徑
dispatcherTypes	DispatcherType[]	設(shè)置過濾器過濾的請求類型，支持以下屬性：ASYNC, ERROR, FORWARD, INCLUDE, REQUEST（默認(rèn)情況下，它過濾所有類型的請求）

（2）使用示例

創(chuàng)建 Controller 類

@RestController
publicclass TestController {

    @GetMapping("/a/hello")
    public String hello1(){
        return"hello world! a";
    }

    @GetMapping("/b/hello")
    public String hello2(){
        return"hello world! b";
    }

    @GetMapping("/c/hello")
    public String hello3(){
        return"hello world! c";
    }
}

創(chuàng)建過濾器類

@Order(1)
@WebFilter(filterName = "myFilter", urlPatterns = {"/a/*", "/b/*"}, description = "自定義過濾器")
publicclass MyCustomFilter2 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) {
        System.out.println("過濾器初始化");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 
        throws IOException, ServletException {
        System.out.println("請求處理前...");
        chain.doFilter(request, response);  // 放行請求
        System.out.println("請求處理后...");
    }

    @Override
    public void destroy() {
        System.err.println("過濾器銷毀");
    }
}

創(chuàng)建啟動類

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

7. 過濾器注冊 Bean 方式的參數(shù)說明與使用示例

（1）方法參數(shù)說明

方法名稱	方法描述
setName()	設(shè)置過濾器的名稱。
setFilter()	設(shè)置要注冊的過濾器。
setOrder()	設(shè)置過濾器的順序位置。
setAsyncSupported()	設(shè)置過濾器是否支持異步模式。
addUrlPatterns()	添加攔截的路徑。
setUrlPatterns()	設(shè)置攔截的路徑。
addServletNames()	添加過濾器的 servlet 名稱。
setServletNames()	設(shè)置注冊過濾器的 servlet 名稱。
setInitParameters()	設(shè)置初始化參數(shù)。
addInitParameter()	添加初始化參數(shù)。
setMatchAfter()	設(shè)置是否在 Servlet 上下文中聲明的任何過濾器映射之后匹配過濾器映射。
setDispatcherTypes()	設(shè)置過濾器過濾的請求類型。支持的屬性如下：ASYNC, ERROR, FORWARD, INCLUDE, REQUEST（默認(rèn)情況下，它過濾所有類型的請求）。

（2）使用示例

創(chuàng)建 Controller 類

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
publicclass TestController {

    @GetMapping("/a/hello")
    public String hello1(){
        return"hello world! a";
    }

    @GetMapping("/b/hello")
    public String hello2(){
        return"hello world! b";
    }

    @GetMapping("/c/hello")
    public String hello3(){
        return"hello world! c";
    }

}

創(chuàng)建過濾器類

public class MyCustomFilter1 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) {
        System.out.println("過濾器初始化");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 
        throws IOException, ServletException {
        System.out.println("請求處理前...");
        chain.doFilter(request, response);  // 放行請求
        System.out.println("請求處理后...");
    }

    @Override
    public void destroy() {
        System.err.println("過濾器銷毀");
    }
}

創(chuàng)建過濾器配置類

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean customFilter(){
        FilterRegistrationBean<MyCustomFilter1> filterBean = new FilterRegistrationBean<>();
        filterBean.setFilter(new MyCustomFilter1());
        filterBean.setName("FilterController");
        filterBean.addUrlPatterns("/c/*","/b/*");
        return filterBean;
    }
}

創(chuàng)建啟動類

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
@ServletComponentScan
public class Application {

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

}