SpringBoot攔截器以及源碼詳析

第SpringBoot攔截器以及源碼詳析目錄1、攔截器是什么2、自定義攔截器2.1編寫攔截器2.2注冊和配置攔截器3、攔截器原理3.1找到可以處理請求的handler以及handler的所有攔截器3.2執(zhí)行攔截器的preHandle方法3.3執(zhí)行目標(biāo)方法3.4執(zhí)行攔截器的postHandle方法3.5執(zhí)行攔截器的afterCompletion方法3.6異常處理4、總結(jié)

1、攔截器是什么

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

上面的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)鍵字的方法。

importlombok.extern.slf4j.Slf4j;

importorg.springframework.web.servlet.HandlerInterceptor;

importorg.springframework.web.servlet.ModelAndView;

importjavax.servlet.http.HttpServletRequest;

importjavax.servlet.http.HttpServletResponse;

*登錄攔截器

@Slf4j

publicclassLoginInterceptorimplementsHandlerInterceptor{

*目標(biāo)方法執(zhí)行之前執(zhí)行

*@paramrequest

*@paramresponse

*@paramhandler

*@return

*@throwsException

@Override

publicbooleanpreHandle(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler)throwsException{

//獲取請求路徑

StringrequestUrl=request.getRequestURI();

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

Stringusername=request.getParameter("username");

if(username!=null){

//放行

returntrue;

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

//攜帶msg跳轉(zhuǎn)到登錄頁

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

returnfalse;

*目標(biāo)方法完成以后執(zhí)行

*@paramrequest

*@paramresponse

*@paramhandler

*@parammodelAndView

*@throwsException

@Override

publicvoidpostHandle(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler,ModelAndViewmodelAndView)throwsException{

("postHandle執(zhí)行");

*頁面渲染以后執(zhí)行

*@paramrequest

*@paramresponse

*@paramhandler

*@paramex

*@throwsException

@Override

publicvoidafterCompletion(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler,Exceptionex)throwsException{

("afterCompletion執(zhí)行");

2.2注冊和配置攔截器

在SpringBoot中，我們需要自定義配置的時候，只需要實現(xiàn)WebMvcConfigurer類重寫對應(yīng)的方法即可。這里我們需要配置攔截器，那么重寫它的addInterceptors方法即可。

importerceptor.LoginInterceptor;

importorg.springframework.context.annotation.Configuration;

importorg.springframework.web.servlet.config.annotation.InterceptorRegistry;

importorg.springframework.web.servlet.config.annotation.WebMvcConfigurer;

//表示這是一個配置類

@Configuration

publicclassWebMvcConfigimplementsWebMvcConfigurer{

@Override

publicvoidaddInterceptors(InterceptorRegistryregistry){

registry.addInterceptor(newLoginInterceptor())

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

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

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

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

3、攔截器原理

我們通過打斷點調(diào)試的方法，看看從瀏覽器請求開始到后端是如何進(jìn)行處理的。在DispatcherServlet的doDispatch方法打上斷點，這是請求的入口，瀏覽器發(fā)送請求后，由此方法進(jìn)行轉(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());

我們進(jìn)入applyPreHandle方法，看看該方法的邏輯

*ApplypreHandlemethodsofregisteredinterceptors.

*@return{@codetrue}iftheexecutionchainshouldproceedwiththe

*nextinterceptororthehandleritself.Else,DispatcherServletassumes

*thatthisinterceptorhasalreadydealtwiththeresponseitself.

booleanapplyPreHandle(HttpServletRequestrequest,HttpServletResponseresponse)throwsException{

//遍歷攔截器

for(inti=0;ierceptorList.size();i++){

HandlerInterceptorinterceptor=erceptorList.get(i);

//執(zhí)行當(dāng)前攔截器的preHandle方法

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

//如果preHandle方法返回為false，則執(zhí)行當(dāng)前攔截器的afterCompletion方法

triggerAfterCompletion(request,response,null);

returnfalse;

//記錄當(dāng)前攔截器的下標(biāo)

erceptorIndex=i;

returntrue;

通過上面的代碼，我們知道如果當(dāng)前攔截器的preHandle方法返回為true，則會繼續(xù)執(zhí)行下一攔截器的preHandle方法，否則執(zhí)行攔截器的afterCompletion方法。

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

*TriggerafterCompletioncallbacksonthemappedHandlerInterceptors.

*WilljustinvokeafterCompletionforallinterceptorswhosepreHandleinvocation

*hassuccessfullycompletedandreturnedtrue.

voidtriggerAfterCompletion(HttpServletRequestrequest,HttpServletResponseresponse,@NullableExceptionex){

//反向遍歷攔截器

for(inti=erceptorIndex;ii--){

HandlerInterceptorinterceptor=erceptorList.get(i);

try{

//執(zhí)行當(dāng)前攔截器的afterCompletion方法

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

catch(Throwableex2){

logger.error("HandlerInterceptor.afterCompletionthrewexception",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)方法

//Actuallyinvokethehandler.

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

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

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

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

mappedHandler.applyPostHandle(processedRequest,response,mv);

查看applyPostHandle的邏輯

*ApplypostHandlemethodsofregisteredinterceptors.

voidapplyPostHandle(HttpServletRequestrequest,HttpServletResponseresponse,@NullableModelAndViewmv)

throwsException{

//反向遍歷

for(inti=erceptorList.size()-1;ii--){

HandlerInterceptorinterceptor=erceptorList.get(i);

//執(zhí)行當(dāng)前攔截器的postHandle方法

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

倒