注解驱动的springmvc加载过程源码解析

按照servlet3.0规范的规定,tomcat等web容器在启动的时候需要查看META-INF/services目录下的以javax.servlet.ServletContainerInitializer作为文件名的文件并加载文件中实现了ServletContainerInitializer接口的类

ServletContainerInitializer

spring-web的实现为SpringServletContainerInitializer:

WEB-INF/services/
SpringServletContainerInitializer

该类被@HandlesTypes(WebApplicationInitializer.class)所注解,所以该类的onStartup方法实现中可以以Set<Class<?>> webAppInitializerClasses参数接收到所有WebApplicationInitializer接口的实现类:

    public void onStartup(@Nullable Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
            throws ServletException {

再看看WebApplicationInitializer的实现类有哪些:

WebApplicationInitializer的层级关系

下面看看SpringServletContainerInitializer.onStartup具体的逻辑(相关性不强的代码我就不贴出来了,主要看逻辑):

    public void onStartup(@Nullable Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
            throws ServletException {

        List<WebApplicationInitializer> initializers = new LinkedList<>();
         //拿到所有WebApplicationInitializer的实现类,如果该类不是接口、抽象类那么反射创建该类实例
        if (webAppInitializerClasses != null) {
            for (Class<?> waiClass : webAppInitializerClasses) {
                if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&
                        WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
                    try {
                        initializers.add((WebApplicationInitializer)
                                ReflectionUtils.accessibleConstructor(waiClass).newInstance());
                    }
                    catch (Throwable ex) {
                        throw new ServletException("Failed to instantiate WebApplicationInitializer class", ex);
                    }
                }
            }
        }
        //排序后依次执行onStartup方法
        AnnotationAwareOrderComparator.sort(initializers);
        for (WebApplicationInitializer initializer : initializers) {
            initializer.onStartup(servletContext);
        }
    }

根据上面代码的分析SpringServletContainerInitializer并没有执行具体的springIOC容器的加载和DispatcherServlet的注册,而是把具体的加载逻辑委托给了WebApplicationInitializer的实现类,但是WebApplicationInitializer的层级关系图显示,spring框架除了提供了三个抽象实现外并没有提供具体的实现类,所以需要开发者自己提供,我们先看最外层的封装AbstractAnnotationConfigDispatcherServletInitializer的注释(不喜欢英文的直接看后面翻译):

/**

  • Base class for {@link org.springframework.web.WebApplicationInitializer}
  • implementations that register a
  • {@link org.springframework.web.servlet.DispatcherServlet DispatcherServlet}
  • configured with annotated classes, e.g. Spring's
  • {@link org.springframework.context.annotation.Configuration @Configuration} classes.
  • <p>Concrete implementations are required to implement {@link #getRootConfigClasses()}
  • and {@link #getServletConfigClasses()} as well as {@link #getServletMappings()}.
  • Further template and customization methods are provided by
  • {@link AbstractDispatcherServletInitializer}.
  • <p>This is the preferred approach for applications that use Java-based
  • Spring configuration.
    */
    大概意思是说:这个类是WebApplicationInitializer接口的基础实现,目的是通过使用诸如@Configuration注解的配置类来注册DispatcherServlet(译者:也包括root application context),继承这个类的具体实现需要实现getRootConfigClasses、getServletConfigClasses和getServletMappings三个方法,并且继承这个类是使用基于注解配置的推荐方式。
    通过上面提供的三个方法名我们可以推断,只需要通过类似
AbstractAnnotationConfigDispatcherServletInitializer实现

这种方式就可以配置spring的root 容器和DispatcherServlet使用的mvc容器并配置DispatcherServlet的路径映射信息了,相当简单。

下面分析原理,再次熟悉一下层级关系:
->WebApplicationInitializer
->AbstractContextLoaderInitializer
->AbstractDispatcherServletInitializer
->AbstractAnnotationConfigDispatcherServletInitializer

直接看onStartup方法,onStartup只在AbstractContextLoaderInitializer和AbstractDispatcherServletInitializer中实现,我们从外往里看
AbstractDispatcherServletInitializer:

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        //调用父类的onStartup
        super.onStartup(servletContext);
        //注册DispatcherServlet
        registerDispatcherServlet(servletContext);
    }

AbstractContextLoaderInitializer:

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        //注册ContextLoaderListener
        registerContextLoaderListener(servletContext);
    }

