本文小編為大家詳細(xì)介紹“SpringBoot攔截器源碼分析”，內(nèi)容詳細(xì)，步驟清晰，細(xì)節(jié)處理妥當(dāng)，希望這篇“SpringBoot攔截器源碼分析”文章能幫助大家解決疑惑，下面跟著小編的思路慢慢深入，一起來學(xué)習(xí)新知識(shí)吧。
創(chuàng)新互聯(lián)公司專注于嶗山網(wǎng)站建設(shè)服務(wù)及定制，我們擁有豐富的企業(yè)做網(wǎng)站經(jīng)驗(yàn)。 熱誠為您提供嶗山營銷型網(wǎng)站建設(shè)，嶗山網(wǎng)站制作、嶗山網(wǎng)頁設(shè)計(jì)、嶗山網(wǎng)站官網(wǎng)定制、微信小程序開發(fā)服務(wù)，打造嶗山網(wǎng)絡(luò)公司原創(chuàng)品牌,更為您提供嶗山網(wǎng)站排名全網(wǎng)營銷落地服務(wù)。
java里的攔截器（Interceptor）是動(dòng)態(tài)攔截Action調(diào)用的對(duì)象，它提供了一種機(jī)制可以使開發(fā)者在一個(gè)Action執(zhí)行的前后執(zhí)行一段代碼，也可以在一個(gè)Action執(zhí)行前阻止其執(zhí)行，同時(shí)也提供了一種可以提取Action中可重用部分代碼的方式。在AOP中，攔截器用于在某個(gè)方法或者字段被訪問之前進(jìn)行攔截，然后再之前或者之后加入某些操作。
上面的Action一般指的就是我們Controller層的接口。
一般自定義一個(gè)攔截器分為三步
（1）編寫一個(gè)攔截器實(shí)現(xiàn)HandlerInterceptor接口。
（2）攔截器注冊(cè)到容器中。
（3）配置攔截規(guī)則。
我們新建一個(gè)SpringBoot項(xiàng)目，然后自定義一個(gè)攔截器LoginInterceptor，攔截未登錄狀態(tài)下的某些請(qǐng)求。JDK1.8開始，接口的方法加上default關(guān)鍵字可以有默認(rèn)實(shí)現(xiàn)，所以實(shí)現(xiàn)一個(gè)接口只需要實(shí)現(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 {
// 獲取請(qǐng)求路徑
String requestUrl = request.getRequestURI();
log.info("請(qǐng)求的路徑是: {}", requestUrl);
String username = request.getParameter("username");
if (username != null) {
// 放行
return true;
}
request.setAttribute("msg", "請(qǐng)先登錄");
// 攜帶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í)行");
}
}在SpringBoot中，我們需要自定義配置的時(shí)候，只需要實(shí)現(xiàn)WebMvcConfigurer類重寫對(duì)應(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;
// 表示這是一個(gè)配置類
@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)資源，不然圖片樣式都會(huì)被攔截。
通過上面幾步，我們就實(shí)現(xiàn)了一個(gè)給系統(tǒng)加了一個(gè)攔截器。啟動(dòng)驗(yàn)證即可。
我們通過打斷點(diǎn)調(diào)試的方法，看看從瀏覽器請(qǐng)求開始到后端是如何進(jìn)行處理的。在DispatcherServlet的doDispatch方法打上斷點(diǎn)，這是請(qǐng)求的入口，瀏覽器發(fā)送請(qǐng)求后，由此方法進(jìn)行轉(zhuǎn)發(fā)和處理。
debug模式啟動(dòng)應(yīng)用，訪問任意接口，跟蹤代碼流程
這里找到了HandlerExecutionChain以及攔截器鏈，里面有三個(gè)攔截器，我們自定義的LoginInterceptor和系統(tǒng)默認(rèn)的兩個(gè)攔截器。
在doDispatch方法中，有下面兩行代碼
// 執(zhí)行攔截器的preHandle方法，如果返回為fasle，則直接return，不執(zhí)行目標(biāo)方法
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
return;
}
// 反射執(zhí)行目標(biāo)方法
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());我們進(jìn)入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，則會(huì)繼續(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);
}
}
}通過上面的代碼，我們知道對(duì)于攔截器的afterCompletion方法，是反向執(zhí)行的。
如果上面攔截器的所有preHandle方法返回都為true，那么在doDispatch方法內(nèi)就不會(huì)直接return，而是繼續(xù)往下執(zhí)行目標(biāo)方法。如果任何一個(gè)攔截器的preHandle方法返回為false，那么執(zhí)行完攔截器（已經(jīng)執(zhí)行過preHandle方法的攔截器）的afterCompletion方法后，在doDispatch方法內(nèi)會(huì)直接return，不會(huì)執(zhí)行目標(biāo)方法。
通過下面的代碼執(zhí)行目標(biāo)方法
// Actually invoke the handler. mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
內(nèi)部具體怎么執(zhí)行的就不看了，看看執(zhí)行完后的邏輯。
目標(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方法
繼續(xù)往下走
processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
進(jìn)入該方法，該方法會(huì)處理執(zhí)行結(jié)果，渲染頁面，該方法的最后，執(zhí)行下面的代碼
如果在執(zhí)行doDispatch方法過程中，拋出了異常，在catch模塊，都會(huì)觸發(fā)執(zhí)行afterCompletion方法
讀到這里，這篇“SpringBoot攔截器源碼分析”文章已經(jīng)介紹完畢，想要掌握這篇文章的知識(shí)點(diǎn)還需要大家自己動(dòng)手實(shí)踐使用過才能領(lǐng)會(huì)，如果想了解更多相關(guān)內(nèi)容的文章，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。
