怎么在Springboot實現攔截器功能

怎么在Spring Boot實現攔截器功能

在Spring Boot中，攔截器（Interceptor）是一種非常有用的機制，它允許我們在請求處理之前或之后執行一些自定義的邏輯。攔截器通常用于處理諸如日志記錄、權限驗證、請求參數處理等任務。本文將詳細介紹如何在Spring Boot中實現攔截器功能。

1. 什么是攔截器？

攔截器是Spring MVC框架中的一種組件，它可以在請求到達控制器之前或之后執行一些操作。與過濾器（Filter）不同，攔截器是基于Spring MVC的，因此它可以訪問Spring的上下文和依賴注入。

2. 創建攔截器

要創建一個攔截器，我們需要實現HandlerInterceptor接口。這個接口定義了三個方法：

• preHandle：在請求處理之前調用。如果返回true，則繼續執行后續的攔截器和控制器；如果返回false，則中斷請求處理。
• postHandle：在請求處理之后、視圖渲染之前調用。
• afterCompletion：在請求完成之后調用，通常用于資源清理。

下面是一個簡單的攔截器示例：

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在請求處理之前執行
        System.out.println("Pre Handle method is Calling");
        return true; // 繼續執行后續的攔截器和控制器
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在請求處理之后、視圖渲染之前執行
        System.out.println("Post Handle method is Calling");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在請求完成之后執行
        System.out.println("After Completion method is Calling");
    }
}

3. 注冊攔截器

創建好攔截器后，我們需要將其注冊到Spring Boot應用中。這可以通過實現WebMvcConfigurer接口并重寫addInterceptors方法來完成。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private CustomInterceptor customInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(customInterceptor)
                .addPathPatterns("/**") // 攔截所有路徑
                .excludePathPatterns("/public/**"); // 排除特定路徑
    }
}

在上面的代碼中，我們通過addInterceptor方法將自定義的攔截器添加到攔截器注冊表中，并通過addPathPatterns和excludePathPatterns方法來指定攔截器作用的路徑。

4. 測試攔截器

現在，我們可以啟動Spring Boot應用并測試攔截器的功能。當我們訪問應用的任何路徑時，攔截器的preHandle、postHandle和afterCompletion方法將會被調用，并在控制臺中輸出相應的日志信息。

例如，訪問http://localhost:8080/hello時，控制臺輸出可能如下：

Pre Handle method is Calling
Post Handle method is Calling
After Completion method is Calling

5. 攔截器的應用場景

攔截器在Spring Boot應用中有廣泛的應用場景，以下是一些常見的例子：

• 日志記錄：在請求處理前后記錄請求的詳細信息，如URL、請求參數、響應狀態等。
• 權限驗證：在請求處理之前檢查用戶是否具有訪問特定資源的權限。
• 請求參數處理：在請求到達控制器之前對請求參數進行預處理或驗證。
• 性能監控：記錄請求的處理時間，用于性能分析和優化。

6. 總結

通過本文的介紹，我們了解了如何在Spring Boot中實現攔截器功能。攔截器是一種強大的工具，可以幫助我們在請求處理的不同階段執行自定義邏輯。通過合理地使用攔截器，我們可以提高應用的可維護性和擴展性。

希望本文對你理解和使用Spring Boot攔截器有所幫助！如果你有任何問題或建議，歡迎在評論區留言。