1 Spring MVC WEB配置
Spring Framework本身沒(méi)有Web功能卤恳，Spring MVC使用WebApplicationContext類擴(kuò)展ApplicationContext，使得擁有web功能恶导。那么烛占，Spring MVC是如何在web環(huán)境中創(chuàng)建IoC容器呢？web環(huán)境中的IoC容器的結(jié)構(gòu)又是什么結(jié)構(gòu)呢？web環(huán)境中涮母，Spring IoC容器是怎么啟動(dòng)呢？
以Tomcat為例躁愿，在Web容器中使用Spirng MVC叛本，必須進(jìn)行四項(xiàng)的配置：
- 修改web.xml，添加servlet定義彤钟；
- 編寫servletname-servlet.xml（servletname是在web.xm中配置DispactherServlet時(shí)使servlet-name的值）配置来候；
- contextConfigLocation初始化參數(shù)、配置ContextLoaderListerner逸雹；
Web.xml配置如下：
<!-- servlet定義：前端處理器营搅，接受的HTTP請(qǐng)求和轉(zhuǎn)發(fā)請(qǐng)求的類 -->
<servlet>
<servlet-name>court</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<!-- court-servlet.xml：定義WebAppliactionContext上下文中的bean -->
<param-name>contextConfigLocation</param-name>
<param-value>classpath*:court-servlet.xml</param-value>
</init-param>
<load-on-startup>0</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>court</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<!-- 配置contextConfigLocation初始化參數(shù)：指定Spring IoC容器需要讀取的定義了非web層的Bean（DAO/Service）的XML文件路徑 -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/court-service.xml</param-value>
</context-param>
<!-- 配置ContextLoaderListerner：Spring MVC在Web容器中的啟動(dòng)類，負(fù)責(zé)Spring IoC容器在Web上下文中的初始化 -->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
在web.xml配置文件中梆砸，有兩個(gè)主要的配置：ContextLoaderListener和DispatcherServlet转质。同樣的關(guān)于spring配置文件的相關(guān)配置也有兩部分：context-param和DispatcherServlet中的init-param。那么辫樱，這兩部分的配置有什么區(qū)別呢峭拘？它們都擔(dān)任什么樣的職責(zé)呢？
在Spring MVC中狮暑，Spring Context是以父子的繼承結(jié)構(gòu)存在的鸡挠。Web環(huán)境中存在一個(gè)ROOT Context，這個(gè)Context是整個(gè)應(yīng)用的根上下文搬男，是其他context的雙親Context拣展。同時(shí)Spring MVC也對(duì)應(yīng)的持有一個(gè)獨(dú)立的Context，它是ROOT Context的子上下文缔逛。
對(duì)于這樣的Context結(jié)構(gòu)在Spring MVC中是如何實(shí)現(xiàn)的呢备埃？下面就先從ROOT Context入手，ROOT Context是在ContextLoaderListener中配置的褐奴，ContextLoaderListener讀取context-param中的contextConfigLocation指定的配置文件按脚，創(chuàng)建ROOT Context。
Spring MVC啟動(dòng)過(guò)程大致分為兩個(gè)過(guò)程：
- ContextLoaderListener初始化敦冬，實(shí)例化IoC容器辅搬，并將此容器實(shí)例注冊(cè)到ServletContext中；
- DispatcherServlet初始化脖旱；
2 Web容器中Spring根上下文的加載與初始化
Web容器調(diào)用contextInitialized方法初始化ContextLoaderListener堪遂，在此方法中介蛉，ContextLoaderListener通過(guò)調(diào)用繼承自ContextLoader的initWebApplicationContext方法實(shí)例化Spring Ioc容器。
- 先看一下WebApplicationContext是如何擴(kuò)展ApplicationContext來(lái)添加對(duì)Web環(huán)境的支持的溶褪。WebApplicationContext接口定義如下：
public interface WebApplicationContext extends ApplicationContext {
//根上下文在ServletContext中的名稱
String ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.class.getName() + ".ROOT";
//取得web容器的ServletContext
ServletContext getServletContext();
}
- 下面看一下ContextLoaderListener中創(chuàng)建context的源碼：ContextLoader.java
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
//PS : ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE=WebApplicationContext.class.getName() + ".ROOT" 根上下文的名稱
//PS : 默認(rèn)情況下币旧，配置文件的位置和名稱是： DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml"
//在整個(gè)web應(yīng)用中，只能有一個(gè)根上下文
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 {
// Store context in local instance variable, to guarantee that
// it is available on ServletContext shutdown.
if (this.context == null) {
// 在這里執(zhí)行了創(chuàng)建WebApplicationContext的操作
this.context = createWebApplicationContext(servletContext);
}
if (this.context instanceof ConfigurableWebApplicationContext) {
ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
if (!cwac.isActive()) {
// The context has not yet been refreshed -> provide services such as
// setting the parent context, setting the application context id, etc
if (cwac.getParent() == null) {
// The context instance was injected without an explicit parent ->
// determine parent for root web application context, if any.
ApplicationContext parent = loadParentContext(servletContext);
cwac.setParent(parent);
}
configureAndRefreshWebApplicationContext(cwac, servletContext);
}
}
// PS: 將根上下文放置在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;
}
}
- 再看一下WebApplicationContext對(duì)象是如何創(chuàng)建的：ContextLoader.java
protected WebApplicationContext createWebApplicationContext(ServletContext sc, ApplicationContext parent) {
//根據(jù)web.xml中的配置決定使用何種WebApplicationContext猿妈。默認(rèn)情況下使用XmlWebApplicationContext
//web.xml中相關(guān)的配置context-param的名稱“contextClass”
Class<?> contextClass = determineContextClass(sc);
if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
throw new ApplicationContextException("Custom context class [" + contextClass.getName() + "] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");
}
//實(shí)例化WebApplicationContext的實(shí)現(xiàn)類
ConfigurableWebApplicationContext wac = (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
// Assign the best possible id value.
if (sc.getMajorVersion() == 2 && sc.getMinorVersion() < 5) {
// Servlet <= 2.4: resort to name specified in web.xml, if any.
String servletContextName = sc.getServletContextName();
if (servletContextName != null) {
wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + servletContextName);
} else {
wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX);
}
} else {
// Servlet 2.5's getContextPath available!
wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + sc.getContextPath());
}
wac.setParent(parent);
wac.setServletContext(sc);
//設(shè)置spring的配置文件
wac.setConfigLocation(sc.getInitParameter(CONFIG_LOCATION_PARAM));
customizeContext(sc, wac);
//spring容器初始化
wac.refresh();
return wac;
}
- ContextLoaderListener構(gòu)建Root Context時(shí)序圖：
3 Spring MVC對(duì)應(yīng)的上下文加載與初始化
Spring MVC中核心的類是DispatcherServlet吹菱，在這個(gè)類中完成Spring context的加載與創(chuàng)建，并且能夠根據(jù)Spring Context的內(nèi)容將請(qǐng)求分發(fā)給各個(gè)Controller類彭则。DispatcherServlet繼承自HttpServlet毁葱，關(guān)于Spring Context的配置文件加載和創(chuàng)建是在init()方法中進(jìn)行的，主要的調(diào)用順序是init-->initServletBean-->initWebApplicationContext贰剥。
- 先來(lái)看一下initWebApplicationContext的實(shí)現(xiàn)：FrameworkServlet.java
protected WebApplicationContext initWebApplicationContext() {
//先從web容器的ServletContext中查找WebApplicationContext
WebApplicationContext wac = findWebApplicationContext();
if (wac == null) {
// No fixed context defined for this servlet - create a local one.
//從ServletContext中取得根上下文
WebApplicationContext parent = WebApplicationContextUtils.getWebApplicationContext(getServletContext());
//創(chuàng)建Spring MVC的上下文，并將根上下文作為起雙親上下文
wac = createWebApplicationContext(parent);
}
if (!this.refreshEventReceived) {
// Apparently not a ConfigurableApplicationContext with refresh support:
// triggering initial onRefresh manually here.
onRefresh(wac);
}
if (this.publishContext) {
// Publish the context as a servlet context attribute.
// 取得context在ServletContext中的名稱
String attrName = getServletContextAttributeName();
//將Spring MVC的Context放置到ServletContext中
getServletContext().setAttribute(attrName, wac);
if (this.logger.isDebugEnabled()) {
this.logger.debug("Published WebApplicationContext of servlet '" + getServletName() + "' as ServletContext attribute with name [" + attrName + "]");
}
}
return wac;
}
通過(guò)initWebApplicationContext方法的調(diào)用筷频，創(chuàng)建了DispatcherServlet對(duì)應(yīng)的context蚌成，并將其放置到ServletContext中，這樣就完成了在web容器中構(gòu)建Spring IoC容器的過(guò)程凛捏。
- DispatcherServlet創(chuàng)建context時(shí)序圖：
- DispatcherServlet初始化的大體流程：
- 控制器DispatcherServlet的類圖及繼承關(guān)系：
4 Spring中DispacherServlet担忧、WebApplicationContext、ServletContext的關(guān)系
要想很好理解這三個(gè)上下文的關(guān)系坯癣，需要先熟悉Spring是怎樣在web容器中啟動(dòng)起來(lái)的瓶盛。Spring的啟動(dòng)過(guò)程其實(shí)就是其IOC容器的啟動(dòng)過(guò)程，對(duì)于web程序示罗，IOC容器啟動(dòng)過(guò)程即是建立上下文的過(guò)程惩猫。
Spring的啟動(dòng)過(guò)程：
首先，對(duì)于一個(gè)web應(yīng)用蚜点，其部署在web容器中轧房，
web容器提供其一個(gè)全局的上下文環(huán)境，這個(gè)上下文就是ServletContext绍绘，其為后面的spring IoC容器提供宿主環(huán)境奶镶；其次，
在web.xml中會(huì)提供有contextLoaderListener陪拘。在web容器啟動(dòng)時(shí)厂镇，會(huì)觸發(fā)容器初始化事件，此時(shí)contextLoaderListener會(huì)監(jiān)聽到這個(gè)事件左刽，其contextInitialized方法會(huì)被調(diào)用捺信，在這個(gè)方法中，spring會(huì)初始化一個(gè)啟動(dòng)上下文悠反，這個(gè)上下文被稱為根上下文残黑，即WebApplicationContext馍佑，這是一個(gè)接口類，確切的說(shuō)梨水，其實(shí)際的實(shí)現(xiàn)類是XmlWebApplicationContext拭荤。這個(gè)就是spring的IoC容器，其對(duì)應(yīng)的Bean定義的配置由web.xml中的context-param標(biāo)簽指定疫诽。在這個(gè)IoC容器初始化完畢后舅世，spring以WebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTE為屬性Key，將其存儲(chǔ)到ServletContext中奇徒，便于獲瘸恰；再次摩钙，contextLoaderListener監(jiān)聽器初始化完畢后罢低，開始初始化web.xml中配置的Servlet，這個(gè)servlet可以配置多個(gè)胖笛，以最常見的DispatcherServlet為例网持，這個(gè)servlet實(shí)際上是一個(gè)標(biāo)準(zhǔn)的前端控制器，用以轉(zhuǎn)發(fā)长踊、匹配功舀、處理每個(gè)servlet請(qǐng)求。
DispatcherServlet上下文在初始化的時(shí)候會(huì)建立自己的IoC上下文身弊，用以持有spring mvc相關(guān)的bean辟汰。在建立DispatcherServlet自己的IoC上下文時(shí)，會(huì)利用WebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTE先從ServletContext中獲取之前的根上下文(即WebApplicationContext)作為自己上下文的parent上下文阱佛。有了這個(gè)parent上下文之后帖汞，再初始化自己持有的上下文。這個(gè)DispatcherServlet初始化自己上下文的工作在其initStrategies方法中可以看到凑术，大概的工作就是初始化處理器映射涨冀、視圖解析等。這個(gè)servlet自己持有的上下文默認(rèn)實(shí)現(xiàn)類也是XmlWebApplicationContext麦萤。初始化完畢后鹿鳖，spring以與servlet的名字相關(guān)(此處不是簡(jiǎn)單的以servlet名為Key，而是通過(guò)一些轉(zhuǎn)換壮莹，具體可自行查看源碼)的屬性為屬性Key翅帜，也將其存到ServletContext中，以便后續(xù)使用命满。這樣每個(gè)servlet就持有自己的上下文涝滴，即擁有自己獨(dú)立的bean空間，同時(shí)各個(gè)servlet共享相同的bean，即根上下文(第2步中初始化的上下文)定義的那些bean歼疮。
在Web容器（比如Tomcat）中配置Spring時(shí)杂抽，你可能已經(jīng)司空見慣于web.xml文件中的以下配置代碼：
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/applicationContext.xml</param-value>
</context-param>
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
<servlet>
<servlet-name>mvc-dispatcher</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>mvc-dispatcher</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping></span>
以上配置首先會(huì)在ContextLoaderListener中通過(guò)<context-param>中的applicationContext.xml創(chuàng)建一個(gè)ApplicationContext，再將這個(gè)ApplicationContext塞到ServletContext里面韩脏，通過(guò)ServletContext的setAttribute方法達(dá)到此目的缩麸，在ContextLoaderListener的源代碼中，我們可以看到這樣的代碼：
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
以上由ContextLoaderListener創(chuàng)建的ApplicationContext是共享于整個(gè)Web應(yīng)用程序的赡矢，而你可能早已經(jīng)知道杭朱，DispatcherServlet會(huì)維持一個(gè)自己的ApplicationContext，默認(rèn)會(huì)讀取/WEB-INFO/<dispatcherServletName>-servlet.xml文件吹散，而也可以重新配置：
<servlet>
<servlet-name>
customConfiguredDispacherServlet
</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<init-param>
<param-name>
contextConfigLocation
</param-name>
<param-value>
/WEB-INF/dispacherServletContext.xml
</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
問(wèn)題是：以上兩個(gè)ApplicationContext的關(guān)系是什么弧械，它們的作用作用范圍分別是什么，它們的用途分別是什么空民？
ContextLoaderListener中創(chuàng)建ApplicationContext主要用于整個(gè)Web應(yīng)用程序需要共享的一些組件刃唐，比如DAO，數(shù)據(jù)庫(kù)的ConnectionFactory等界轩。而由DispatcherServlet創(chuàng)建的ApplicationContext主要用于和該Servlet相關(guān)的一些組件唁桩，比如Controller、ViewResovler等耸棒。
對(duì)于作用范圍而言，在DispatcherServlet中可以引用由ContextLoaderListener所創(chuàng)建的ApplicationContext报辱，而反過(guò)來(lái)不行与殃。
在Spring的具體實(shí)現(xiàn)上，這兩個(gè)ApplicationContext都是通過(guò)ServletContext的setAttribute方法放到ServletContext中的碍现。但是幅疼，ContextLoaderListener會(huì)先于DispatcherServlet創(chuàng)建ApplicationContext，DispatcherServlet在創(chuàng)建ApplicationContext時(shí)會(huì)先找到由ContextLoaderListener所創(chuàng)建的ApplicationContext昼接，再將后者的ApplicationContext作為參數(shù)傳給DispatcherServlet的ApplicationContext的setParent()方法爽篷，在Spring源代碼中，你可以在FrameServlet.java中找到如下代碼：
wac.setParent(parent);
其中慢睡，wac即為由DisptcherServlet創(chuàng)建的ApplicationContext逐工，而parent則為有ContextLoaderListener創(chuàng)建的ApplicationContext。此后漂辐，框架又會(huì)調(diào)用ServletContext的setAttribute()方法將wac加入到ServletContext中泪喊。
當(dāng)Spring在執(zhí)行ApplicationContext的getBean時(shí)，如果在自己context中找不到對(duì)應(yīng)的bean髓涯，則會(huì)在父ApplicationContext中去找袒啼。這也解釋了為什么我們可以在DispatcherServlet中獲取到由ContextLoaderListener對(duì)應(yīng)的ApplicationContext中的bean。
