寫在前面
本文分為兩大板塊
監聽器ContextLoaderListener源碼分析
DispatchServlet初始化源碼分析
容器啟動時執行的順序
web.xml中定義的絕大多數東西是隨著容器的啟動而執行的，比如servlet,filter,listener,contextParam,具體的執行順序為 contextParam->listener->filter->servlet。
監聽器ContextLoaderListener源碼分析
我們在寫SpringMVC項目時都需要在web.xml配置一個listener,我們就從這個listenser開始，看看內部究竟發生了什么。
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
如下為我們配置的監聽器ContextLoaderListener的繼承關系圖。
可以看到ContextLoaderListener繼承了ContextLoader并實現了ServletContextListener接口。
每個實現ServletContextListener的監聽器都必須實現如下兩個方法(contextInitialized()和contextDestroyed()),作用我們從名字上就可以看出來，分別是容器啟動時做一些初始化工作和容器關閉時做一些清理工作。
如下為ContextLoaderListener.java代碼。
public class ContextLoaderListener extends ContextLoader implements ServletContextListener {
public void contextInitialized(ServletContextEvent event) {
//初始化Root WebApplicationContext
initWebApplicationContext(event.getServletContext());
}
public void contextDestroyed(ServletContextEvent event) {
closeWebApplicationContext(event.getServletContext());
ContextCleanupListener.cleanupAttributes(event.getServletContext());
}
}
這里initWebApplicationContext()方法調用的是父類的ContextLoad.initWebApplicationContext()
//ContextLoad.initWebApplicationContext()
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
...
try {
if (this.context == null) {
//this.conext即為Root WebApplicationContext
//如果沒有配置WebApplicationContext的實現類，將使用默認的XmlWebApplicationContext實現類創建WebApplicationContext對象
//傳入servletContext目的是為了讀取配置文件中的context_class參數
this.context = createWebApplicationContext(servletContext);
}
if (this.context instanceof ConfigurableWebApplicationContext) {
ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
if (!cwac.isActive()) {
if (cwac.getParent() == null) {
//設置Root WebApplicationContext的parent，作用個人猜想可能是跟分布式應用有關，
//分布式應用每個分應用都有一個Root WebApplicationContext，現在如果這么多Root WebApplicationContext
//需要共享數據的話就需要一個共同的parent來保存共享的數據了
//在單應用中parent為null
ApplicationContext parent = loadParentContext(servletContext);
cwac.setParent(parent);
}
//將Root WebApplicationContext與ServletContext建立關聯，讀取applicationContext.xml文件并配置Root WebApplicationContext
configureAndRefreshWebApplicationContext(cwac, servletContext);
}
}
//ServletContext與Root WebApplicationContext建立關聯
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
...
return this.context;
}
}
代碼中出現了如下對象 WebApplicationContext,ConfigurableWebApplicationContext , ApplicationContext以及 ServletContext。
- 先來說前二者WebApplicationContext,ConfigurableWebApplicationContext之間的關系:
ConfigurableWebApplicationContext擴展了WebApplicationContext，它允許通過配置化的方式實例化WebApplicationContext。同時定義了兩個重要的方法。
setServletContext(): 為Spring設置Web應用的上下文，以便二者整合。
setConfigLocations(): 設置Spring配置文件地址。
- 接著是ServletContext 和 WebApplicationContext之間的關系。
- 最后為了說明上述的Root WebApplicationContext 和 ApplicationContext parent的關系，我在Spring官網上找到了這么一張圖。
簡單說明各個 WebApplicationContext 的功能:
WebApplicationContext: 與 dispatchServlet 直接相關,通過xxx-servlet.xml文件配置，是 dispatchServlet 的上下文，包含了各種控制器(Controllers)，視圖解析器(ViewResolver)以及映射器(HandlerMapping)。
Root WebApplicationContext: 單應用下為一個，分布式應用會存在多個。通過applicationContext.xml配置。包含各種業務邏輯以及對數據庫進行的操作。
parent: 分布式應用中才會有，為多個共享 Root WebApplicationContext 而生。
至此，我們監聽器ContextLoaderListener的工作就完成了，我們總結如下：
- 創建Root WebApplicationContext并通過ServletContext完成配置。
- 如果是分布式應用將Root WebApplicationContext與parent建立關系。
- 完成ServletContext與Root WebApplicationContext之間的相互關聯。
DispatchServlet的初始化
有關 dispatchServlet 的繼承關系如圖所示：
可以看到，HttpServletBean 和 FramworkServlet 是 dispatchServlet的父類，并且他們都是 HttpServlet的子類。
要想初始化 DispatchServlet，必須先創建出一系列父類對象。
在一個servlet能接受請求并發出響應之前，它需要先完成初始化工作(調用init()方法)。我們在web.xml中只配置了一個servlet(即 dispatchServlet),它隨著容器的啟動而啟動，我們再次強調前面提到過執行順序。
contextParam->listener->filter->servlet
可以看到，servlet在listener之后執行，所以在調用 servlet.init() 方法之前，Root WebApplicationContext已經完成初始化，而 dispatchServlet 初始化的工作就是 完成 WebApplicationContext的初始化。
dispatchServlet 中的init()方法，繼承自父類 HttpSrevletBean 中定義的 init()方法。
如下是 HttpSrevletBean 中的 init()方法，整個 DispatchServlet 的初始化也由此開始。
- 繼承自HttpServletBean的init()方法
public final void init() throws ServletException {
...
try {
//讀取xxx-servlet.xml
PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
//創建BeanWrapper對象
BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
initBeanWrapper(bw);
//通過BeanWrapper設置DispatchServlet的屬性
bw.setPropertyValues(pvs, true);
}
//使子類各自完成初始化
initServletBean();
...
}
注意最后有一個initServletBean()方法，這個 initServletBean() 方法在 HttpSrevletBean 中僅僅聲明一下，具體的實現交由子類 FramworkServlet 去實現，而我們的 DispatchServlet 中的 initServletBean()也正是繼承自 FramworkServlet的 initServletBean()方法。
- 繼承自FramworkServlet的initServletBean()方法
protected final void initServletBean() throws ServletException {
...
long startTime = System.currentTimeMillis();
try {
//初始化webApplicationContext
this.webApplicationContext = initWebApplicationContext();
initFrameworkServlet();
}
...
}
繼續深入initWebApplicationContext()方法內部
protected WebApplicationContext initWebApplicationContext() {
//獲取Root WebApplicationContext
WebApplicationContext rootContext =
WebApplicationContextUtils.getWebApplicationContext(getServletContext());
//定義WebApplicationContext對象
WebApplicationContext wac = null;
//DispatchServlet有個以WebApplicationContext為參數的構造函數，如果使用以WebApplicationContext為參數的構造函數，則執行這段代碼。
if (this.webApplicationContext != null) {
wac = this.webApplicationContext;
if (wac instanceof ConfigurableWebApplicationContext) {
ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;
if (!cwac.isActive()) {
if (cwac.getParent() == null) {
cwac.setParent(rootContext);
}
configureAndRefreshWebApplicationContext(cwac);
}
}
}
if (wac == null) {
//以contextAttribute屬性(FramworkServlet的String類型屬性)為Key,從ServletContext中找WebApplicationContext
//一般不會設置contextAttribute屬性，也就是說查找結果一般為null
wac = findWebApplicationContext();
}
if (wac == null) {
//創建WebApplicationContext
//后面會深入觀察
wac = createWebApplicationContext(rootContext);
}
if (!this.refreshEventReceived) {
onRefresh(wac);
}
if (this.publishContext) {
// Publish the context as a servlet context attribute.
String attrName = getServletContextAttributeName();
getServletContext().setAttribute(attrName, wac);
}
return wac;
}
繼續深入觀察createWebApplicationContext(rootContext)
protected WebApplicationContext createWebApplicationContext(ApplicationContext parent) {
//找到WebApplicationContext的實現類，默認為XmlWebApplicationContext
Class<?> contextClass = getContextClass();
...
ConfigurableWebApplicationContext wac =
(ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
//對wac進行屬性設置
wac.setEnvironment(getEnvironment());
wac.setParent(parent);
//getContextConfigLocation()返回"xxx-servlet.xml"
wac.setConfigLocation(getContextConfigLocation());
//后面會深入觀察
configureAndRefreshWebApplicationContext(wac);
return wac;
}
繼續深入觀察configureAndRefreshWebApplicationContext(wac)
protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac) {
...
//關聯servletContext
wac.setServletContext(getServletContext());
wac.setServletConfig(getServletConfig());
wac.setNamespace(getNamespace());
wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener()));
ConfigurableEnvironment env = wac.getEnvironment();
if (env instanceof ConfigurableWebEnvironment) {
((ConfigurableWebEnvironment) env).initPropertySources(getServletContext(), getServletConfig());
}
postProcessWebApplicationContext(wac);
applyInitializers(wac);
//刷新WebApplicationContext
wac.refresh();
}
總之，當refresh()方法執行完畢之后，會觸發 繼承自FramworkServlet.onApplicationEvent() 函數，該函數會執行內部的 onRefresh()方法。該方法交由子類 DispatchServlet 去實現。如下是 DispatchServlet部分代碼。
protected void onRefresh(ApplicationContext context) {
initStrategies(context);
}
//通過反射機制查找并裝配用戶自定義的組件，如果找不到則使用默認的組件進行裝配
//默認的裝配組件在org.springframework.web.servlet.DispatchServlet,properties文件中定義
protected void initStrategies(ApplicationContext context) {
//初始化文件上傳解析器
initMultipartResolver(context);
//初始化本地化解析器
initLocaleResolver(context);
//初始化主體解析器
initThemeResolver(context);
//初始化映射
initHandlerMappings(context);
//初始化映射適配器
initHandlerAdapters(context);
//初始化異常處理器
initHandlerExceptionResolvers(context);
//初始化視圖名稱翻譯器
initRequestToViewNameTranslator(context);
//初始化視圖解析器
initViewResolvers(context);
//初始化管理FlashMap的接口，FlashMap用于存儲一個請求的輸出，當進入另一個請求時作為
//請求的輸入，通常用于重定向場景
initFlashMapManager(context);
}
至此，servlet全部初始化完成，就等著第一個請求的到來了,總結為一句話就是：
- 通過調用init()方法初始化 WebApplicationContext,并通過配置文件配置 WebApplicationContext
- 初始化各種解析器
