SpringBoot攔截器及原始碼分析

1、攔截器是什麼

java裡的攔截器（Interceptor）是動態攔截Action呼叫的物件，它提供了一種機制可以使開發者在一個Action執行的前後執行一段程式碼，也可以在一個Action執行前阻止其執行，同時也提供了一種可以提取Action中可重用部分程式碼的方式。在AOP中，攔截器用於在某個方法或者欄位被訪問之前進行攔截，然後再之前或者之後加入某些操作。

上面的Action一般指的就是我們Controller層的介面。

2、自定義攔截器

一般自定義一個攔截器分為三步

（1）編寫一個攔截器實現HandlerInterceptor介面。

（2）攔截器註冊到容器中。

（3）配置攔截規則。

2.1 編寫攔截器

我們新建一個SpringBoot專案，然後自定義一個攔截器LoginInterceptor，攔截未登入狀態下的某些請求。JDK1.8開始，介面的方法加上default關鍵字可以有預設實現，所以實現一個介面只需要實現沒有加該關鍵字的方法。

import lombok.extern.slf4j.Slf4j;

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

/**

 * 登入攔截器

 */

@Slf4j

public class LoginInterceptor implements HandlerInterceptor {

    /**

     * 目標方法執行之前執行

     * @param request

     * @param response

     * @param handler

     * @return

     * @throws Exception

     */

    @Override

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        // 獲取請求路徑

        String requestUrl = request.getRequestURI();

        log.info("請求的路徑是: {}", requestUrl);

        String username = request.getParameter("username");

        if (username != null) {

            // 放行

            return true;

        }

        request.setAttribute("msg", "請先登入");

        // 攜帶msg跳轉到登入頁

        request.getRequestDispatcher("/").forward(request, response);

        return false;

    }

    /**

     * 目標方法完成以後執行

     * @param request

     * @param response

     * @param handler

     * @param modelAndView

     * @throws Exception

     */

    @Override

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

        log.info("postHandle執行");

    }

    /**

     * 頁面渲染以後執行

     * @param request

     * @param response

     * @param handler

     * @param ex

     * @throws Exception

     */

    @Override

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

        log.info("afterCompletion執行");

    }

}

2.2 註冊和配置攔截器

在SpringBoot中，我們需要自定義配置的時候，只需要實現WebMvcConfigurer類重寫對應的方法即可。這裡我們需要配置攔截器，那麼重寫它的addInterceptors方法即可。

import com.codeliu.interceptor.LoginInterceptor;

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 WebMvcConfig implements WebMvcConfigurer {

    @Override

    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(new LoginInterceptor())

                .addPathPatterns("/**")  // 攔截所有路徑

                .excludePathPatterns("/","/login","/css/**","/fonts/**","/images/**","/js/**");  // 不攔截這些路徑

    }

}

注意如果我們配置了攔截所有的路徑，那麼一定要排除掉靜態資源，不然圖片樣式都會被攔截。

通過上面幾步，我們就實現了一個給系統加了一個攔截器。啟動驗證即可。

3、攔截器原理

我們通過打斷點除錯的方法，看看從瀏覽器請求開始到後端是如何進行處理的。在DispatcherServlet的doDispatch方法打上斷點，這是請求的入口，瀏覽器傳送請求後，由此方法進行轉發和處理。

debug模式啟動應用，訪問任意介面，跟蹤程式碼流程

3.1 找到可以處理請求的handler以及handler的所有攔截器

這裡找到了HandlerExecutionChain以及攔截器鏈，裡面有三個攔截器，我們自定義的LoginInterceptor和系統預設的兩個攔截器。

3.2 執行攔截器的preHandle方法

在doDispatch方法中，有下面兩行程式碼

// 執行攔截器的preHandle方法，如果返回為fasle，則直接return，不執行目標方法

if (!mappedHandler.applyPreHandle(processedRequest, response)) {

    return;

}

// 反射執行目標方法

mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

我們進入applyPreHandle方法，看看該方法的邏輯

