漫谈Spring的启动与初始化(二)

上一篇关于Spring是如何启动的文章,主要是分析了从Tomcat启动到web.xml文件加载,再到通过ContextLoaderListener监听器开始初始化WebApplicationContext这个过程,如果不熟悉可以参考这篇-漫谈Spring的启动与初始化(一),但是上一篇还没有分析到Spring容器是如何通过web.xml里面配置的contextConfigLocation参数和Spring容器的配置文件applicationContext.xml来初始化Spring,本文着力于解决这个疑惑。

initWebApplicationContext方法

ContextLoaderListener监听到ServletContext初始化事件的时候就会调用ContextLoaderinitWebApplicationContext方法,这个方法完成了很多的工作,其中便有下面这段关键代码,源码如下:


    private WebApplicationContext context;
    public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
        ...
        if(this.context == null) {
            //如果context为null就开始创建WebApplicationContext
            this.context = this.createWebApplicationContext(servletContext);
        }
        ...
    }

createWebApplicationContext方法

下面进入该方法,源码如下:

    protected WebApplicationContext createWebApplicationContext(ServletContext sc) {
        Class contextClass = this.determineContextClass(sc);
        if(!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
            throw new ApplicationContextException("Custom context class [" + contextClass.getName() + "] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");
        } else {
            //根据类返回实例
            return (ConfigurableWebApplicationContext)BeanUtils.instantiateClass(contextClass);
        }
    }

其中determineContextClass(sc)方法是用来寻找实现WebApplicationContext接口的类,实现方法如下:

    protected Class<?> determineContextClass(ServletContext servletContext) {
        //关键代码一:
        String contextClassName = servletContext.getInitParameter("contextClass");
        if(contextClassName != null) {
            try {
                return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());
            } catch (ClassNotFoundException var4) {
                throw new ApplicationContextException("Failed to load custom context class [" + contextClassName + "]", var4);
            }
        } else {
            //关键代码二:
            contextClassName = defaultStrategies.getProperty(WebApplicationContext.class.getName());

            try {
                return ClassUtils.forName(contextClassName, ContextLoader.class.getClassLoader());
            } catch (ClassNotFoundException var5) {
                throw new ApplicationContextException("Failed to load default context class [" + contextClassName + "]", var5);
            }
        }
    }

上面这两行代码就是决定返回的Class:如果开发人员在web.xml中配置了一个参数名为contextClass,值为WebApplicationContext接口实现类,那getInitParameter("contextClass")就会返回这个配置的实现类Class;如果没有配置,也就是contextClassName==null,那么通过defaultStrategies.getProperty(...)则会返回Spring默认的实现类XmlWebApplicationContext。可能有同学会好奇为什么是这个,这个类是从哪儿来的。
我们回头在ContextLoader这个类中最下面可以看到有这么几行静态代码段,在类一加载的时候执行,如下:

public class ContextLoader {
    private static final Properties defaultStrategies;
    static {
        try {
            ClassPathResource ex = new ClassPathResource("ContextLoader.properties", ContextLoader.class);
            defaultStrategies = PropertiesLoaderUtils.loadProperties(ex);
        } catch (IOException var1) {
            throw new IllegalStateException("Could not load \'ContextLoader.properties\': " + var1.getMessage());
        }

        currentContextPerThread = new ConcurrentHashMap(1);
    }
}

ContextLoader.class的同一个包下面,可以找到这个配置文件,其中只有一行配置如下:

org.springframework.web.context.WebApplicationContext=org.springframework.web.context.support.XmlWebApplicationContext

XmlWebApplicationContext这个类就是WebApplicationContext这个接口最终的实现类,也是Spring启动时默认使用的类。其实还有一些实现类,让我们自己去加载applicationContext.xml,比如ClassPathXmlApplicationContext
这样在上述的createWebApplicationContext方法中,我们拿到的就是XmlWebApplicationContext.class,然后通过BeanUtils.instantiateClass(contextClass)方法根据类名创建对应实例,并且进行强制转换得到ConfigurableWebApplicationContext接口的实例,因为XmlWebApplicationContext是后者的实现类,所以这样转换是没问题的(当然没问题哈哈)。
那么createWebApplicationContext方法分析到此为止。

我们继续看initWebApplicationContext方法中下面这段代码的最后一行:

    if(this.context == null) {
        //如果context为null就开始创建WebApplicationContext
        this.context = this.createWebApplicationContext(servletContext);
    }
    if(this.context instanceof ConfigurableWebApplicationContext) {
        ConfigurableWebApplicationContext err = (ConfigurableWebApplicationContext)this.context;
        if(!err.isActive()) {
            ...
            //关键代码:配置和刷新WebApplicationContext,这里其实就是XmlWebApplicationContext了
            this.configureAndRefreshWebApplicationContext(err, servletContext);
        }
    }

configureAndRefreshWebApplicationContext方法

