Spring基礎系列-容器啟動流程(1)

原創作品，可以轉載，但是請標注出處地址：https://www.cnblogs.com/V1haoge/p/9502069.html

一、概述

　　我說的容器啟動流程涉及兩種情況，SSM開發模式和Springboot開發模式。

　　SSM開發模式中，需要配置web.xml文件用作啟動配置文件，而Springboot開發模式中由main方法直接啟動。

　　下面是web項目中容器啟動的流程，起點是web.xml中配置的ContextLoaderListener監聽器。

二、調用流程圖（右鍵可查看大圖）

　　

三、流程解析

　　Tomcat服務器啟動時會讀取項目中web.xml中的配置項來生成ServletContext，在其中注冊的ContextLoaderListener是ServletContextListener接口的實現類，它會時刻監聽ServletContext的動作，包括創建和銷毀，ServletContext創建的時候會觸發其contextInitialized()初始化方法的執行。而Spring容器的初始化操作就在這個方法之中被觸發。

　　源碼1-來自：ContextLoaderListener

    /**
     * Initialize the root web application context.
     */
    @Override
    public void contextInitialized(ServletContextEvent event) {
 initWebApplicationContext(event.getServletContext());
    }

　　ContextLoaderListener是啟動和銷毀Spring的根WebApplicationContext（web容器或者web應用上下文）的引導器，其中實現了ServletContextListener的contextInitialized容器初始化方法與contextDestoryed銷毀方法，用於引導根web容器的創建和銷毀。

　　上面方法中contextInitialized就是初始化根web容器的方法。其中調用了initWebApplicationContext方法進行Spring web容器的具體創建。

　　源碼2-來自：ContextLoader

    public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
        //SpringIOC容器的重復性創建校驗
        if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {
            throw new IllegalStateException(
                    "Cannot initialize context because there is already a root application context present - " +
                    "check whether you have multiple ContextLoader* definitions in your web.xml!");
        }

        Log logger = LogFactory.getLog(ContextLoader.class);
        servletContext.log("Initializing Spring root WebApplicationContext");
        if (logger.isInfoEnabled()) {
            logger.info("Root WebApplicationContext: initialization started");
        }
        //記錄Spring容器創建開始時間
        long startTime = System.currentTimeMillis();

        try {
            // Store context in local instance variable, to guarantee that
            // it is available on ServletContext shutdown.
            if (this.context == null) {
                //創建Spring容器實例
                this.context = createWebApplicationContext(servletContext);
            }
            if (this.context instanceof ConfigurableWebApplicationContext) {
                ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
                if (!cwac.isActive()) {
                    //容器只有被刷新至少一次之后才是處於active（激活）狀態
                    if (cwac.getParent() == null) {
                        //此處是一個空方法，返回null,也就是不設置父級容器
                        ApplicationContext parent = loadParentContext(servletContext);
                        cwac.setParent(parent);
                    }
                    //重點操作：配置並刷新容器
 configureAndRefreshWebApplicationContext(cwac, servletContext);
                }
            }
            //將創建完整的Spring容器作為一條屬性添加到Servlet容器中
            servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);

            ClassLoader ccl = Thread.currentThread().getContextClassLoader();
            if (ccl == ContextLoader.class.getClassLoader()) {
                //如果當前線程的類加載器是ContextLoader類的類加載器的話，也就是說如果是當前線程加載了ContextLoader類的話，則將Spring容器在ContextLoader實例中保留一份引用
                currentContext = this.context;
            }
            else if (ccl != null) {
                //添加一條ClassLoader到Springweb容器的映射
                currentContextPerThread.put(ccl, this.context);
            }

            if (logger.isDebugEnabled()) {
                logger.debug("Published root WebApplicationContext as ServletContext attribute with name [" +
                        WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE + "]");
            }
            if (logger.isInfoEnabled()) {
                long elapsedTime = System.currentTimeMillis() - startTime;
                logger.info("Root WebApplicationContext: initialization completed in " + elapsedTime + " ms");
            }

            return this.context;
        }
        catch (RuntimeException ex) {
            logger.error("Context initialization failed", ex);
            servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, ex);
            throw ex;
        }
        catch (Error err) {
            logger.error("Context initialization failed", err);
            servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, err);
            throw err;
        }
    }

　　這里十分明了的顯示出了ServletContext和Spring root ApplicationContext的關系：后者只是前者的一個屬性，前者包含后者。