其实从类的名字上我们就可以猜出来他们各自完成了什么工作了,AbstractContextLoaderInitializer的作用是向servletContext中注册ContextLoaderListener,这和我们使用xml配置方式加载springIOC容器的方式是一样的,AbstractDispatcherServletInitializer负责注册DispatcherServlet加载mvc容器。

    protected void registerContextLoaderListener(ServletContext servletContext) {
        //创建根容器rootAppContext
        WebApplicationContext rootAppContext = createRootApplicationContext();
        if (rootAppContext != null) {
            //实例化ContextLoaderListener
            ContextLoaderListener listener = new ContextLoaderListener(rootAppContext);
            //必要的话传入contextInitializers
            listener.setContextInitializers(getRootApplicationContextInitializers());
            //注册到servletContext中
            servletContext.addListener(listener);
        }
        else {
            logger.debug("No ContextLoaderListener registered, as " +
                    "createRootApplicationContext() did not return an application context");
        }
    }

关于上面创建根容器rootAppContext的方法createRootApplicationContext:

    protected WebApplicationContext createRootApplicationContext() {
        //获取用户定义的根容器配置类,在我们的例子中是AppConfig
        Class<?>[] configClasses = getRootConfigClasses();
        if (!ObjectUtils.isEmpty(configClasses)) {
            //仅仅将配置类注册到根IOC容器中以供ContextLoaderListener使用,具体容器加载过程由ContextLoaderListener完成
            AnnotationConfigWebApplicationContext rootAppContext = new AnnotationConfigWebApplicationContext();
            rootAppContext.register(configClasses);
            return rootAppContext;
        }
        else {
            return null;
        }
    }

ContextLoaderListener加载IOC容器的原理这里就不再赘述了。下面看DispatcherServlet的注册过程:

protected void registerDispatcherServlet(ServletContext servletContext) {
        //获得servlet名称,固定值"dispatcher"
        String servletName = getServletName();
        //生成AnnotationConfigWebApplicationContext容器,并将配置类注册进去(具体代码看后面的代码块)
        WebApplicationContext servletAppContext = createServletApplicationContext();
        //实例化DispatcherServlet,传入生成好的context容器
        FrameworkServlet dispatcherServlet = createDispatcherServlet(servletAppContext);
        //必要的话传入contextInitializers
        dispatcherServlet.setContextInitializers(getServletApplicationContextInitializers());
        //将DispatcherServlet注册到servletContext中
        ServletRegistration.Dynamic registration = servletContext.addServlet(servletName, dispatcherServlet);
        //设置LoadOnStartup
        registration.setLoadOnStartup(1);
        //设置mapping
        registration.addMapping(getServletMappings());
        //设置异步支持
        registration.setAsyncSupported(isAsyncSupported());
        //注册过滤器
        Filter[] filters = getServletFilters();
        if (!ObjectUtils.isEmpty(filters)) {
            for (Filter filter : filters) {
                registerServletFilter(servletContext, filter);
            }
        }
          //自定义配置
        customizeRegistration(registration);
    }

createServletApplicationContext:

    protected WebApplicationContext createServletApplicationContext() {
            //实例化容器
        AnnotationConfigWebApplicationContext servletAppContext = new AnnotationConfigWebApplicationContext();
            //获取配置类(webConfig)
        Class<?>[] configClasses = getServletConfigClasses();
        if (!ObjectUtils.isEmpty(configClasses)) {
            //注册配置类
            servletAppContext.register(configClasses);
        }
        return servletAppContext;
    }

配置好DispatcherServlet后,服务器web容器启动时根据LoadOnStartup属性会自动开始springmvc容器的加载过程。

总结

web容器启动->
注册contextloaderlistener(此监听器为servletcontextlistener,在servletcontext初始化之后执行内部方法完成root context的初始化工作)
向web容器注册dispatcherservlet,设置loadonstartup参数为1,即启动时执行init方法,在init方法中获取之前初始化完成的root context 完成web context的初始化。

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

推荐阅读更多精彩内容