SpringMVC加載WebApplicationContext源碼分析

        Spring框架提供了構建Web應用程序的全功能MVC模塊，叫Spring MVC，經過Spring Core+Spring MVC便可搭建一套穩定的Java Web項目。本文經過Spring MVC源碼分析介紹它的核心實現原理。

        Tomcat服務器啓動入口文件是web.xml，經過在其中配置相關的Listener和Servlet便可加載Spring MVC所需數據。基於Spring MVC最簡單的配置以下。

<!-- 加載Spring配置文件 -->
	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>
		classpath:spring-context*.xml
		</param-value>
	</context-param>
	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>
	
	<!-- 加載spring mvc -->
	<servlet>
		<servlet-name>spring3mvc</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>

	<servlet-mapping>
		<servlet-name>spring3mvc</servlet-name>
		<url-pattern>/</url-pattern>
	</servlet-mapping>

建立容器

        ContextLoaderListener基於Web上下文級別的監聽器在啓動服務器時就建立ApplicationContext而且將配置的Spring Bean加載到XML中。

        DispatcherServlet是一個請求分發控制器，全部匹配的URL都會經過該Servlet分發執行，在建立Servlet對象時會初始化Spring MVC相關配置。

        在web.xml中，咱們看到基於ContextLoaderListener和DispatcherServlet均可以配置spring相關的XML，值得說明的是這兩種方式加載spring的ApplicationContext上下文對象不是合併存儲的，

        具體可參考http://blog.csdn.net/madun/article/details/8988860。因此我的建議，基於mvc相關的spring配置由DispatcherServlet加載，而其他的JavaBean都交給ContextLoaderListener加載。

1·ContextLoaderListener

ContextLoaderListener是一個實現了ServletContextListener接口的監聽器，在啓動項目時會觸發contextInitialized方法（該方法主要完成ApplicationContext對象的建立），

在關閉項目時會觸發contextDestroyed方法（該方法會執行ApplicationContext清理操做）。

public class ContextLoaderListener extends ContextLoader implements ServletContextListener

        ConextLoaderListener加載Spring上下文的過程能夠用下圖表示，黃色區塊是核心代碼。

簡單介紹一下上圖的運行流程：

①啓動項目時觸發contextInitialized方法，該方法就作一件事：經過父類contextLoader的initWebApplicationContext方法建立Spring上下文對象。

②initWebApplicationContext方法作了三件事：建立WebApplicationContext；加載對應的Spring文件建立裏面的Bean實例；將WebApplicationContext放入ServletContext（就是Java Web的全局變量）中。

③createWebApplicationContext建立上下文對象，支持用戶自定義的上下文對象，但必須繼承自ConfigurableWebApplicationContext，而Spring MVC默認使用ConfigurableWebApplicationContext做爲ApplicationContext（它僅僅是一個接口）的實現。

④configureAndRefreshWebApplicationContext方法用於封裝ApplicationContext數據而且初始化全部相關Bean對象。它會從web.xml中讀取名爲contextConfigLocation的配置，這就是spring xml數據源設置，而後放到ApplicationContext中，最後調用傳說中的refresh方法執行全部Java對象的建立。

⑤完成ApplicationContext建立以後就是將其放入ServletContext中，注意它存儲的key值常量。

servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
//常量
public static final String ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.class.getName() + ".ROOT";

注：要獲取 ContextLoader級別的IOC容器對象能夠這樣寫：

WebApplicationContext rootContext = WebApplicationContextUtils.getWebApplicationContext(getServletContext());

2· DispatcherServlet

DispatcherServlet是前端控制器設計模式的實現，提供Spring Web MVC的集中訪問點，並且負責職責的分派，並且與Spring IoC容器無縫集成，從而能夠得到Spring的全部好處。

 

要了解DispatcherServlet是如何加載容器，須要先了解它的繼承關係，以下圖所示：

若是在web.xml中設置了Servlet的<load-on-startup>1</load-on-startup>，則表示隨項目啓動，而咱們知道Servelt建立時會首先調用init方法，

因此繼承了HttpServlet的HttpServletBean就是關鍵入口了。那麼整個代碼運行流程以下圖所示。

①HttpServletBean.init方法中執行initServletBean方法進行初始化操做，固然該方法在HttpServletBean是空方法，因此須要子類重寫。

②FrameworkServlet.initServletBean子類不負衆望，重寫了initServletBean方法，該方法最核心的操做就是調用initWebApplicationContext()執行上下文Bean初始化。

③FrameworkServlet.initWebApplicationContext方法首先獲取本身的雙親上下文（也就是ContextLoaderListener初始化成功的WebApplicationContext）；而後建立或者獲取當前Servelet的WebApplicationContext。

④不管是本身建立仍是獲取現有的WebApplicationContext，最終都會讓Servelt級別的WebApplicationContext執行configureAndRefreshWebApplicationContext()方法進行上下文容器初始化。

經過以上幾步便可建立一個完整的IOC容器，而完成容器建立以後，DispatcherServlet還作了一件事：初始化Servelt控制器必備對象，這個是在initWebApplicationContext()方法中經過調用onRefresh(wac)方法實現的。而onRefresh也被重寫過，若是要了解怎麼初始化Servlet控制器必備對象能夠查看DispatcherServlet的onRefresh方法瞭解。

/**
	 * This implementation calls {@link #initStrategies}.
	 */
	@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);
	}