spring的啟動是建筑在servlet容器之上的擎厢,所有web工程的初始位置就是web.xml,它配置了servlet的上下文(context)和監(jiān)聽器(Listener)朵夏,下面就來看看web.xml里面的配置:
<!--上下文監(jiān)聽器蔼啦,用于監(jiān)聽servlet的啟動過程-->
<listener>
<description>ServletContextListener</description>
<!--這里是自定義監(jiān)聽器,個性化定制項目啟動提示-->
<listener-class>com.trace.app.framework.listeners.ApplicationListener</listener-class>
</listener>
<!--dispatcherServlet的配置仰猖,這個servlet主要用于前端控制捏肢,這是springMVC的基礎(chǔ)-->
<servlet>
<servlet-name>service_dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring/services/service_dispatcher-servlet.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<!--spring資源上下文定義奈籽,在指定地址找到spring的xml配置文件-->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring/application_context.xml</param-value>
</context-param>
<!--spring的上下文監(jiān)聽器-->
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
<!--Session監(jiān)聽器,Session作為公共資源存在上下文資源當(dāng)中鸵赫,這里也是自定義監(jiān)聽器-->
<listener>
<listener-class>
com.trace.app.framework.listeners.MySessionListener
</listener-class>
</listener>
接下來就一點的來解析這樣一個啟動過程衣屏。
1. spring的上下文監(jiān)聽器,
代碼如下:
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring/application_context.xml</param-value>
</context-param>
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
spring的啟動其實就是IOC容器的啟動過程奉瘤,通過上述的第一段配置<context-param>
是初始化上下文勾拉,然后通過后一段的的<listener>來加載配置文件煮甥,其中調(diào)用的spring包中的ContextLoaderListener
這個上下文監(jiān)聽器盗温,ContextLoaderListener
是一個實現(xiàn)了ServletContextListener
接口的監(jiān)聽器,他的父類是 ContextLoader
成肘,在啟動項目時會觸發(fā)contextInitialized
上下文初始化方法卖局。下面我們來看看這個方法:
public void contextInitialized(ServletContextEvent event) {
initWebApplicationContext(event.getServletContext());
}
可以看到,這里是調(diào)用了父類ContextLoader
的initWebApplicationContext(event.getServletContext());
方法双霍,很顯然砚偶,這是對ApplicationContext的初始化方法,也就是到這里正是進(jìn)入了springIOC的初始化洒闸。
接下來再來看看initWebApplicationContext
又做了什么工作染坯,先看看代碼:
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) {
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);
}
}
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;
}
這個方法還是有點長的,其實仔細(xì)看看丘逸,出去異常錯誤處理单鹿,這個方法主要做了三件事:
- 創(chuàng)建WebApplicationContext。
- 加載對應(yīng)的spring配置文件中的Bean深纲。
- 將WebApplicationContext放入ServletContext(Java Web的全局變量)中仲锄。
上述代碼中createWebApplicationContext(servletContext)
方法即是完成創(chuàng)建WebApplicationContext工作,也就是說這個方法創(chuàng)建愛你了上下文對象湃鹊,支持用戶自定義上下文對象儒喊,但必須繼承ConfigurableWebApplicationContext,而Spring MVC默認(rèn)使用ConfigurableWebApplicationContext作為ApplicationContext(它僅僅是一個接口)的實現(xiàn)币呵。
再往下走怀愧,有一個方法configureAndRefreshWebApplicationContext
就是用來加載spring配置文件中的Bean實例的。這個方法于封裝ApplicationContext數(shù)據(jù)并且初始化所有相關(guān)Bean對象余赢。它會從web.xml中讀取名為 contextConfigLocation的配置芯义,這就是spring xml數(shù)據(jù)源設(shè)置,然后放到ApplicationContext中没佑,最后調(diào)用傳說中的refresh
方法執(zhí)行所有Java對象的創(chuàng)建毕贼。
最后完成ApplicationContext創(chuàng)建之后就是將其放入ServletContext中,注意它存儲的key值常量蛤奢。
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
key好長qAq鬼癣。
總結(jié)來說如下圖:
- SpringMVC的啟動過程
web.xml的相關(guān)配置:
<servlet>
<servlet-name>service_dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring/services/service_dispatcher-servlet.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
這里采用這種自定義初始化參數(shù)的配置方式陶贼,當(dāng)然也可以使用默認(rèn)的。這里Spring Web MVC框架將加載“classpath:service_dispatcher-servlet.xml”來進(jìn)行初始化上下文而不是“/WEB-INF/[servlet名字]-servlet.xml”待秃。
通過上述配置文件很明顯可以看出拜秧,springMVC的起始位置是DispatcherServlet(還是spring提供的):
public class DispatcherServlet extends FrameworkServlet {
... ...
}
這個類的父類是FrameworkServlet
,FrameworkServlet
又繼承了HttpServletBean
類章郁,HttpServletBean
又繼承了HttpServlet
枉氮,HttpServlet
繼承了GenericServlet
。
public abstract class FrameworkServlet extends HttpServletBean implements ApplicationContextAware {
... ...
}
public abstract class HttpServletBean extends HttpServlet
implements EnvironmentCapable, EnvironmentAware {
... ...
}
public abstract class HttpServlet extends GenericServlet
implements java.io.Serializable
{
... ...
}
所以在這樣一個web容器啟動的時候會調(diào)用HttpServletBean
的init方法暖庄,這個方法覆蓋了GenericServlet中的init方法聊替。讓我我們來看看代碼:
@Override
public final void init() throws ServletException {
if (logger.isDebugEnabled()) {
logger.debug("Initializing servlet '" + getServletName() + "'");
}
// Set bean properties from init parameters.
try {
PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
initBeanWrapper(bw);
bw.setPropertyValues(pvs, true);
}
catch (BeansException ex) {
logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
throw ex;
}
// Let subclasses do whatever initialization they like.
initServletBean();
if (logger.isDebugEnabled()) {
logger.debug("Servlet '" + getServletName() + "' configured successfully");
}
}
該初始化方法的主要作用:將Servlet初始化參數(shù)(init-param)設(shè)置到該組件上(如contextAttribute、contextClass培廓、namespace惹悄、contextConfigLocation),通過BeanWrapper簡化設(shè)值過程肩钠,方便后續(xù)使用泣港;提供給子類初始化擴展點,initServletBean()
价匠,該方法由FrameworkServlet
覆蓋当纱。
FrameworkServlet
繼承HttpServletBean
,通過initServletBean()進(jìn)行Web上下文初始化踩窖,該方法主要覆蓋一下兩件事情:初始化web上下文坡氯;提供給子類初始化擴展點。
@Override
protected final void initServletBean() throws ServletException {
getServletContext().log("Initializing Spring FrameworkServlet '" + getServletName() + "'");
if (this.logger.isInfoEnabled()) {
this.logger.info("FrameworkServlet '" + getServletName() + "': initialization started");
}
long startTime = System.currentTimeMillis();
try {
this.webApplicationContext = initWebApplicationContext();
initFrameworkServlet();
}
catch (ServletException ex) {
this.logger.error("Context initialization failed", ex);
throw ex;
}
catch (RuntimeException ex) {
this.logger.error("Context initialization failed", ex);
throw ex;
}
if (this.logger.isInfoEnabled()) {
long elapsedTime = System.currentTimeMillis() - startTime;
this.logger.info("FrameworkServlet '" + getServletName() + "': initialization completed in " +
elapsedTime + " ms");
}
}
DispatcherServlet繼承FrameworkServlet毙石,并實現(xiàn)了onRefresh()方法提供一些前端控制器相關(guān)的配置廉沮。
整個DispatcherServlet初始化的過程和做了些什么事情,具體主要做了如下兩件事情:
1徐矩、初始化Spring Web MVC使用的Web上下文滞时,并且指定父容器為WebApplicationContext(ContextLoaderListener加載了的根上下文);
2滤灯、初始化DispatcherServlet使用的策略坪稽,如HandlerMapping、HandlerAdapter等鳞骤。
onRefresh方法代碼如下:
@Override
protected void onRefresh(ApplicationContext context) {
initStrategies(context);
}
/**
* Initialize the strategy objects that this servlet uses.
* <p>May be overridden in subclasses in order to initialize further strategy objects.
*/
protected void initStrategies(ApplicationContext context) {
initMultipartResolver(context);
initLocaleResolver(context);
initThemeResolver(context);
initHandlerMappings(context);
initHandlerAdapters(context);
initHandlerExceptionResolvers(context);
initRequestToViewNameTranslator(context);
initViewResolvers(context);
initFlashMapManager(context);
}
總結(jié)
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,這里是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自己持有的上下文默認(rèn)實現(xiàn)類也是 XmlWebApplicationContext
。初始化完畢后锨亏,spring以與servlet的名字相關(guān)(此處不是簡單的以servlet名為 Key痴怨,而是通過一些轉(zhuǎn)換煎殷,具體可自行查看源碼)的屬性為屬性Key,也將其存到ServletContext中腿箩,以便后續(xù)使用豪直。這樣每個servlet 就持有自己的上下文,即擁有自己獨立的bean空間珠移,同時各個servlet共享相同的bean弓乙,即根上下文(第2步中初始化的上下文)定義的那些 bean。