在Web應(yīng)用中，過(guò)濾器（Filter）是一個(gè)強(qiáng)大的工具，它可以在請(qǐng)求到達(dá)目標(biāo)資源之前或響應(yīng)返回客戶端之前對(duì)請(qǐng)求或響應(yīng)進(jìn)行攔截和處理。然而，在某些情況下，我們可能希望確保過(guò)濾器邏輯在一次完整的HTTP請(qǐng)求中僅執(zhí)行一次，即使請(qǐng)求在服務(wù)器內(nèi)部經(jīng)過(guò)了多次轉(zhuǎn)發(fā)（forward）或包含多個(gè)資源請(qǐng)求。Spring框架的OncePerRequestFilter就是為了滿足這一需求而設(shè)計(jì)的。

一、OncePerRequestFilter 概述

OncePerRequestFilter是Spring提供的一個(gè)過(guò)濾器基類(lèi)，它確保了在一次完整的HTTP請(qǐng)求中，無(wú)論請(qǐng)求經(jīng)過(guò)多少次內(nèi)部轉(zhuǎn)發(fā)，過(guò)濾器的邏輯都只會(huì)被執(zhí)行一次。這對(duì)于需要在請(qǐng)求處理之前或之后進(jìn)行一次性設(shè)置或清理資源的場(chǎng)景特別有用。

二、OncePerRequestFilter 的原理

OncePerRequestFilter通過(guò)內(nèi)部使用HttpServletRequest的getAttribute和setAttribute方法，以及一個(gè)ThreadLocal變量來(lái)跟蹤當(dāng)前請(qǐng)求是否已經(jīng)被處理過(guò)。當(dāng)請(qǐng)求首次進(jìn)入過(guò)濾器時(shí)，OncePerRequestFilter會(huì)檢查是否已經(jīng)存在一個(gè)與當(dāng)前請(qǐng)求關(guān)聯(lián)的標(biāo)記。如果不存在，則執(zhí)行過(guò)濾器的邏輯，并將一個(gè)標(biāo)記與當(dāng)前請(qǐng)求關(guān)聯(lián)起來(lái)；如果已經(jīng)存在，則直接跳過(guò)過(guò)濾器的邏輯。

三、OncePerRequestFilter 的使用

要使用OncePerRequestFilter，你需要?jiǎng)?chuàng)建一個(gè)類(lèi)并繼承它，然后重寫(xiě)doFilterInternal方法。doFilterInternal方法是實(shí)際執(zhí)行過(guò)濾器邏輯的地方。

下面是一個(gè)簡(jiǎn)單的示例，展示了一個(gè)自定義的OncePerRequestFilter，它在請(qǐng)求到達(dá)目標(biāo)資源之前記錄請(qǐng)求的開(kāi)始時(shí)間，并在響應(yīng)返回客戶端之前記錄請(qǐng)求的處理時(shí)間：

import org.springframework.web.filter.OncePerRequestFilter;  
import javax.servlet.FilterChain;  
import javax.servlet.ServletException;  
import javax.servlet.http.HttpServletRequest;  
import javax.servlet.http.HttpServletResponse;  
import java.io.IOException;  
  
public class TimingFilter extends OncePerRequestFilter {  
  
    @Override  
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)  
            throws ServletException, IOException {  
          
        // 記錄請(qǐng)求開(kāi)始時(shí)間  
        long startTime = System.currentTimeMillis();  
          
        // 繼續(xù)過(guò)濾器鏈  
        filterChain.doFilter(request, response);  
          
        // 記錄請(qǐng)求處理時(shí)間  
        long endTime = System.currentTimeMillis();  
        long duration = endTime - startTime;  
        System.out.println("Request took " + duration + " ms to process");  
    }  
}

四、注冊(cè) OncePerRequestFilter

要將自定義的OncePerRequestFilter注冊(cè)到Spring應(yīng)用中，你可以使用Java配置或XML配置。在Java配置中，你可以創(chuàng)建一個(gè)FilterRegistrationBean的Bean來(lái)注冊(cè)你的過(guò)濾器：

import org.springframework.boot.web.servlet.FilterRegistrationBean;  
import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Configuration;  
  
@Configuration  
public class FilterConfig {  
  
    @Bean  
    public FilterRegistrationBean<TimingFilter> timingFilterRegistration() {  
        FilterRegistrationBean<TimingFilter> registration = new FilterRegistrationBean<>();  
        registration.setFilter(new TimingFilter());  
        registration.addUrlPatterns("/*"); // 設(shè)置過(guò)濾器攔截的URL模式  
        return registration;  
    }  
}

五、總結(jié)

OncePerRequestFilter是Spring框架中一個(gè)非常有用的工具，它可以幫助你在一次完整的HTTP請(qǐng)求中僅執(zhí)行一次過(guò)濾器的邏輯。通過(guò)繼承OncePerRequestFilter并重寫(xiě)doFilterInternal方法，你可以輕松地創(chuàng)建自定義的過(guò)濾器來(lái)處理各種需求。無(wú)論是在記錄請(qǐng)求處理時(shí)間、設(shè)置請(qǐng)求屬性、進(jìn)行權(quán)限驗(yàn)證等方面，OncePerRequestFilter都能為你提供強(qiáng)大的支持。

參考文獻(xiàn)：

• https://springdoc.cn/spring-onceperrequestfilter/

到此這篇關(guān)于Spring過(guò)濾器中OncePerRequestFilter應(yīng)用實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Spring OncePerRequestFilter內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！ 

最新評(píng)論