/**

 * Apply preHandle methods of registered interceptors.

 * @return {@code true} if the execution chain should proceed with the

 * next interceptor or the handler itself. Else, DispatcherServlet assumes

 * that this interceptor has already dealt with the response itself.

 */

boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {

    // 遍歷攔截器

    for (int i = 0; i < this.interceptorList.size(); i++) {

        HandlerInterceptor interceptor = this.interceptorList.get(i);

        // 執行當前攔截器的preHandle方法

        if (!interceptor.preHandle(request, response, this.handler)) {

            // 如果preHandle方法返回為false，則執行當前攔截器的afterCompletion方法

            triggerAfterCompletion(request, response, null);

            return false;

        }

        // 記錄當前攔截器的下標

        this.interceptorIndex = i;

    }

    return true;

}

通過上面的程式碼，我們知道如果當前攔截器的preHandle方法返回為true，則會繼續執行下一攔截器的preHandle方法，否則執行攔截器的afterCompletion方法。

那麼我們看看triggerAfterCompletion方法的邏輯。

/**

 * Trigger afterCompletion callbacks on the mapped HandlerInterceptors.

 * Will just invoke afterCompletion for all interceptors whose preHandle invocation

 * has successfully completed and returned true.

 */

void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) {

    // 反向遍歷攔截器

    for (int i = this.interceptorIndex; i >= 0; i--) {

        HandlerInterceptor interceptor = this.interceptorList.get(i);

        try {

            // 執行當前攔截器的afterCompletion方法

            interceptor.afterCompletion(request, response, this.handler, ex);

        }

        catch (Throwable ex2) {

            logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);

        }

    }

}

通過上面的程式碼，我們知道對於攔截器的afterCompletion方法，是反向執行的。

3.3 執行目標方法

如果上面攔截器的所有preHandle方法返回都為true，那麼在doDispatch方法內就不會直接return，而是繼續往下執行目標方法。如果任何一個攔截器的preHandle方法返回為false，那麼執行完攔截器（已經執行過preHandle方法的攔截器）的afterCompletion方法後，在doDispatch方法內會直接return，不會執行目標方法。

通過下面的程式碼執行目標方法

// Actually invoke the handler.

mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

內部具體怎麼執行的就不看了，看看執行完後的邏輯。

3.4 執行攔截器的postHandle方法

目標方法執行完後，程式碼往下走

mappedHandler.applyPostHandle(processedRequest, response, mv);

檢視applyPostHandle的邏輯

/**

 * Apply postHandle methods of registered interceptors.

 */

void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv)

    throws Exception {

	// 反向遍歷

    for (int i = this.interceptorList.size() - 1; i >= 0; i--) {

        HandlerInterceptor interceptor = this.interceptorList.get(i);

        // 執行當前攔截器的postHandle方法

        interceptor.postHandle(request, response, this.handler, mv);

    }

}

倒序執行攔截器的postHandle方法

3.5 執行攔截器的afterCompletion方法

繼續往下走

processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);

進入該方法，該方法會處理執行結果，渲染頁面，該方法的最後，執行下面的程式碼

3.6 異常處理

如果在執行doDispatch方法過程中，丟擲了異常，在catch模組，都會觸發執行afterCompletion方法

4、總結

上面的過程，大概可以總結為以下幾步：

（1）根據當前請求，找到可以處理請求的handler和handler的所有攔截器。

（2）順序執行所有攔截器的preHandle方法

如果當前攔截器的preHandle方法返回為true，則執行下一攔截器的preHandle方法。
如果當前攔截器返回為false，倒序執行所有已經執行了的攔截器的afterCompletion。

（3）如果任何一個攔截器返回false，執行返回，不執行目標方法。

（4）所有攔截器都返回true，執行目標方法。

（5）倒序執行所有攔截器的postHandle方法。

（6）前面的步驟有任何異常都會觸發倒序執行afterCompletion方法。

（7）頁面成功渲染後，也會倒序執行afterCompletion方法。

SpringBoot攔截器及原始碼分析