Spring 框架中攔截器與過濾器的區(qū)別及攔截器使用詳解

在 Spring 框架的開發(fā)過程中，攔截器和過濾器都是非常重要的組件，它們都可以對(duì)請(qǐng)求進(jìn)行攔截和處理，但在實(shí)現(xiàn)原理、應(yīng)用場(chǎng)景等方面存在明顯差異。本文將深入剖析兩者的區(qū)別，并通過詳細(xì)的代碼示例介紹 Spring 攔截器的使用步驟。

一、攔截器與過濾器的區(qū)別

1.1 所屬體系與運(yùn)行環(huán)境

• 過濾器（Filter）：是 Servlet 規(guī)范的一部分，由 Web 容器（如 Tomcat）管理，在 Servlet 容器啟動(dòng)時(shí)加載，不依賴 Spring 框架，可獨(dú)立于 Spring 運(yùn)行 。例如，在傳統(tǒng)的 Servlet 項(xiàng)目中，也可以使用過濾器進(jìn)行請(qǐng)求處理。

• 攔截器（Interceptor）：是 Spring 框架的組件，依托于 Spring 容器，只有在 Spring 環(huán)境下才能發(fā)揮作用。它隨著 Spring 容器的啟動(dòng)而初始化，在 Spring MVC 的請(qǐng)求處理流程中發(fā)揮作用。

1.2 攔截范圍

• 過濾器：可以攔截所有進(jìn)入 Web 容器的請(qǐng)求，包括靜態(tài)資源（如 CSS、JS 文件）請(qǐng)求和 Servlet 請(qǐng)求。例如，對(duì)所有請(qǐng)求進(jìn)行統(tǒng)一的字符編碼設(shè)置，就可以使用過濾器實(shí)現(xiàn)。

• 攔截器：僅針對(duì) Spring MVC 的 Controller 請(qǐng)求生效，對(duì)靜態(tài)資源等非 Controller 請(qǐng)求不起作用。比如，當(dāng)我們只想對(duì)業(yè)務(wù)接口進(jìn)行權(quán)限校驗(yàn)時(shí)，攔截器就更合適。

1.3 執(zhí)行時(shí)機(jī)與方法

• 過濾器：通過實(shí)現(xiàn)Filter接口，重寫init、doFilter和destroy方法來完成功能。doFilter方法在請(qǐng)求到達(dá) Servlet 之前被調(diào)用，主要用于請(qǐng)求的預(yù)處理，如設(shè)置請(qǐng)求頭、修改請(qǐng)求參數(shù)等 。

• 攔截器：實(shí)現(xiàn)HandlerInterceptor接口，有三個(gè)關(guān)鍵方法：

• preHandle：在 Controller 方法調(diào)用前執(zhí)行，返回true表示繼續(xù)執(zhí)行后續(xù)流程，返回false則中斷請(qǐng)求 。

• postHandle：在 Controller 方法調(diào)用后、視圖渲染前執(zhí)行，可以對(duì) ModelAndView 進(jìn)行修改 。

• afterCompletion：在整個(gè)請(qǐng)求完成后執(zhí)行，常用于資源清理、記錄日志等操作 。

1.4 功能與靈活性

• 過濾器：功能相對(duì)基礎(chǔ)，主要用于處理一些通用的、與業(yè)務(wù)邏輯無關(guān)的操作，如解決跨域問題、設(shè)置請(qǐng)求編碼格式等。

• 攔截器：功能更為強(qiáng)大和靈活，能更精細(xì)地控制請(qǐng)求處理流程，可在請(qǐng)求處理的不同階段介入，適合處理與業(yè)務(wù)邏輯相關(guān)的操作，如權(quán)限驗(yàn)證、性能監(jiān)控等。

二、Spring 攔截器使用步驟

• 接下來，以 Spring Boot 項(xiàng)目為例，詳細(xì)介紹攔截器的使用方法，并提供完整的代碼示例。

2.1 創(chuàng)建攔截器類

• 創(chuàng)建一個(gè)實(shí)現(xiàn)HandlerInterceptor接口的類，并重寫三個(gè)核心方法。這里創(chuàng)建一個(gè)簡(jiǎn)單的權(quán)限驗(yàn)證攔截器AuthInterceptor：

//被掃描
@Component
public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle Interceptor");
//        return可返回兩種值  ： true  攔截放行   false  攔截不放行
        //判斷用戶是否登錄，獲取Session中存的會(huì)話
        Object username = request.getSession().getAttribute("username");
        //username == null  說明username未存入會(huì)話，用戶沒有登錄
        if (username != null){
            System.out.println("已登錄");
            return true;
        }
        //向前端發(fā)出響應(yīng)
        response.getWriter().write("notlogin");
        return false;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle Interceptor");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion Interceptor");
    }
}

2.2 配置攔截器

• 創(chuàng)建一個(gè)配置類，實(shí)現(xiàn)WebMvcConfigurer接口，重寫addInterceptors方法來注冊(cè)攔截器，并指定攔截路徑和排除路徑。

@Configuration
@EnableWebMvc
public class SpringMvc implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;
//    攔截器攔截路徑和排除路徑
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor).addPathPatterns("/api");
    }
}

2.3 測(cè)試攔截器

• 創(chuàng)建一個(gè)簡(jiǎn)單的 Controller 用于測(cè)試攔截器的效果

@RestController
@RequestMapping("/api")
public class apiController {
    @GetMapping
    public String login() {
        System.out.println("Controller！");
        return "登錄成功";
    }

三、總結(jié)

過濾器和攔截器在 Spring 開發(fā)中各有優(yōu)勢(shì)，過濾器適用于處理通用的請(qǐng)求處理任務(wù)，而攔截器更適合與業(yè)務(wù)邏輯緊密相關(guān)的操作。掌握它們的區(qū)別和使用方法，能幫助我們更高效地開發(fā)健壯、可維護(hù)的 Web 應(yīng)用。

到此這篇關(guān)于Spring 框架中攔截器與過濾器的區(qū)別及攔截器使用詳解的文章就介紹到這了,更多相關(guān)Spring攔截器與過濾器區(qū)別內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論