在《深入理解Spring系列之一：開篇》的示例代碼中使用如下方式去加載Spring的配置文件并初始化容器。
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationgContext.xml");
在web應用中，配置文件都是自動加載的，示例代碼中的方式就不能滿足需求了。在web應用中使用Spring，需要在web.xml中添加如下配置。
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
classpath:applicationContext.xml;
</param-value>
</context-param>
先了解一下ServletContext和ServletContextListener。ServletContext定義了一些方法方便Servlet和Servlet容器進行通訊，在一個web應用中所有的Servlet都公用一個ServletContext，Spring在和web應用結合使用的時候，是將Spring的容器存到ServletContext中的，通俗的說就是將一個ApplicationContext存儲到ServletContext的一個Map屬性中；而ServletContextListener用于監聽ServletContext一些事件。分析就從ContextLoaderListener開始。在web應用啟動讀取web.xml時，發現配置了ContextLoaderListener，而ContextLoaderListener實現了ServletContextListener接口，因此會執行ContextLoaderListener類中的contextInitialized方法，方法的具體代碼如下。
public void contextInitialized(ServletContextEvent event) {
initWebApplicationContext(event.getServletContext());
}
繼續進入initWebApplicationContext方法，這個方法在其父類ContextLoader實現，根據方法名可以看出這個方法是用于初始化一個WebApplicationContext，簡單理解就是初始化一個Web應用下的Spring容器。方法的具體代碼如下。
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
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");
}
long startTime = System.currentTimeMillis();
try {
if (this.context == null) {
this.context = createWebApplicationContext(servletContext);
}
if (this.context instanceof ConfigurableWebApplicationContext) {
ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
if (!cwac.isActive()) {
if (cwac.getParent() == null) {
ApplicationContext parent = loadParentContext(servletContext);
cwac.setParent(parent);
}
configureAndRefreshWebApplicationContext(cwac, servletContext);
}
}
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 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是否已經存儲了一個默認名稱的WebApplicationContext，因為在一個應用中Spring容器只能有一個，所以需要校驗，至于這個默認的名稱為什么是WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE，看到后面就會慢慢明白。直接關注重點代碼，代碼如下。
if (this.context == null) {
this.context = createWebApplicationContext(servletContext);
}
這里的context是ContextLoader的一個變量，聲明代碼如下。
private WebApplicationContext context;
繼續進入createWebApplicationContext方法，具體代碼如下。
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);
}
這個方法主要用于創建一個WebApplicationContext對象。因為WebApplicationContext只是一個接口，不能創建對象，所以需要找到一個WebApplicationContext接口的實現類，determineContextClass方法就是用于尋找實現類，如果開發人員在web.xml中配置了一個參數名為contextClass，值為WebApplicationContext接口實現類，那就會返回這個配置的實現類Class；如果沒有配置，則會返回Spring默認的實現類XmlWebApplicationContext。直接進入determineContextClass方法體，代碼如下。
protected Class<?> determineContextClass(ServletContext servletContext) {
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);
}
}
}
上面的代碼中使用了defaultStrategies，用于獲取Spring默認的WebApplicationContext接口實現類XmlWebApplicationContext.java，它的聲明如下。
private static final String DEFAULT_STRATEGIES_PATH = "ContextLoader.properties";
private static final Properties defaultStrategies;
static {
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());
}
}
也就是說在ContextLoader.java的路徑下，有一個ContextLoader.properties文件，查找并打開這個文件，文件內容如下。
org.springframework.web.context.WebApplicationContext=org.springframework.web.context.support.XmlWebApplicationContext
這里配置了Spring默認的WebApplicationContext接口實現類XmlWebApplicationContext.java?；氐絚reateWebApplicationContext方法，WebApplicationContext接口實現類的Class已經找到，然后就是使用構造函數進行初始化完成WebApplicationContext對象創建。
繼續回到initWebApplicationContext方法，此時這個context就指向了剛剛創建的WebApplicationContext對象。因為XmlWebApplicationContext間接實現了ConfigurableWebApplicationContext接口，所以將會執行如下代碼。
if (this.context instanceof ConfigurableWebApplicationContext) {
ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
if (!cwac.isActive()) {
if (cwac.getParent() == null) {
ApplicationContext parent = loadParentContext(servletContext);
cwac.setParent(parent);
}
configureAndRefreshWebApplicationContext(cwac, servletContext);
}
}
這里關注重點代碼configureAndRefreshWebApplicationContext(cwac, servletContext)，configureAndRefreshWebApplicationContext方法具體代碼如下。
protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);
if (idParam != null) {
wac.setId(idParam);
}else {
wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
ObjectUtils.getDisplayString(sc.getContextPath()));
}
}
wac.setServletContext(sc);
String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);
if (configLocationParam != null) {
wac.setConfigLocation(configLocationParam);
}
ConfigurableEnvironment env = wac.getEnvironment();
if (env instanceof ConfigurableWebEnvironment) {
((ConfigurableWebEnvironment) env).initPropertySources(sc, null);
}
customizeContext(sc, wac);
wac.refresh();
}
還是一樣，關注重點代碼?？匆幌翪ONFIG_LOCATION_PARAM這個常量的值是”contextConfigLocation”，OK，這個就是web.xml中配置applicationContext.xml的。這個參數如果沒有配置，在XmlWebApplicationContext中是有默認值的，具體的值如下。
public static final String DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml";
也就是說，如果沒有配置contextConfigLocation參數，將會使用/WEB-INF/applicationContext.xml。關注configureAndRefreshWebApplicationContext方法的最后一行代碼wac.refresh()，是不是有點眼熟，繼續跟蹤代碼，refresh方法的具體代碼如下。
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
prepareRefresh();
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
prepareBeanFactory(beanFactory);
try {
postProcessBeanFactory(beanFactory);
invokeBeanFactoryPostProcessors(beanFactory);
registerBeanPostProcessors(beanFactory);
initMessageSource();
initApplicationEventMulticaster();
onRefresh();
registerListeners();
finishBeanFactoryInitialization(beanFactory);
finishRefresh();
}catch (BeansException ex) {
logger.warn("Exception encountered during context initialization - cancelling refresh attempt", ex);
destroyBeans();
cancelRefresh(ex);
throw ex;
}
}
}
這個refresh方法就是《深入理解Spring系列之四：BeanDefinition裝載前奏曲》介紹的那個refresh方法，用于完成Bean的解析、實例化及注冊。
繼續分析，回到initWebApplicationContext方法，將執行如下代碼。
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
可以看到，這里將初始化后的context存到了servletContext中，具體的就是存到了一個Map變量中，key值就是WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE這個常量。
使用Spring的WebApplicationContextUtils工具類獲取這個WebApplicationContext方式如下。
WebApplicationContext applicationContext = WebApplicationContextUtils.getWebApplicationContext(request.getServletContext());
