探秘Spring攔截器的實作原理

揭秘Spring攔截器的實作機制

引言

#在開發Web應用程式時，我們經常需要在請求到達控制器之前或之後進行某些操作。例如，驗證使用者身分、記錄日誌、處理異常等等。 Spring框架為我們提供了攔截器（Interceptor）來實現這些操作，攔截器能夠對請求和回應進行預處理和後處理。

本文將深入探究Spring攔截器的實作機制。我們將了解攔截器的概念、工作原理，並透過具體的程式碼範例來演示如何實作自訂攔截器。

攔截器的概念

攔截器是Spring框架中用來對請求進行預處理和後處理的一種機制。它類似於Servlet中的過濾器，但與過濾器不同的是，攔截器是基於方法層級的。它能夠攔截到指定Controller中的方法，在方法執行之前和之後執行自訂邏輯。攔截器可以幫助我們實現一些與業務邏輯無關的通用處理，提高程式碼的複用性和可維護性。

攔截器的工作原理

攔截器是透過AOP（面向切面程式設計）實現的。 Spring攔截器基於HandlerInterceptor接口，該介面定義了三個方法：preHandle、postHandle和afterCompletion。具體工作流程如下：

1. 當客戶端發送請求到達DispatcherServlet時，DispatcherServlet會根據請求的URL找到對應的HandlerMapping，取得對應的HandlerExecutionChain。
2. HandlerExecutionChain中包含了一系列的HandlerInterceptor。

3. DispatcherServlet會依序呼叫每個攔截器的preHandle方法，並檢查方法的回傳值。

   • 如果傳回true，請求繼續處理並進入下一個攔截器的preHandle方法。
   • 如果傳回false，請求將在此處中斷，並傳回給客戶端。
4. 當所有的攔截器的preHandle方法都回傳true時，DispatcherServlet會呼叫HandlerExecutionChain中的Handler物件的handleRequest方法。
5. HandlerExecutionChain中的Handler物件執行業務邏輯，並傳回ModelAndView。
6. DispatcherServlet會依序呼叫每個攔截器的postHandle方法，並將ModelAndView傳遞給它們。
7. 攔截器的postHandle方法可以對ModelAndView進行修改和增強。
8. DispatcherServlet將ModelAndView傳遞給ViewResolver進行視圖解析與渲染。
9. 當視圖渲染完畢後，DispatcherServlet會依序呼叫每個攔截器的afterCompletion方法，進一步進行一些資源的清理操作。

自訂攔截器的實作

下面透過一個具體的範例來示範如何實作自訂攔截器。

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //  在方法执行之前进行逻辑处理
        System.out.println("拦截器preHandle方法执行");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在方法执行之后进行逻辑处理
        System.out.println("拦截器postHandle方法执行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在视图渲染完成后进行逻辑处理
        System.out.println("拦截器afterCompletion方法执行");
    }
}

在以上程式碼中，我們實作了HandlerInterceptor接口，並重寫了其中的三個方法。在preHandle方法中，我們可以進行一些前置處理；在postHandle方法中，我們可以對ModelAndView進行修改和增強；在afterCompletion方法中，我們可以進行一些資源的清理操作。

接下來，我們需要將自訂攔截器配置到Spring容器中。可以透過XML配置或註解方式實現。

XML設定的方式

在Spring的設定檔中加入以下設定：

<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**" />
        <mvc:exclude-mapping path="/login" />
        <bean class="com.example.MyInterceptor" />
    </mvc:interceptor>
</mvc:interceptors>

在上述設定中，我們使用<interceptor></interceptor>標籤來定義攔截器，並透過<mapping></mapping>標籤指定要攔截的URL路徑。使用<exclude-mapping></exclude-mapping>標籤來排除一些不需要攔截的URL路徑。

註解方式設定攔截器

在攔截器類別上加上@Component註解，並使用@Order註解指定攔截器的執行順序。

@Component
@Order(1)
public class MyInterceptor implements HandlerInterceptor {
    // 省略代码
}

在Spring的配置類別中添加以下配置：

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private MyInterceptor myInterceptor;
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor).addPathPatterns("/**").excludePathPatterns("/login");
    }
}

在以上配置中，我們透過實作WebMvcConfigurer接口，並重寫其中的addInterceptors方法，將攔截器新增到攔截器註冊表中。

結論

透過本文，我們了解了Spring攔截器的概念和工作原理，並透過具體的程式碼範例示範如何實作自訂攔截器。攔截器是Spring框架中非常重要的特性，可以幫助我們實現一些通用的處理邏輯，提高程式碼的復用性和可維護性。希望本文對您對Spring攔截器的了解有所幫助。

以上是探秘Spring攔截器的實作原理的詳細內容。更多資訊請關注PHP中文網其他相關文章！