SpringBoot攔截器源碼分析

本文小編為大家詳細(xì)介紹“SpringBoot攔截器源碼分析”，內(nèi)容詳細(xì)，步驟清晰，細(xì)節(jié)處理妥當(dāng)，希望這篇“SpringBoot攔截器源碼分析”文章能幫助大家解決疑惑，下面跟著小編的思路慢慢深入，一起來學(xué)習(xí)新知識吧。

1、攔截器是什么

java里的攔截器（Interceptor）是動態(tài)攔截Action調(diào)用的對象，它提供了一種機制可以使開發(fā)者在一個Action執(zhí)行的前后執(zhí)行一段代碼，也可以在一個Action執(zhí)行前阻止其執(zhí)行，同時也提供了一種可以提取Action中可重用部分代碼的方式。在AOP中，攔截器用于在某個方法或者字段被訪問之前進行攔截，然后再之前或者之后加入某些操作。

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

2、自定義攔截器

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

（1）編寫一個攔截器實現(xiàn)HandlerInterceptor接口。

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

（3）配置攔截規(guī)則。

2.1 編寫攔截器

我們新建一個SpringBoot項目，然后自定義一個攔截器LoginInterceptor，攔截未登錄狀態(tài)下的某些請求。JDK1.8開始，接口的方法加上default關(guān)鍵字可以有默認(rèn)實現(xiàn)，所以實現(xiàn)一個接口只需要實現(xiàn)沒有加該關(guān)鍵字的方法。

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 {
    /**
     * 目標(biāo)方法執(zhí)行之前執(zhí)行
     * @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跳轉(zhuǎn)到登錄頁
        request.getRequestDispatcher("/").forward(request, response);
        return false;
    }

    /**
     * 目標(biāo)方法完成以后執(zhí)行
     * @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執(zhí)行");
    }

    /**
     * 頁面渲染以后執(zhí)行
     * @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執(zhí)行");
    }
}

2.2 注冊和配置攔截器

在SpringBoot中，我們需要自定義配置的時候，只需要實現(xiàn)WebMvcConfigurer類重寫對應(yīng)的方法即可。這里我們需要配置攔截器，那么重寫它的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/**");  // 不攔截這些路徑
    }
}

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

通過上面幾步，我們就實現(xiàn)了一個給系統(tǒng)加了一個攔截器。啟動驗證即可。

3、攔截器原理

我們通過打斷點調(diào)試的方法，看看從瀏覽器請求開始到后端是如何進行處理的。在DispatcherServlet的doDispatch方法打上斷點，這是請求的入口，瀏覽器發(fā)送請求后，由此方法進行轉(zhuǎn)發(fā)和處理。

debug模式啟動應(yīng)用，訪問任意接口，跟蹤代碼流程

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

這里找到了HandlerExecutionChain以及攔截器鏈，里面有三個攔截器，我們自定義的LoginInterceptor和系統(tǒng)默認(rèn)的兩個攔截器。

3.2 執(zhí)行攔截器的preHandle方法

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

// 執(zhí)行攔截器的preHandle方法，如果返回為fasle，則直接return，不執(zhí)行目標(biāo)方法
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
    return;
}

// 反射執(zhí)行目標(biāo)方法
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);
        // 執(zhí)行當(dāng)前攔截器的preHandle方法
        if (!interceptor.preHandle(request, response, this.handler)) {
            // 如果preHandle方法返回為false，則執(zhí)行當(dāng)前攔截器的afterCompletion方法
            triggerAfterCompletion(request, response, null);
            return false;
        }
        // 記錄當(dāng)前攔截器的下標(biāo)
        this.interceptorIndex = i;
    }
    return true;
}

通過上面的代碼， 我們知道如果當(dāng)前攔截器的preHandle方法返回為true，則會繼續(xù)執(zhí)行下一攔截器的preHandle方法，否則執(zhí)行攔截器的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 {
            // 執(zhí)行當(dāng)前攔截器的afterCompletion方法
            interceptor.afterCompletion(request, response, this.handler, ex);
        }
        catch (Throwable ex2) {
            logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
        }
    }
}

通過上面的代碼，我們知道對于攔截器的afterCompletion方法，是反向執(zhí)行的。

3.3 執(zhí)行目標(biāo)方法

如果上面攔截器的所有preHandle方法返回都為true，那么在doDispatch方法內(nèi)就不會直接return，而是繼續(xù)往下執(zhí)行目標(biāo)方法。如果任何一個攔截器的preHandle方法返回為false，那么執(zhí)行完攔截器（已經(jīng)執(zhí)行過preHandle方法的攔截器）的afterCompletion方法后，在doDispatch方法內(nèi)會直接return，不會執(zhí)行目標(biāo)方法。

通過下面的代碼執(zhí)行目標(biāo)方法

// Actually invoke the handler.
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

內(nèi)部具體怎么執(zhí)行的就不看了，看看執(zhí)行完后的邏輯。

3.4 執(zhí)行攔截器的postHandle方法

目標(biāo)方法執(zhí)行完后，代碼往下走

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);
        // 執(zhí)行當(dāng)前攔截器的postHandle方法
        interceptor.postHandle(request, response, this.handler, mv);
    }
}

倒序執(zhí)行攔截器的postHandle方法

3.5 執(zhí)行攔截器的afterCompletion方法

繼續(xù)往下走

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

進入該方法，該方法會處理執(zhí)行結(jié)果，渲染頁面，該方法的最后，執(zhí)行下面的代碼

3.6 異常處理

如果在執(zhí)行doDispatch方法過程中，拋出了異常，在catch模塊，都會觸發(fā)執(zhí)行afterCompletion方法

讀到這里，這篇“SpringBoot攔截器源碼分析”文章已經(jīng)介紹完畢，想要掌握這篇文章的知識點還需要大家自己動手實踐使用過才能領(lǐng)會，如果想了解更多相關(guān)內(nèi)容的文章，歡迎關(guān)注億速云行業(yè)資訊頻道。