深入分析Spring與SpringMVC容器
1 Spring MVC WEB配置
Spring Framework本身沒有Web功能，Spring MVC使用WebApplicationContext類擴展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容器是怎么啟動呢？
成都創(chuàng)新互聯(lián)公司專注于深圳企業(yè)網(wǎng)站建設(shè),響應(yīng)式網(wǎng)站建設(shè),成都商城網(wǎng)站開發(fā)。深圳網(wǎng)站建設(shè)公司,為深圳等地區(qū)提供建站服務(wù)。全流程定制制作，專業(yè)設(shè)計，全程項目跟蹤，成都創(chuàng)新互聯(lián)公司專業(yè)和態(tài)度為您提供的服務(wù)
以Tomcat為例，在Web容器中使用Spirng MVC，必須進行四項的配置：
修改web.xml，添加servlet定義；
編寫servletname-servlet.xml（servletname是在web.xm中配置DispactherServlet時使servlet-name的值）配置；
contextConfigLocation初始化參數(shù)、配置ContextLoaderListerner；
Web.xml配置如下：
court
org.springframework.web.servlet.DispatcherServlet
contextConfigLocation
classpath*:court-servlet.xml
0
court
/
contextConfigLocation
/WEB-INF/court-service.xml
org.springframework.web.context.ContextLoaderListener
在web.xml配置文件中，有兩個主要的配置：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)境中存在一個ROOT Context，這個Context是整個應(yīng)用的根上下文，是其他context的雙親Context。同時Spring MVC也對應(yīng)的持有一個獨立的Context，它是ROOT Context的子上下文。
對于這樣的Context結(jié)構(gòu)在Spring MVC中是如何實現(xiàn)的呢？下面就先從ROOT Context入手，ROOT Context是在ContextLoaderListener中配置的，ContextLoaderListener讀取context-param中的contextConfigLocation指定的配置文件，創(chuàng)建ROOT Context。
Spring MVC啟動過程大致分為兩個過程：
ContextLoaderListener初始化，實例化IoC容器，并將此容器實例注冊到ServletContext中；
DispatcherServlet初始化；
2、Web容器中Spring根上下文的加載與初始化
Web容器調(diào)用contextInitialized方法初始化ContextLoaderListener，在此方法中，ContextLoaderListener通過調(diào)用繼承自ContextLoader的initWebApplicationContext方法實例化Spring Ioc容器。
1、先看一下WebApplicationContext是如何擴展ApplicationContext來添加對Web環(huán)境的支持的。WebApplicationContext接口定義如下：
public interface WebApplicationContext extends ApplicationContext {
//根上下文在ServletContext中的名稱
String ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.class.getName() + ".ROOT";
//取得web容器的ServletContext
ServletContext getServletContext();
}2、下面看一下ContextLoaderListener中創(chuàng)建context的源碼：ContextLoader.java
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
//PS : ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE=WebApplicationContext.class.getName() + ".ROOT" 根上下文的名稱
//PS : 默認情況下，配置文件的位置和名稱是： DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml"
//在整個web應(yīng)用中，只能有一個根上下文
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;
}
}2、再看一下WebApplicationContext對象是如何創(chuàng)建的：ContextLoader.java
protected WebApplicationContext createWebApplicationContext(ServletContext sc, ApplicationContext parent) {
//根據(jù)web.xml中的配置決定使用何種WebApplicationContext。默認情況下使用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() + "]");
}
//實例化WebApplicationContext的實現(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時序圖：
3 Spring MVC對應(yīng)的上下文加載與初始化
Spring MVC中核心的類是DispatcherServlet，在這個類中完成Spring context的加載與創(chuàng)建，并且能夠根據(jù)Spring Context的內(nèi)容將請求分發(fā)給各個Controller類。DispatcherServlet繼承自HttpServlet，關(guān)于Spring Context的配置文件加載和創(chuàng)建是在 init()方法中進行的，主要的調(diào)用順序是init-->initServletBean-->initWebApplicationContext。
1、先來看一下initWebApplicationContext的實現(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;
}通過initWebApplicationContext方法的調(diào)用，創(chuàng)建了DispatcherServlet對應(yīng)的context，并將其放置到ServletContext中，這樣就完成了在web容器中構(gòu)建Spring IoC容器的過程。
2、DispatcherServlet創(chuàng)建context時序圖：
3、DispatcherServlet初始化的大體流程：
4、控制器DispatcherServlet的類圖及繼承關(guān)系：
4 Spring中DispacherServlet、WebApplicationContext、ServletContext的關(guān)系
要想很好理解這三個上下文的關(guān)系，需要先熟悉Spring是怎樣在web容器中啟動起來的。Spring的啟動過程其實就是其IOC容器的啟動過程，對于web程序，IOC容器啟動過程即是建立上下文的過程。
Spring的啟動過程：
1、首先，對于一個web應(yīng)用，其部署在web容器中，web容器提供其一個全局的上下文環(huán)境，這個上下文就是ServletContext，其為后面的spring IoC容器提供宿主環(huán)境；
2、其次，在web.xml中會提供有contextLoaderListener。在web容器啟動時，會觸發(fā)容器初始化事件，此時contextLoaderListener會監(jiān)聽到這個事件，其contextInitialized方法會被調(diào)用，在這個方法中，spring會初始化一個啟動上下文，這個上下文被稱為根上下文，即WebApplicationContext，這是一個接口類，確切的說，其實際的實現(xiàn)類是XmlWebApplicationContext。 這個就是spring的IoC容器，其對應(yīng)的Bean定義的配置由web.xml中的context-param標(biāo)簽指定。在這個IoC容器初始化完畢后，spring以 WebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTE 為屬性Key，將其存儲到ServletContext中，便于獲取；
3、再次，contextLoaderListener監(jiān)聽器初始化完畢后，開始初始化web.xml中配置的Servlet，這個servlet可以配置多個，以最常見的DispatcherServlet為例，這個servlet實際上是一個標(biāo)準(zhǔn)的前端控制器，用以轉(zhuǎn)發(fā)、匹配、處理每個servlet請求。DispatcherServlet上下文在初始化的時候會建立自己的IoC上下文，用以持有spring mvc相關(guān)的bean。在建立DispatcherServlet自己的IoC上下文時，會利用 WebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTE 先從ServletContext中獲取之前的根上下文(即WebApplicationContext)作為自己上下文的parent上下文。有了這個parent上下文之后，再初始化自己持有的上下文。這個DispatcherServlet初始化自己上下文的工作在其initStrategies方法中可以看到，大概的工作就是初始化處理器映射、視圖解析等。這個servlet自己持有的上下文默認實現(xiàn)類也是XmlWebApplicationContext。初始化完畢后，spring以與servlet的名字相關(guān)(此處不是簡單的以servlet名為Key，而是通過一些轉(zhuǎn)換，具體可自行查看源碼)的屬性為屬性Key，也將其存到ServletContext中，以便后續(xù)使用。這樣每個servlet就持有自己的上下文，即擁有自己獨立的bean空間，同時各個servlet共享相同的bean，即根上下文(第2步中初始化的上下文)定義的那些bean。
在Web容器（比如Tomcat）中配置Spring時，你可能已經(jīng)司空見慣于web.xml文件中的以下配置代碼：
contextConfigLocation
/WEB-INF/applicationContext.xml
org.springframework.web.context.ContextLoaderListener
mvc-dispatcher
org.springframework.web.servlet.DispatcherServlet
1
mvc-dispatcher
/
以上配置 首先會在ContextLoaderListener中通過
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);以上由ContextLoaderListener創(chuàng)建的ApplicationContext是共享于整個Web應(yīng)用程序的，而你可能早已經(jīng)知道，DispatcherServlet會維持一個自己的ApplicationContext，默認會讀取/WEB-INFO/
customConfiguredDispacherServlet
org.springframework.web.servlet.DispatcherServlet
contextConfigLocation
/WEB-INF/dispacherServletContext.xml
1
問題是：以上兩個ApplicationContext的關(guān)系是什么，它們的作用作用范圍分別是什么，它們的用途分別是什么？
ContextLoaderListener中創(chuàng)建ApplicationContext主要用于整個Web應(yīng)用程序需要共享的一些組件，比如DAO，數(shù)據(jù)庫的ConnectionFactory等。而 由DispatcherServlet創(chuàng)建的ApplicationContext主要用于和該Servlet相關(guān)的一些組件，比如Controller、ViewResovler等。
對于作用范圍而言，在DispatcherServlet中可以引用由ContextLoaderListener所創(chuàng)建的ApplicationContext，而反過來不行。
在Spring的具體實現(xiàn)上，這兩個ApplicationContext都是通過ServletContext的setAttribute方法放到ServletContext中的。但是，ContextLoaderListener會先于DispatcherServlet創(chuàng)建ApplicationContext，DispatcherServlet在創(chuàng)建ApplicationContext時會先找到由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。此后，框架又會調(diào)用ServletContext的setAttribute()方法將wac加入到ServletContext中。
當(dāng)Spring在執(zhí)行ApplicationContext的getBean時，如果在自己context中找不到對應(yīng)的bean，則會在父ApplicationContext中去找。這也解釋了為什么我們可以在DispatcherServlet中獲取到由ContextLoaderListener對應(yīng)的ApplicationContext中的bean。
本文名稱：深入分析Spring與SpringMVC容器
當(dāng)前路徑：http://m.jiaotiyi.com/article/piicjp.html