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

SpringBoot攔截器及源碼分析

1、攔截器是什麼

2、自定義攔截器

2.1 編寫攔截器

2.2 注冊和配置攔截器

3、攔截器原理

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

3.2 執行攔截器的preHandle方法

3.3 執行目标方法

3.4 執行攔截器的postHandle方法

3.5 執行攔截器的afterCompletion方法

3.6 異常處理

4、總結

繼續閱讀

nginx安裝、前後端分離部署流程1. 筆記資料來源2. Nginx簡介3. Nginx 常用指令4. Nginx配置5. 前後端分離配置

微人事項目學習之權限管理

Error —— Unsatisfied dependency expressed through field ‘baseMapper‘問題解決

Spring Cloud 之Hystrix熔斷器、Hystrix-Dashboard可視化監控中心

RabbitMQ：MessageConverter消息轉換器

第一個SpringBoot程式以及定制啟動時的banner圖案第一個SpringBoot程式

springboot2整合ActiveMQ

SpringBoot——日志檔案設定

微人事學習筆記（持續更新）登入頁面服務端登入接口制作前後端接口對接Home頁面制作前後端分離權限管理思路探讨權限管理：後端接口設計基礎資訊設定頁面

首次阿裡雲部署學生級web服務

Spring Boot：靜态資源

jeecg-boot的shiro認證過程2. jwtFilter

SpringSecurity整合短信驗證碼認證

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

springboot使用 swagger-ui 2.10.5 有關版本更新帶來的問題

spring boot @SpringBootApplication @EnableAutoConfiguration 的工作原理