Spring MVC 源码分析之 拦截器 Interceptor

一、前言

在 DispatcherServlet 中的 doDispatch 方法中，我们发现调用 getHandler() 方法返回的不是一个纯HandlerMethod，而是一个HandlerExecutionChain，这个是为啥呢？因为在执行 真正的处理方法前后，会执行一下默认拦截器或者自定义拦截器。接下来就慢慢的揭开她的面纱。

二、重温 doDispatch

首先在回顾一下 doDispatch 方法，请看源码

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
      //省略代码....
    try {
      //省略代码....
        try {
            //省略代码....

            // Determine handler for the current request.
            //获取Handler执行链
            mappedHandler = getHandler(processedRequest);

            //省略代码....
            //执行拦截器方法
            if (!mappedHandler.applyPreHandle(processedRequest, response)) {
                return;
            }

            // Actually invoke the handler.
            // 执行真实的处理方法
            mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
           //省略代码....
            applyDefaultViewName(processedRequest, mv);

            //执行拦截器方法
            mappedHandler.applyPostHandle(processedRequest, response, mv);
        }
        catch (Exception ex) {

        }catch (Throwable err) {

        }
        processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    }
    catch (Exception ex) {
        triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
    }catch (Throwable err) {
        triggerAfterCompletion(processedRequest, response, mappedHandler,
                new NestedServletException("Handler processing failed", err));
    }finally {
        if (asyncManager.isConcurrentHandlingStarted()) {
            // Instead of postHandle and afterCompletion
            if (mappedHandler != null) {
                mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
            }
        }else {

        }
    }
}

image.gif

主要代码说明：

1. mappedHandler = getHandler(processedRequest); 获取 HandlerExecutionChain 。
2. mappedHandler.applyPreHandle(processedRequest, response) 执行Handler的前置方法。
3. mv = ha.handle(processedRequest, response, mappedHandler.getHandler()); 执行真正的 处理方法
4. mappedHandler.applyPostHandle(processedRequest, response, mv); 执行拦击去的后置方法
5. triggerAfterCompletion(processedRequest, response, mappedHandler, ex); 执行拦截器的完成方法

三、拦截器介绍

1、首先查看拦截的接口继承关系图

image

image.gif

​

根据继承关系图发现，连接器的顶级接口为 HandlerInterceptor ，不过SpringMVC在也提供了一个适配器类 HandlerInterceptorAdapter，在扩展自己的拦截器时，直接继承 HandlerInterceptorAdapter 即可，直接重写，需要关注的方法就行。

2、看看 HandlerInterceptor 都有哪些方法

public interface HandlerInterceptor {

    //前置方法, 获取到 Handler执行真正的 handler之前
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {

        return true;
    }

    //执行完真正的handler之后
    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            @Nullable ModelAndView modelAndView) throws Exception {
    }

    // 视图渲染之后
    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
            @Nullable Exception ex) throws Exception {
    }

}

image.gif

HandlerInterceptor接口一共提供了三个接口分别为

1. 获取到Handler适配器，调用真正的 Handler处理类之前
2. 执行完真正的Handler处理类，但在视图渲染之前
3. 视图渲染之后

三、Spring是如何装载拦截器

1、XML 配置方式

在通通过 方式配置拦截器，此方式是通过 标签解析类 InterceptorsBeanDefinitionParser 完成的，具体如源码所示

image

image.gif

​

2、SpringBoot注解方式

SpringBoot的的方式是需要先创建实现接口 WebMvcConfigurer 的自定也配置类，并且重写addInterceptors方法，如下所示：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    //实现此方法，注册自定义拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new JWTHandlerInterceptor());
        registry.addWebRequestInterceptor(new TestWebRequestInterceptor());
    }
}

image.gif

此处注册了拦截器，那么在真正执行时，又是如何获取拦截器的呢？

在上篇介绍 Spring MVC 源码分析之 加载及查找 Controller 说明 RequestMappingHandlerMapping 的创建时，有说明。可以自行查看。

四、执行顺序

如果自定义了多个拦截器，如何使其按自己的顺序执行呢，这个在 WebMvcConfigurer中注册拦截器时，可以按照自己的执行顺序进行注册，有一点需要注意，在拦截器中执行 preHandle 方法是按注册顺序执行，在执行 postHandle 方法时是按照注册的倒序进行执行的。

拦截器的注册顺序为 拦截器1，拦截器2，拦截器3，

执行 preHandle 方法的顺序为：拦截器1 =》拦截器2 =》 拦截器3

执行 postHandle 方法的顺序为：拦截器3 =》拦截器2 =》 拦截器1

五、总结

此篇文章主要介绍了，拦截器的注册执行等，介绍的比较粗糙，主要为了记录一下自己的源码分析。望大拿斧正。