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关键字可以有默认实现，所以实现一个接口只需要实现没有加该关键字的方法。

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;@Slf4jpublic class LoginInterceptor implements HandlerInterceptor {        @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;    }        @Override    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {        log.info("postHandle执行");    }        @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;// 表示这是一个配置类@Configurationpublic class WebMvcConfig implements WebMvcConfigurer {    @Override    public void addInterceptors(InterceptorRegistry registry) {        registry.addInterceptor(new LoginInterceptor())                .addPathPatterns("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方法的逻辑。

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的逻辑

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方法

读到这里，这篇“SpringBoot拦截器源码分析”文章已经介绍完毕，想要掌握这篇文章的知识点还需要大家自己动手实践使用过才能领会，如果想了解更多相关内容的文章，欢迎关注编程网精选频道。