1.Spring源码系列-ContextLoader类解析

@(spring 源码系列)

介绍

ContextLoader类被ContextLoaderListener类调用，来初始化application context上下文。ContextLoaderListener这个类你一定见过，如果你写过spring mvc项目的话。他一定出现在web.xml文件里

解析从程序执行的逻辑出发，一步步来分析。这样做有助于理清程序逻辑，对后续遇到的问题定位也有很大帮助

时序图

调用顺序

方法调用顺序

initWebApplicationContext

if (this.context == null) {
//创建web容器上下文
                this.context = createWebApplicationContext(servletContext);
            }

createWebApplicationContext

//返回WebApplicationContext接口的实现类。默认返回XmlWebApplicationContext，或者返回指定的实现类
Class<?> contextClass = determineContextClass(sc);

determineContextClass

//获取自定义WebApplicationContext上下文实现类。指定实现类的指定方式在web.xml里通过参数contextClass指定
String contextClassName = servletContext.getInitParameter(CONTEXT_CLASS_PARAM);

if (contextClassName != null) {
                return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());
                }else{
                //没有指定实现类，默认返回XmlWebApplicationContext实现类。默认实现类配置在classpath下的ContextLoader.properties里
                contextClassName = defaultStrategies.getProperty(WebApplicationContext.class.getName());
                return ClassUtils.forName(contextClassName, ContextLoader.class.getClassLoader());
                }

createWebApplicationContext

//利用jdk反射，创建上下文实例.实例对象中有一个唯一标识id，这里的id生成的时机发生在类AbstractApplicationContext的成员变量private String id = ObjectUtils.identityToString(this);
return (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);

initWebApplicationContext

//配置和刷新容器上下文，包括解析xml文件，加载bean，调用beanfactorypostprocessor，beanpostprocesssor
configureAndRefreshWebApplicationContext(cwac, servletContext);

//把当前的webapplication上下文设置到servlet上下文中。这里的key是WebApplicationContext接口的全限定名
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);

configureAndRefreshWebApplicationContext

//设置容器的唯一标识id
    if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
    获取web.xml文件参数contextId配置的容器标识id
            String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);
            if (idParam != null) {
                wac.setId(idParam);
            }
            else {  
//生成默认的的容器id=   org.springframework.web.context.WebApplicationContext:  
    wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +                     ObjectUtils.getDisplayString(sc.getContextPath()));
            }
        }
        //设置servlet上下文到容器中
wac.setServletContext(sc);
//获取spring配置文件未知并设置到容器中
        String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);
        if (configLocationParam != null) {
            wac.setConfigLocation(configLocationParam);
        }
//创建容器的servlet环境
ConfigurableEnvironment env = wac.getEnvironment();

//初始化容器的servlet的环境，将servletContext和servletConfig设置到容器的servlet环境中
((ConfigurableWebEnvironment) env).initPropertySources(sc, null);

//自定制容器上下文.通过ApplicationContextInitializer初始化器来实现定制化。
//我们可以通过web.xml配置初始化类，多个初始化器可通过@order注解来指定初始化顺序
customizeContext(sc, wac);
// 刷新容器上下文
wac.refresh();

customizeContext

// 获取上下文初始化器，初始化器可通过web.xml配置
List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>> initializerClasses =
                determineContextInitializerClasses(sc);
        for (Class<ApplicationContextInitializer<ConfigurableApplicationContext>> initializerClass : initializerClasses) {
            Class<?> initializerContextClass =
                    GenericTypeResolver.resolveTypeArgument(initializerClass, ApplicationContextInitializer.class); 
            this.contextInitializers.add(BeanUtils.instantiateClass(initializerClass));
        }
        // 根据注解@order排序初始化器
        AnnotationAwareOrderComparator.sort(this.contextInitializers);
        // 回调初始化器，定制容器上下文
        for (ApplicationContextInitializer<ConfigurableApplicationContext> initializer : this.contextInitia