　　ServletContext表示的是一整個應用，其中囊括應用的所有內容，而Spring只是應用所采用的一種框架。從ServletContext的角度來看，Spring其實也算是應用的一部分，屬於和我們編寫的代碼同級的存在，只是相對於我們編碼人員來說，Spring是作為一種即存的編碼架構而存在的，即我們將其看作我們編碼的基礎，或者看作應用的基礎部件。雖然是基礎部件，但也是屬於應用的一部分。所以將其設置到ServletContext中，而且是作為一個單一屬性而存在，但是它的作用卻是很大的。

　　源碼中WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE的值為：WebApplicationContext.class.getName() + ".ROOT"，這個正是Spring容器在Servlet容器中的屬性名。

　　在這段源碼中主要是概述Spring容器的創建和初始化，分別由兩個方法實現：createWebApplicationContext方法和configureAndRefreshWebApplicationContext方法。

　　首先，我們需要創建Spring容器，我們需要決定使用哪個容器實現。

　　源碼3-來自：ContextLoader

    protected WebApplicationContext createWebApplicationContext(ServletContext sc) {
        //決定使用哪個容器實現
        Class<?> contextClass = determineContextClass(sc);
        if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
            throw new ApplicationContextException("Custom context class [" + contextClass.getName() +
                    "] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");
        }
        //反射方式創建容器實例
        return (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
    }

    //我們在web.xml中以 <context-param> 的形式設置contextclass參數來指定使用哪個容器實現類，
    //若未指定則使用默認的XmlWebApplicationContext，其實這個默認的容器實現也是預先配置在一個
    //叫ContextLoader.properties文件中的
    protected Class<?> determineContextClass(ServletContext servletContext) {
        //獲取Servlet容器中配置的系統參數contextClass的值，如果未設置則為null
        String contextClassName = servletContext.getInitParameter(CONTEXT_CLASS_PARAM);
        if (contextClassName != null) {
            try {
                return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());
            }
            catch (ClassNotFoundException ex) {
                throw new ApplicationContextException(
                        "Failed to load custom context class [" + contextClassName + "]", ex);
            }
        }
        else {
            //獲取預先配置的容器實現類
            contextClassName = defaultStrategies.getProperty(WebApplicationContext.class.getName());
            try {
                return ClassUtils.forName(contextClassName, ContextLoader.class.getClassLoader());
            }
            catch (ClassNotFoundException ex) {
                throw new ApplicationContextException(
                        "Failed to load default context class [" + contextClassName + "]", ex);
            }
        }
    }

　　BeanUtils是Spring封裝的反射實現，instantiateClass方法用於實例化指定類。

　　我們可以在web.xml中以 <context-param> 的形式設置contextclass參數手動決定應用使用哪種Spring容器，但是一般情況下我們都遵循Spring的默認約定，使用ContextLoader.properties中配置的org.springframework.web.context.WebApplicationContext的值來作為默認的Spring容器來創建。

　　源碼4-來自：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

　　可見，一般基於Spring的web服務默認使用的都是XmlWebApplicationContext作為容器實現類的。

　　到此位置容器實例就創建好了，下一步就是配置和刷新了。

　　源碼4-來自：ContextLoader

    protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
        if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
            // The application context id is still set to its original default value
            // -> assign a more useful id based on available information 
            String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);
            if (idParam != null) {
                wac.setId(idParam);
            }
            else {
                // Generate default id...
                wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
                        ObjectUtils.getDisplayString(sc.getContextPath()));
            }
        }
        //在當前Spring容器中保留對Servlet容器的引用
        wac.setServletContext(sc);
        //設置web.xml中配置的contextConfigLocation參數值到當前容器中
        String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);
        if (configLocationParam != null) {
            wac.setConfigLocation(configLocationParam);
        }

        // The wac environment's #initPropertySources will be called in any case when the context
        // is refreshed; do it eagerly here to ensure servlet property sources are in place for
        // use in any post-processing or initialization that occurs below prior to #refresh
        //在容器刷新之前，提前進行屬性資源的初始化，以備使用，將ServletContext設置為servletContextInitParams
        ConfigurableEnvironment env = wac.getEnvironment();
        if (env instanceof ConfigurableWebEnvironment) {
            ((ConfigurableWebEnvironment) env).initPropertySources(sc, null);
        }
        //取得web.xml中配置的contextInitializerClasses和globalInitializerClasses對應的初始化器，並執行初始化操作，需自定義初始化器
 customizeContext(sc, wac);
        //刷新容器
        wac.refresh();
    }

