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 配置方式

在通通过 <mvc:interceptors> 方式配置拦截器,此方式是通过 标签解析类 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

五、总结

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,290评论 6 491
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,107评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,872评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,415评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,453评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,784评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,927评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,691评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,137评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,472评论 2 326
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,622评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,289评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,887评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,741评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,977评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,316评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,490评论 2 348

推荐阅读更多精彩内容