Spring容器啟動源碼解析
- 2019 年 10 月 25 日
- 筆記
1. 前言
最近搭建的工程都是基於SpringBoot，簡化配置的感覺真爽。但有個以前的項目還是用SpringMvc寫的，看到滿滿的配置xml文件，卻有一種想去深入了解的衝動。折騰了好幾天，決心去寫這篇關於Spring啟動的博客，自己是個剛入職的小白，技術水平有限，也是硬着頭皮看源碼去Debug，很多不懂的地方還請諒解！
2. 概述
先給出幾個讓我頭皮發麻的概念：web容器，Spring容器，SpringMvc容器
容器就是管理對象的地方，例如web容器就是管理servlet的地方，Spring容器就是管理Service,dao等Bean的地方，SpringMvc就是管理Controller等bean的地方(下文會做解釋)。一個SpringMvc項目的啟動離不開上述三個容器。所以這就是這篇文章的講點，各個容器的啟動過程解析。
3. Web容器初始化過程
官方文檔是對於Web容器初始化時是這樣描述的（英文不懂，已翻譯成中文）
1. 部署描述文件（web.xml）中的<listener>標記的監聽器會被創建和初始化
2. 對於實現了ServletContextListener的監聽器，會執行它的初始化方法 contextInitialized()
3. 部署描述文件中的<filter>標記的過濾器會被創建和初始化，調用其init()方法
4. 部署描述文件中的<servlet>標記的servlet會根據<load-on-startup>中的序號創建和初始化，調用init()方法
大致流程了解之後，結合自己的SpringMvc項目一步步深入，先貼一下基本的web.xml文件
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:web="http://java.sun.com/xml/ns/javaee" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5"> <display-name>dmpserver</display-name> <welcome-file-list> <welcome-file>login.jsp</welcome-file> </welcome-file-list> <context-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring.xml</param-value> </context-param> <context-param> <param-name>log4jConfigLocation</param-name> <param-value>classpath:log4jConfig.xml</param-value> </context-param> <filter> <filter-name>encodingFilter</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <init-param> <param-name>encoding</param-name> <param-value>utf-8</param-value> </init-param> </filter> <filter-mapping> <filter-name>encodingFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <listener> <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener> <servlet> <description>spring mvc servlet</description> <servlet-name>rest</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value> classpath:spring-mvc.xml </param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> </web-app>
1. 容器會先解析<context-param>中的鍵值對（上述代碼重點關注Spring配置文件Spring.xml）
2. 容器創建一個application內置對象servletContext（可以理解為servlet上下文或web容器），用於全局變量共享
3. 將解析的<context-param>鍵值對存放在application即servletContext中
4. 讀取<listener>中的監聽器，一般會使用ContextLoaderListener類，調用其contextInitialized方法，創建IOC容器（Spring容器）webApplicationContext。將webApplication容器放入application（servlet上下文）中作為根IOC容器，鍵名為WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE 注意的是，webApplicationContext是全局唯一的，一個web應用只能有一個根IOC容器。因為這個根IOC容器是讀取<context-param>配置的鍵值對來創建Bean，這個根IOC容器只能訪問spring.xml中配置的Bean，我們在Spring.xml中一般配置的是service，dao等Bean。所以根IOC容器（Spring容器）只能管理service，dao等Bean
5. listener加載完畢後，加載filter過濾器
6. 加載servlet，一般springMvc項目中會優先加載 DispatcherServlet（現在開始加載SpringMvc容器了）
7. DispatcherServlet的父類FrameworkServlet重寫了其父類的initServletBean()方法，在初始化時調用initWebApplicationContext()方法和onRefresh()方法
8. initWebApplicationContext()方法會在servletContext（即當前servlet上下文）創建一個子IOC容器（即SpringMvc容器），如果存在上述的根IOC容器，就設置根IOC容器作為父容器，如果不存在，就將父容器設置為NULL
9. 讀取<servlet>標籤的<init-param>配置的xml文件並加載相關Bean。此時加載的是Spring-mvc.xml配置文件，管理的是Controller等Bean
10. onRefresh()加載其他組件
4. 啟動過程分析
4.1 listener初始化Spring容器
tomcat啟動後，<context-param>標籤的內容讀取後會被放進application中，做為Web應用的全局變量使用，接下來創建listener時會使用到這個全局變量，因此，Web應用在容器中部署後，進行初始化時會先讀取這個全局變量，之後再進行上述講解的初始化啟動過程。
查看ContextLoaderListener源碼
public class ContextLoaderListener extends ContextLoader implements ServletContextListener { public ContextLoaderListener() { } public ContextLoaderListener(WebApplicationContext context) { super(context); } public void contextInitialized(ServletContextEvent event) { this.initWebApplicationContext(event.getServletContext()); } public void contextDestroyed(ServletContextEvent event) { this.closeWebApplicationContext(event.getServletContext()); ContextCleanupListener.cleanupAttributes(event.getServletContext()); } }
據官方文檔說明，實現ServletContextListener接口，執行contextInitialized()，進入initWebApplicationContext方法。contextInitialized()和contextDestroyed()方法會在web容器啟動或銷毀時執行。網上查了下此處設計模式用到的是觀察者模式和代理模式，自己也不懂就不做詳解了
查看ContextLoader.class中的initWebApplicationContext方法
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) { /* 首先通過WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE 這個String類型的靜態變量獲取一個根IoC容器，根IoC容器作為全局變量 存儲在application對象中，如果存在則有且只能有一個 如果在初始化根WebApplicationContext即根IoC容器時發現已經存在 則直接拋出異常，因此web.xml中只允許存在一個ContextLoader類或其子類的對象 */ 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!"); } else { Log logger = LogFactory.getLog(ContextLoader.class); servletContext.log("Initializing Spring root WebApplicationContext"); if (logger.isInfoEnabled()) { logger.info("Root WebApplicationContext: initialization started"); } long startTime = System.currentTimeMillis(); try { if (this.context == null) { // 創建一個根IOC容器 this.context = this.createWebApplicationContext(servletContext); } if (this.context instanceof ConfigurableWebApplicationContext) { ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext)this.context; if (!cwac.isActive()) { if (cwac.getParent() == null) { // 為根IOC容器設置一個父容器 ApplicationContext parent = this.loadParentContext(servletContext); cwac.setParent(parent); } this.configureAndRefreshWebApplicationContext(cwac, servletContext); } } //將創建好的IoC容器放入到application對象中，並設置key為WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context); ClassLoader ccl = Thread.currentThread().getContextClassLoader(); if (ccl == ContextLoader.class.getClassLoader()) { currentContext = this.context; } else if (ccl != null) { 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 var8) { logger.error("Context initialization failed", var8); servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, var8); throw var8; } catch (Error var9) { logger.error("Context initialization failed", var9); servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, var9); throw var9; } } }
initWebApplicationContext方法的主要目的是創建一個根IOC容器，並放入servlet上下文中。看上述源碼可知，根IOC容器只能僅有一個，作為全局變量存儲在servletContext中。將根IoC容器放入到application對象之前進行了IoC容器的配置和刷新操作，調用了configureAndRefreshWebApplicationContext()方法，該方法源碼如下:
protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) { String configLocationParam; if (ObjectUtils.identityToString(wac).equals(wac.getId())) { configLocationParam = sc.getInitParameter("contextId"); if (configLocationParam != null) { wac.setId(configLocationParam); } else { wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + ObjectUtils.getDisplayString(sc.getContextPath())); } } wac.setServletContext(sc); /* 在容器啟動時，會把<context-param>中的內容放入servlet上下文的全局變量中， 此時獲取key為contextConfigLocation的變量，及Spring.xml配置文件 將其放入到webApplicationContext中 */ configLocationParam = sc.getInitParameter("contextConfigLocation"); if (configLocationParam != null) { wac.setConfigLocation(configLocationParam); } ConfigurableEnvironment env = wac.getEnvironment(); if (env instanceof ConfigurableWebEnvironment) { ((ConfigurableWebEnvironment)env).initPropertySources(sc, (ServletConfig)null); } this.customizeContext(sc, wac); wac.refresh(); }
configureAndRefreshWebApplicationContext方法比較重要的是把配置文件信息放入根IOC容器中。方法最後調用了refresh()方法，對配置文件信息（Bean）進行加載。因為refresh()這是個ConfigurableApplication-Context接口方法，想到了它的常用實現類ClassPathXmlApplicationContext，一層層進去找到了Abstract-ApplicationContext，實現了refresh()，見如下源碼：
public void refresh() throws BeansException, IllegalStateException { Object var1 = this.startupShutdownMonitor; synchronized(this.startupShutdownMonitor) { this.prepareRefresh(); ConfigurableListableBeanFactory beanFactory = this.obtainFreshBeanFactory(); this.prepareBeanFactory(beanFactory); try { this.postProcessBeanFactory(beanFactory); this.invokeBeanFactoryPostProcessors(beanFactory); this.registerBeanPostProcessors(beanFactory); this.initMessageSource(); this.initApplicationEventMulticaster(); this.onRefresh(); this.registerListeners(); this.finishBeanFactoryInitialization(beanFactory); this.finishRefresh(); } catch (BeansException var9) { if (this.logger.isWarnEnabled()) { this.logger.warn("Exception encountered during context initialization - cancelling refresh attempt: " + var9); } this.destroyBeans(); this.cancelRefresh(var9); throw var9; } finally { this.resetCommonCaches(); } } }
該方法主要用於創建並初始化contextConfigLocation類配置的xml文件中的Bean，因此，如果我們在配置Bean時出錯，在Web應用啟動時就會拋出異常，而不是等到運行時才拋出異常。因為技術能力有限加上此處方法太多，就不在一一解析了。到此為止，整個Spring容器加載完畢，下面開始加載SpringMVC容器
4.2 Filter初始化
因為Filter的操作沒有涉及IOC容器，此處不做詳解，上面web.xml中配置的是一個UTF8編碼過濾器
5. 總結
時間有限，只大致介紹了Spring容器的初始化，後面還沒來得及整理，對於springMvc容器的創建和初始化下篇文章見
