SpringMVC源码阅读：ContextLoaderListener初始化过程

1 概述

• Tomcat或Jetty作为Servlet容器会为每一个Web应用构建一个ServletContext用于存放所有的Servlet, Filter, Listener。
• ContextLoaderListener 作为一个Listener会首先启动，创建一个WebApplicationContext用于加载除Controller等Web组件以外的所有bean，这个ApplicationContext作为根容器存在，对于整个Web应用来说，只能存在一个，也就是父容器，会被所有子容器共享，子容器可以访问父容器里的bean，反过来则不行。

2 web.xml配置

ContextLoaderListener监听器的作用就是启动web容器时，自动装配ApplicationContext的配置信息。它实现了ServletContextListener接口，在web.xml文件中配置这个监听器，Tomcat或Jetty启动容器时，就会默认执行它实现的方法。

    
        contextConfigLocation
        classpath*:/spring-context*.xml
     

    
        org.springframework.web.context.ContextLoaderListener
    

通过扩展ContextLoaderListener类，可以增加初始化时的个性化功能，如输出产品的信息等。

3 获取WebApplicationContext的实现类

在org.springframework.web.context.ContextLoader中有一个静态属性，

static {
        // Load default strategy implementations from properties file.
        // This is currently strictly internal and not meant to be customized
        // by application developers.
        try {
            ClassPathResource resource = new ClassPathResource(DEFAULT_STRATEGIES_PATH, ContextLoader.class);
            defaultStrategies = PropertiesLoaderUtils.loadProperties(resource);
        }
        catch (IOException ex) {
            throw new IllegalStateException("Could not load 'ContextLoader.properties': " + ex.getMessage());
        }
    }

默认的DEFAULT_STRATEGIES_PATH=ContextLoader.properties，路径在ContextLoader类的同一级目录下，都在spring-web-..*.RELEASE.jar包内。ContextLoader.properties的内容为：

# Default WebApplicationContext implementation class for ContextLoader.
# Used as fallback when no explicit context implementation has been specified as context-param.
# Not meant to be customized by application developers.

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

实际的实例化为org.springframework.web.context.support.XmlWebApplicationContext。

4 初始化WebApplicationContext

Tomcat的ApplicationContextFacade对象是SpringIOC根容器的父容器，是ApplicationContextFacade对象的一个属性，属性值为WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE

初始化WebApplicationContext

• servletContext是ApplicationContextFacade的对象。
• 首先判断servletContext中是否存在WebApplicationContext实例，如果存在说明ServletContextListener在web.xml中多次声明，并抛出异常。
• 调用 createWebApplicationContext() 方法创建WebApplicationContext实例
• 调用configureAndRefreshWebApplicationContext() 方法通过WebApplicationContext进行解析web.xml中配置的applicationContext.xml。
• 把WebApplicationContext实例添加到ServletContext中

createWebApplicationContext（servletContext）的实现

image.png

• 1是选择实例化的类

• 2是实例化

  
  
  

  image.png
• 1首先获取servletContext加载的web.xml中是否有contextClass的配置指定了实例化的类；
• 2根据3 获取WebApplicationContext的实现类的默认策略获取模式实例化类；
  
  

  image.png
• 1是XmlWebApplicationContext实例注入ApplicationContextFacade实例；
• 2是获取web.xml的contextConfigLocation的值；

        contextConfigLocation
        classpath*:/spring-context*.xml
    

• 4是IOC容器初始化，包括初始化各种Bean；

refresh()方法

所在类org.springframework.context.support.AbstractApplicationContext

public void refresh() throws BeansException, IllegalStateException {
        synchronized (this.startupShutdownMonitor) {
            // 准备context的刷新，设置启动日期和活动标识，执行资源文件的初始化
            prepareRefresh();

            // Tell the subclass to refresh the internal bean factory.
            ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

            // Prepare the bean factory for use in this context.
            prepareBeanFactory(beanFactory);

            try {
                // Allows post-processing of the bean factory in context subclasses.
                postProcessBeanFactory(beanFactory);

                // Invoke factory processors registered as beans in the context.
                invokeBeanFactoryPostProcessors(beanFactory);

                // Register bean processors that intercept bean creation.
                registerBeanPostProcessors(beanFactory);

                // Initialize message source for this context.
                initMessageSource();

                // Initialize event multicaster for this context.
                initApplicationEventMulticaster();

                // Initialize other special beans in specific context subclasses.
                onRefresh();

                // Check for listener beans and register them.
                registerListeners();

                // Instantiate all remaining (non-lazy-init) singletons.
                finishBeanFactoryInitialization(beanFactory);

                // Last step: publish corresponding event.
                finishRefresh();
            }

            catch (BeansException ex) {
                if (logger.isWarnEnabled()) {
                    logger.warn("Exception encountered during context initialization - " +
                            "cancelling refresh attempt: " + ex);
                }

                // Destroy already created singletons to avoid dangling resources.
                destroyBeans();

                // Reset 'active' flag.
                cancelRefresh(ex);

                // Propagate exception to caller.
                throw ex;
            }
        }
    }

知识点

• org.springframework.core.io.ClassPathResource和PropertiesLoaderUtils.loadProperties()组合读取jar包中的properties配置文件。
• Tomcat惯用Facade方式，因此在web应用程序中获取到的ServletContext实例实际上是一个ApplicationContextFacade对象，对ApplicationContext实例进行了封装。而ApplicationContext实例中含有Tomcat的Context容器实例（StandardContext实例，也就是在server.xml中配置的Context节点），以此来获取/操作Tomcat容器内部的一些信息，例如获取/注册servlet等。