在上面代码中我们通过XmlWebApplicationContext类创建了WebApplicationContext的实例,本节方法则是为该实例设置一些配置信息和创建各种bean。我们重点关注下面几行代码:

    protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
        ...
        wac.setServletContext(sc);
        //关键代码一:在ServletContext中获取contextConfigLocation值,查找配置文件地址
        configLocationParam = sc.getInitParameter("contextConfigLocation");
        if(configLocationParam != null) {
            wac.setConfigLocation(configLocationParam);
        }
        ...
        //关键代码二:刷新XmlWebApplicationContext
        wac.refresh();
    }

在Spring的项目中,经常要在web.xml中配置contextConfigLocation的参数,我们对于下面的几行xml代码应该也很熟悉,它设置了Spring容器配置文件的路径:

    <!-- Context ConfigLocation -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath*:/spring-context*.xml</param-value>
    </context-param>

既然是在web.xml中配置的这些参数,为什么是在ServletContext中去取呢?在上一篇文章中分析过,Tomcat在加载web.xml文件时,会最终将该配置文件的配置属性参数以键值对的形式存放在每个web应用对应的ServletContext中,这样我们在web应用中的任何地方都可以拿到该参数值(后面还会提到ServletContext其他的使用场景)。
当然,如果我们没有在web.xml中配置该参数的话,XmlWebApplicationContext类也是有默认值的,如下:

    public class XmlWebApplicationContext extends AbstractRefreshableWebApplicationContext {
        public static final String DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml";
        public static final String DEFAULT_CONFIG_LOCATION_PREFIX = "/WEB-INF/";
        public static final String DEFAULT_CONFIG_LOCATION_SUFFIX = ".xml";
    }

到这里,配置文件信息拿到了,再就是wac.refresh()方法了,这个方法具体实现在AbstractApplicationContext类中,进入该方法:

    public void refresh() throws BeansException, IllegalStateException {
        Object var1 = this.startupShutdownMonitor;
        synchronized(this.startupShutdownMonitor) {
           //容器预先准备,记录容器启动时间和标记
          prepareRefresh();
          //创建bean工厂,里面实现了BeanDefinition的装载
          ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
          //配置bean工厂的上下文信息,如类装载器等
          prepareBeanFactory(beanFactory);
          try {
            //在BeanDefinition被装载后,提供一个修改BeanFactory的入口
            postProcessBeanFactory(beanFactory);
            //在bean初始化之前,提供对BeanDefinition修改入口,PropertyPlaceholderConfigurer在这里被调用
            invokeBeanFactoryPostProcessors(beanFactory);
            //注册各种BeanPostProcessors,用于在bean被初始化时进行拦截,进行额外初始化操作
            registerBeanPostProcessors(beanFactory);
            //初始化MessageSource
            initMessageSource();
            //初始化上下文事件广播
            initApplicationEventMulticaster();
            //模板方法
            onRefresh();
            //注册监听器
            registerListeners();
            //初始化所有未初始化的非懒加载的单例Bean
            finishBeanFactoryInitialization(beanFactory);
            //发布事件通知
            finishRefresh();
            } catch (BeansException var5) {
                if(this.logger.isWarnEnabled()) {
                    this.logger.warn("Exception encountered during context initialization - cancelling refresh attempt: " + var5);
                }
                this.destroyBeans();
                this.cancelRefresh(var5);
                throw var5;
            }

        }
    }

这个方法里面就是IOC容器初始化的大致步骤了。

after configureAndRefresh

在IOC容器初始化之后,也就是configureAndRefreshWebApplicationContext方法执行结束后有一行代码如下:

        //关键代码:
    servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);

可以看到,这里初始化后的context被存放到了servletContext中,具体的就是存到了一个Map变量中,key值就是WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE这个常量。这个key常量在WebApplicationContext接口中设置的,如下:

public interface WebApplicationContext extends ApplicationContext {
    //org.springframework.web.context.WebApplicationContext.ROOT
    String ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.class.getName() + ".ROOT";
}

另外,我们也可以使用Spring的WebApplicationContextUtils工具类获取这个WebApplicationContext(不过这里request获取ServletContext是有限制的,要求servlet-api.jar 包的版本是在3.0以上)方式如下:

WebApplicationContext applicationContext = WebApplicationContextUtils.getWebApplicationContext(request.getServletContext());

到这里Spring的启动与初始化应该就结束了,这里面要理清ServletContext和Spring容器的关系,整个Spring容器被放置在ServletContext这样一个类似于Map的结构中。ServletContext 从字面上理解也是Servlet的容器,被 Servlet 程序间接用来与外层 Web 容器通信,例如写日志,转发请求等。每一个 Web 应用程序含有一个Context ,被Web 应用内的各个程序共享。因为Context 可以用来保存资源并且共享,所以ServletContext 的常用场景是Web级应用缓存---- 把不经常更改的内容读入内存,所以服务器响应请求的时候就不需要进行慢速的磁盘I/O 了。

参考

深入理解Spring系列之七:web应用自动装配Spring配置

-EOF-

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

推荐阅读更多精彩内容