　　首先將ServletContext的引用置入Spring容器中，以便可以方便的訪問ServletContext；然后從ServletContext中找到“contextConfigLocation”參數的值，配置是在web.xml中以<context-param>形式配置的。

　　在Spring中凡是以<context-param>配置的內容都會在web.xml加載的時候優先存儲到ServletContext之中，我們可以將其看成ServletContext的配置參數，將參數配置到ServletContext中后，我們就能方便的獲取使用了，就如此處我們就能直接從ServletContext中獲取“contextConfigLocation”的值，用於初始化Spring容器。

　　在Java的web開發中，尤其是使用Spring開發的情況下，基本就是一個容器對應一套配置，這套配置就是用於初始化容器的。ServletContext對應於<context-param>配置，Spring容器對應applicationContext.xml配置，這個配置屬於默認的配置，如果自定義名稱就需要將其配置到<context-param>中備用了，還有DispatchServlet的Spring容器對應spring-mvc.xml配置文件。

　　Spring容器的environment表示的是容器運行的基礎環境配置，其中保存的是Profile和Properties，其initPropertySources方法是在ConfigurableWebEnvironment接口中定義的，是專門用於web應用中來執行真實屬性資源與占位符資源（StubPropertySource）的替換操作的。

　　StubPropertySource就是一個占位用的實例，在應用上下文創建時，當實際屬性資源無法及時初始化時，臨時使用這個實例進行占位，等到容器刷新的時候執行替換操作。

　　上面源碼中customizeContext方法的目的是在刷新容器之前對容器進行自定義的初始化操作，需要我們實現ApplicationContextInitializer<C extends ConfigurableApplicationContext>接口，然后將其配置到web.xml中即可生效。

　　源碼5-來自：ContextLoader

    protected void customizeContext(ServletContext sc, ConfigurableWebApplicationContext wac) {
        //獲取初始化器類集合
        List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>> initializerClasses =
 determineContextInitializerClasses(sc);

        for (Class<ApplicationContextInitializer<ConfigurableApplicationContext>> initializerClass : initializerClasses) {
            Class<?> initializerContextClass =
                    GenericTypeResolver.resolveTypeArgument(initializerClass, ApplicationContextInitializer.class);
            if (initializerContextClass != null && !initializerContextClass.isInstance(wac)) {
                throw new ApplicationContextException(String.format(
                        "Could not apply context initializer [%s] since its generic parameter [%s] " +
                        "is not assignable from the type of application context used by this " +
                        "context loader: [%s]", initializerClass.getName(), initializerContextClass.getName(),
                        wac.getClass().getName()));
            }
            //實例化初始化器並添加到集合中
            this.contextInitializers.add(BeanUtils.instantiateClass(initializerClass));
        }
        //排序並執行，編號越小越早執行
        AnnotationAwareOrderComparator.sort(this.contextInitializers);
        for (ApplicationContextInitializer<ConfigurableApplicationContext> initializer : this.contextInitializers) {
            initializer.initialize(wac);
        }
    }

    protected List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>>
            determineContextInitializerClasses(ServletContext servletContext) {

        List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>> classes =
                new ArrayList<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>>();
        //通過<context-param>屬性配置globalInitializerClasses獲取全局初始化類名
        String globalClassNames = servletContext.getInitParameter(GLOBAL_INITIALIZER_CLASSES_PARAM);
        if (globalClassNames != null) {
            for (String className : StringUtils.tokenizeToStringArray(globalClassNames, INIT_PARAM_DELIMITERS)) {
                classes.add(loadInitializerClass(className));
            }
        }
        //通過<context-param>屬性配置contextInitializerClasses獲取容器初始化類名
        String localClassNames = servletContext.getInitParameter(CONTEXT_INITIALIZER_CLASSES_PARAM);
        if (localClassNames != null) {
            for (String className : StringUtils.tokenizeToStringArray(localClassNames, INIT_PARAM_DELIMITERS)) {
                classes.add(loadInitializerClass(className));
            }
        }

        return classes;
    }

　　initPropertySources操作用於配置屬性資源，其實在refresh操作中也會執行該操作，這里提前執行，目的為何，暫未可知。

　　到達refresh操作我們先暫停。refresh操作是容器初始化的操作。是通用操作，而到達該點的方式確實有多種，每種就是一種Spring的開發方式。

　　除了此處的web開發方式，還有Springboot開發方式，貌似就兩種。。。下面說說Springboot啟動的流程，最后統一說refresh流程。