SpringBoot拦截器源码分析

魁首哥

作者

SpringBoot拦截器源码分析

本文小编为大家详细介绍“SpringBoot拦截器源码分析”，内容详细，步骤清晰，细节处理妥当，希望这篇“SpringBoot拦截器源码分析”文章能帮助大家解决疑惑，下面跟着小编的思路慢慢深入，一起来学习新知识吧。

1、拦截器是什么

java里的拦截器（Interceptor）是动态拦截Action调用的对象，它提供了一种机制可以使开发者在一个Action执行的前后执行一段代码，也可以在一个Action执行前阻止其执行，同时也提供了一种可以提取Action中可重用部分代码的方式。在AOP中，拦截器用于在某个方法或者字段被访问之前进行拦截，然后再之前或者之后加入某些操作。

上面的Action一般指的就是我们Controller层的接口。

2、自定义拦截器

一般自定义一个拦截器分为三步

（1）编写一个拦截器实现HandlerInterceptor接口。

（2）拦截器注册到容器中。

（3）配置拦截规则。

2.1 编写拦截器

我们新建一个SpringBoot项目，然后自定义一个拦截器LoginInterceptor，拦截未登录状态下的某些请求。JDK1.8开始，接口的方法加上default关键字可以有默认实现，所以实现一个接口只需要实现没有加该关键字的方法。

importlombok.extern.slf4j.Slf4j;importorg.springframework.web.servlet.HandlerInterceptor;importorg.springframework.web.servlet.ModelAndView;importjavax.servlet.http.HttpServletRequest;importjavax.servlet.http.HttpServletResponse;/***登录拦截器*/@Slf4jpublicclassLoginInterceptorimplementsHandlerInterceptor{/***目标方法执行之前执行*@paramrequest*@paramresponse*@paramhandler*@return*@throwsException*/@OverridepublicbooleanpreHandle(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler)throwsException{//获取请求路径StringrequestUrl=request.getRequestURI();log.info("请求的路径是:{}",requestUrl);Stringusername=request.getParameter("username");if(username!=null){//放行returntrue;}request.setAttribute("msg","请先登录");//携带msg跳转到登录页request.getRequestDispatcher("/").forward(request,response);returnfalse;}/***目标方法完成以后执行*@paramrequest*@paramresponse*@paramhandler*@parammodelAndView*@throwsException*/@OverridepublicvoidpostHandle(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler,ModelAndViewmodelAndView)throwsException{log.info("postHandle执行");}/***页面渲染以后执行*@paramrequest*@paramresponse*@paramhandler*@paramex*@throwsException*/@OverridepublicvoidafterCompletion(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler,Exceptionex)throwsException{log.info("afterCompletion执行");}}

2.2 注册和配置拦截器

在SpringBoot中，我们需要自定义配置的时候，只需要实现WebMvcConfigurer类重写对应的方法即可。这里我们需要配置拦截器，那么重写它的addInterceptors方法即可。

importcom.codeliu.interceptor.LoginInterceptor;importorg.springframework.context.annotation.Configuration;importorg.springframework.web.servlet.config.annotation.InterceptorRegistry;importorg.springframework.web.servlet.config.annotation.WebMvcConfigurer;//表示这是一个配置类@ConfigurationpublicclassWebMvcConfigimplementsWebMvcConfigurer{@OverridepublicvoidaddInterceptors(InterceptorRegistryregistry){registry.addInterceptor(newLoginInterceptor()).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方法，看看该方法的逻辑

/***ApplypreHandlemethodsofregisteredinterceptors.*@return{@codetrue}iftheexecutionchainshouldproceedwiththe*nextinterceptororthehandleritself.Else,DispatcherServletassumes*thatthisinterceptorhasalreadydealtwiththeresponseitself.*/booleanapplyPreHandle(HttpServletRequestrequest,HttpServletResponseresponse)throwsException{//遍历拦截器for(inti=0;i<this.interceptorList.size();i++){HandlerInterceptorinterceptor=this.interceptorList.get(i);//执行当前拦截器的preHandle方法if(!interceptor.preHandle(request,response,this.handler)){//如果preHandle方法返回为false，则执行当前拦截器的afterCompletion方法triggerAfterCompletion(request,response,null);returnfalse;}//记录当前拦截器的下标this.interceptorIndex=i;}returntrue;}

通过上面的代码，我们知道如果当前拦截器的preHandle方法返回为true，则会继续执行下一拦截器的preHandle方法，否则执行拦截器的afterCompletion方法。

那么我们看看triggerAfterCompletion方法的逻辑。

/***TriggerafterCompletioncallbacksonthemappedHandlerInterceptors.*WilljustinvokeafterCompletionforallinterceptorswhosepreHandleinvocation*hassuccessfullycompletedandreturnedtrue.*/voidtriggerAfterCompletion(HttpServletRequestrequest,HttpServletResponseresponse,@NullableExceptionex){//反向遍历拦截器for(inti=this.interceptorIndex;i>=0;i--){HandlerInterceptorinterceptor=this.interceptorList.get(i);try{//执行当前拦截器的afterCompletion方法interceptor.afterCompletion(request,response,this.handler,ex);}catch(Throwableex2){logger.error("HandlerInterceptor.afterCompletionthrewexception",ex2);}}}

通过上面的代码，我们知道对于拦截器的afterCompletion方法，是反向执行的。

3.3 执行目标方法

如果上面拦截器的所有preHandle方法返回都为true，那么在doDispatch方法内就不会直接return，而是继续往下执行目标方法。如果任何一个拦截器的preHandle方法返回为false，那么执行完拦截器（已经执行过preHandle方法的拦截器）的afterCompletion方法后，在doDispatch方法内会直接return，不会执行目标方法。

通过下面的代码执行目标方法

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

内部具体怎么执行的就不看了，看看执行完后的逻辑。

3.4 执行拦截器的postHandle方法

目标方法执行完后，代码往下走

mappedHandler.applyPostHandle(processedRequest,response,mv);

查看applyPostHandle的逻辑

/***ApplypostHandlemethodsofregisteredinterceptors.*/voidapplyPostHandle(HttpServletRequestrequest,HttpServletResponseresponse,@NullableModelAndViewmv)throwsException{//反向遍历for(inti=this.interceptorList.size()-1;i>=0;i--){HandlerInterceptorinterceptor=this.interceptorList.get(i);//执行当前拦截器的postHandle方法interceptor.postHandle(request,response,this.handler,mv);}}

倒序执行拦截器的postHandle方法