摘要:類的本質是,通過文章開始的講解可知,在應用部署到容器后進行初始化時會調用相關的方法,因此,類的初始化過程也由該方法開始。上述調用邏輯中比較重要的就是抽象類中的方法方法以及類中的方法,接下來會逐一進行講解。
web應用部署初始化流程
當一個Web應用部署到容器內時(eg.tomcat),在Web應用開始響應執行用戶請求前,以下步驟會被依次執行:
部署描述文件中(eg.tomcat的web.xml)由
對于所有事件監聽器,如果實現了ServletContextListener接口,將會執行其實現的contextInitialized()方法
部署描述文件中由
部署描述文件中由
web初始化流程圖如下:
SpringMVC初始化流程接下來以一個常見的簡單web.xml配置進行Spring MVC啟動過程的分析,web.xml配置內容如下:
Web Application contextConfigLocation classpath:applicationContext-*.xml org.springframework.web.context.ContextLoaderListener CharacterEncodingFilter org.springframework.web.filter.CharacterEncodingFilter encoding utf-8 CharacterEncodingFilter /* springMVC_rest org.springframework.web.servlet.DispatcherServlet 1 default *.css
在web初始化的時候會去加載web.xml文件,會按照配置的內容進行初始化
Listener監聽器初始化首先定義了
接著定義了一個ContextLoaderListener類的listener。查看ContextLoaderListener的類聲明源碼如下圖:
ContextLoaderListener類繼承了ContextLoader類并實現了ServletContextListener接口,首先看一下前面講述的ServletContextListener接口源碼:
該接口只有兩個方法contextInitialized和contextDestroyed,這里采用的是觀察者模式,也稱為為訂閱-發布模式,實現了該接口的listener會向發布者進行訂閱,當Web應用初始化或銷毀時會分別調用上述兩個方法。
繼續看ContextLoaderListener,該listener實現了ServletContextListener接口,因此在Web應用初始化時會調用該方法,該方法的具體實現如下:
* Initialize the root web application context.*/ @Override public void contextInitialized(ServletContextEvent event) { initWebApplicationContext(event.getServletContext()); }
ContextLoaderListener的contextInitialized()方法直接調用了initWebApplicationContext()方法,這個方法是繼承自ContextLoader類,通過函數名可以知道,該方法是用于初始化Web應用上下文,即IoC容器,這里使用的是代理模式,繼續查看ContextLoader類的initWebApplicationContext()方法的源碼如下:
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) { /* 首先通過WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE 這個String類型的靜態變量獲取一個根IoC容器,根IoC容器作為全局變量 存儲在application對象中,如果存在則有且只能有一個 如果在初始化根WebApplicationContext即根IoC容器時發現已經存在 則直接拋出異常,因此web.xml中只允許存在一個ContextLoader類或其子類的對象 */ 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. // 如果當前成員變量中不存在WebApplicationContext則創建一個根WebApplicationContext 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. //為根WebApplicationContext設置一個父容器 ApplicationContext parent = loadParentContext(servletContext); cwac.setParent(parent); } //配置并刷新整個根IoC容器,在這里會進行Bean的創建和初始化 configureAndRefreshWebApplicationContext(cwac, servletContext); } } /* 將創建好的IoC容器放入到application對象中,并設置key為WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE 因此,在SpringMVC開發中可以在jsp中通過該key在application對象中獲取到根IoC容器,進而獲取到相應的Ben */ 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; } }
initWebApplicationContext()方法如上注解講述,主要目的就是創建root WebApplicationContext對象即根IoC容器,其中比較重要的就是,整個Web應用如果存在根IoC容器則有且只能有一個,根IoC容器作為全局變量存儲在ServletContext即application對象中。將根IoC容器放入到application對象之前進行了IoC容器的配置和刷新操作,調用了configureAndRefreshWebApplicationContext()方法,該方法源碼如下:
protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) { if (ObjectUtils.identityToString(wac).equals(wac.getId())) { // The application context id is still set to its original default value // -> assign a more useful id based on available information String idParam = sc.getInitParameter(CONTEXT_ID_PARAM); if (idParam != null) { wac.setId(idParam); } else { // Generate default id... wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + ObjectUtils.getDisplayString(sc.getContextPath())); } } wac.setServletContext(sc); /* CONFIG_LOCATION_PARAM = "contextConfigLocation" 獲取web.xml中標簽配置的全局變量,其中key為CONFIG_LOCATION_PARAM 也就是我們配置的相應Bean的xml文件名,并將其放入到WebApplicationContext中 */ String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM); if (configLocationParam != null) { wac.setConfigLocation(configLocationParam); } // The wac environment"s #initPropertySources will be called in any case when the context // is refreshed; do it eagerly here to ensure servlet property sources are in place for // use in any post-processing or initialization that occurs below prior to #refresh ConfigurableEnvironment env = wac.getEnvironment(); if (env instanceof ConfigurableWebEnvironment) { ((ConfigurableWebEnvironment) env).initPropertySources(sc, null); } customizeContext(sc, wac); wac.refresh(); }
比較重要的就是獲取到了web.xml中的
@Override public void refresh() throws BeansException, IllegalStateException { synchronized (this.startupShutdownMonitor) { // Prepare this context for refreshing. prepareRefresh(); // Tell the subclass to refresh the internal bean factory. ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory(); // Prepare the bean factory for use in this context. prepareBeanFactory(beanFactory); try { // Allows post-processing of the bean factory in context subclasses. postProcessBeanFactory(beanFactory); // Invoke factory processors registered as beans in the context. invokeBeanFactoryPostProcessors(beanFactory); // Register bean processors that intercept bean creation. registerBeanPostProcessors(beanFactory); // Initialize message source for this context. initMessageSource(); // Initialize event multicaster for this context. initApplicationEventMulticaster(); // Initialize other special beans in specific context subclasses. onRefresh(); // Check for listener beans and register them. registerListeners(); // Instantiate all remaining (non-lazy-init) singletons. finishBeanFactoryInitialization(beanFactory); // Last step: publish corresponding event. finishRefresh(); } catch (BeansException ex) { if (logger.isWarnEnabled()) { logger.warn("Exception encountered during context initialization - " + "cancelling refresh attempt: " + ex); } // Destroy already created singletons to avoid dangling resources. destroyBeans(); // Reset "active" flag. cancelRefresh(ex); // Propagate exception to caller. throw ex; } finally { // Reset common introspection caches in Spring"s core, since we // might not ever need metadata for singleton beans anymore... resetCommonCaches(); } } }
該方法主要用于創建并初始化contextConfigLocation類配置的xml文件中的Bean,因此,如果我們在配置Bean時出錯,在Web應用啟動時就會拋出異常,而不是等到運行時才拋出異常。
整個ContextLoaderListener類的啟動過程到此就結束了,可以發現,創建ContextLoaderListener是比較核心的一個步驟,主要工作就是為了創建根IoC容器并使用特定的key將其放入到application對象中,供整個Web應用使用,由于在ContextLoaderListener類中構造的根IoC容器配置的Bean是全局共享的,因此,在
在監聽器listener初始化完成后,按照文章開始的講解,接下來會進行filter的初始化操作,filter的創建和初始化中沒有涉及IoC容器的相關操作,因此不是本文講解的重點,本文舉例的filter是一個用于編碼用戶請求和響應的過濾器,采用utf-8編碼用于適配中文。
Servlet的初始化Servlet的初始化過程可以通過一張圖來總結,如下所示:
通過類圖和相關初始化函數調用的邏輯來看,DispatcherServlet類的初始化過程將模板方法使用的淋漓盡致,其父類完成不同的統一的工作,并預留出相關方法用于子類覆蓋去完成不同的可變工作。
DispatcherServelt類的本質是Servlet,通過文章開始的講解可知,在Web應用部署到容器后進行Servlet初始化時會調用相關的init(ServletConfig)方法,因此,DispatchServlet類的初始化過程也由該方法開始。上述調用邏輯中比較重要的就是FrameworkServlet抽象類中的initServletBean()方法、initWebApplicationContext()方法以及DispatcherServlet類中的onRefresh()方法,接下來會逐一進行講解。
首先來看initServletBean()方法:
@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 { //這里是重點,用于初始化子ApplicationContext對象,主要是用來加載對應的servletName-servlet.xml文件如:springMVC_rest-servlet.xml 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"); } }
接下來來著重分析initWebApplicationContext()方法,
protected WebApplicationContext initWebApplicationContext() { /* 獲取由ContextLoaderListener創建的根IoC容器 獲取根IoC容器有兩種方法,還可通過key直接獲取 */ WebApplicationContext rootContext = WebApplicationContextUtils.getWebApplicationContext(getServletContext()); WebApplicationContext wac = null; if (this.webApplicationContext != null) { // A context instance was injected at construction time -> use it wac = this.webApplicationContext; if (wac instanceof ConfigurableWebApplicationContext) { ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac; 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 -> set // the root application context (if any; may be null) as the parent /* 如果當前Servelt存在一個WebApplicationContext即子IoC容器 并且上文獲取的根IoC容器存在,則將根IoC容器作為子IoC容器的父容器 */ cwac.setParent(rootContext); } //配置并刷新當前的子IoC容器,功能與前文講解根IoC容器時的配置刷新一致,用于構建相關Bean configureAndRefreshWebApplicationContext(cwac); } } } if (wac == null) { // No context instance was injected at construction time -> see if one // has been registered in the servlet context. If one exists, it is assumed // that the parent context (if any) has already been set and that the // user has performed any initialization such as setting the context id //如果當前Servlet不存在一個子IoC容器則去查找一下 wac = findWebApplicationContext(); } if (wac == null) { // No context instance is defined for this servlet -> create a local one //如果仍舊沒有查找到子IoC容器則創建一個子IoC容器 wac = createWebApplicationContext(rootContext); } if (!this.refreshEventReceived) { // Either the context is not a ConfigurableApplicationContext with refresh // support or the context injected at construction time had already been // refreshed -> trigger initial onRefresh manually here. //調用子類覆蓋的onRefresh方法完成“可變”的初始化過程 onRefresh(wac); } if (this.publishContext) { // Publish the context as a servlet context attribute. String attrName = getServletContextAttributeName(); getServletContext().setAttribute(attrName, wac); if (this.logger.isDebugEnabled()) { this.logger.debug("Published WebApplicationContext of servlet "" + getServletName() + "" as ServletContext attribute with name [" + attrName + "]"); } } return wac; }
通過函數名不難發現,該方法的主要作用同樣是創建一個WebApplicationContext對象,即Ioc容器,不過前文講過每個Web應用最多只能存在一個根IoC容器,這里創建的則是特定Servlet擁有的子IoC容器,可能有些讀者會有疑問,為什么需要多個Ioc容器,首先介紹一個父子IoC容器的訪問特性,有興趣的讀者可以自行實驗。
父子IoC容器的訪問特性在學習Spring時,我們都是從讀取xml配置文件來構造IoC容器,常用的類有ClassPathXmlApplicationContext類,該類存在一個初始化方法用于傳入xml文件路徑以及一個父容器,我們可以創建兩個不同的xml配置文件并實現如下代碼:
//applicationContext1.xml文件中配置一個id為baseBean的Bean ApplicationContext baseContext = new ClassPathXmlApplicationContext("applicationContext1.xml"); Object obj1 = baseContext.getBean("baseBean"); System.out.println("baseContext Get Bean " + obj1); //applicationContext2.xml文件中配置一個id未subBean的Bean ApplicationContext subContext = new ClassPathXmlApplicationContext(new String[]{"applicationContext2.xml"}, baseContext); Object obj2 = subContext.getBean("baseBean"); System.out.println("subContext get baseContext Bean " + obj2); Object obj3 = subContext.getBean("subBean"); System.out.println("subContext get subContext Bean " + obj3); //拋出NoSuchBeanDefinitionException異常 Object obj4 = baseContext.getBean("subBean"); System.out.println("baseContext get subContext Bean " + obj4);
首先創建baseContext沒有為其設置父容器,接著可以成功獲取id為baseBean的Bean,接著創建subContext并將baseContext設置為其父容器,subContext可以成功獲取baseBean以及subBean,最后試圖使用baseContext去獲取subContext中定義的subBean,此時會拋出異常NoSuchBeanDefinitionException,由此可見,父子容器類似于類的繼承關系,子類可以訪問父類中的成員變量,而父類不可訪問子類的成員變量,同樣的,子容器可以訪問父容器中定義的Bean,但父容器無法訪問子容器定義的Bean。
通過上述實驗我們可以理解為何需要創建多個Ioc容器,根IoC容器做為全局共享的IoC容器放入Web應用需要共享的Bean,而子IoC容器根據需求的不同,放入不同的Bean,這樣能夠做到隔離,保證系統的安全性。
接下來繼續講解DispatcherServlet類的子IoC容器創建過程,如果當前Servlet存在一個IoC容器則為其設置根IoC容器作為其父類,并配置刷新該容器,用于構造其定義的Bean,這里的方法與前文講述的根IoC容器類似,同樣會讀取用戶在web.xml中配置的
createWebApplicationContext()方法去創建一個,查看該方法的源碼如下圖所示:
該方法用于創建一個子IoC容器并將根IoC容器做為其父容器,接著進行配置和刷新操作用于構造相關的Bean。至此,根IoC容器以及相關Servlet的子IoC容器已經配置完成,子容器中管理的Bean一般只被該Servlet使用,因此,其中管理的Bean一般是“局部”的,如SpringMVC中需要的各種重要組件,包括Controller、Interceptor、Converter、ExceptionResolver等。相關關系如下圖所示:
當IoC子容器構造完成后調用了onRefresh()方法,該方法的調用與initServletBean()方法的調用相同,由父類調用但具體實現由子類覆蓋,調用onRefresh()方法時將前文創建的IoC子容器作為參數傳入,查看DispatcherServletBean類的onRefresh()方法源碼如下:
@Override protected void onRefresh(ApplicationContext context) { initStrategies(context); } /** * Initialize the strategy objects that this servlet uses. *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); }
onRefresh()方法直接調用了initStrategies()方法,源碼如上,通過函數名可以判斷,該方法用于初始化創建multipartResovle來支持圖片等文件的上傳、本地化解析器、主題解析器、HandlerMapping處理器映射器、HandlerAdapter處理器適配器、異常解析器、視圖解析器、flashMap管理器等,這些組件都是SpringMVC開發中的重要組件,相關組件的初始化創建過程均在此完成。
由于篇幅問題本文不再進行更深入的探討,有興趣的讀者可以閱讀本系列文章的其他博客內容。
至此,DispatcherServlet類的創建和初始化過程也就結束了,整個Web應用部署到容器后的初始化啟動過程的重要部分全部分析清楚了,通過前文的分析我們可以認識到層次化設計的優點,以及IoC容器的繼承關系所表現的隔離性。分析源碼能讓我們更清楚的理解和認識到相關初始化邏輯以及配置文件的配置原理。
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/73341.html
摘要:引言剛考完期末,再也不用考試啦最近學習了慕課網的實戰課手寫,劍指開源框架靈魂。最近將本課程和看透結合起來學習,感覺受益匪淺,同時,糾正了我之前對的一些誤解。誤解洪荒時代的當年,開發都需要手動去實現。為了解決太多的問題,引入了,進行統一調度。 引言 剛考完期末,再也不用考試啦?。。?最近學習了慕課網的實戰課《手寫SpringMVC,劍指開源框架靈魂》。 showImg(https://s...
摘要:先用一個圖來表示基本流程圖這個網上很容易找到基本流程圖用戶發送請求到前端控制器前端控制器是的重要部分,位于中心,提供整個框架訪問點,起到交換的作用,而且與容器集成。在配置這個監聽器,啟動容器時,就會默認執行它實現的方法。 先用一個圖來表示基本流程圖這個網上很容易找到 基本流程圖 showImg(https://segmentfault.com/img/bVbfDiV?w=1340&h...
摘要:簡介注解用于修飾的方法,根據的的內容,通過適當的轉換為客戶端需要格式的數據并且寫入到的數據區,從而不通過視圖解析器直接將數據響應給客戶端。并且這些解析器都實現了接口,在接口中有四個最為主要的接口方法。 SpringMVC 細節方面的東西很多,所以在這里做一篇簡單的 SpringMVC 的筆記記錄,方便以后查看。 Spring MVC是當前最優秀的MVC框架,自從Spring 2.5版本...
摘要:顧名思義,是一個框架?;玖鞒虒樱l出請求,處理邏輯,并調用處理層相關操作。編寫層,來處理邏輯表明這是一個,并且會被容器進行初始化。請求的映射,就是后的路徑。并在層用取出來。 SpringMVC -顧名思義,是一個MVC框架。即可以處理View,Model,controller的一個框架。 基本流程 -View層,發出請求,controller處理邏輯,并調用Model處理Dao層相關...
閱讀 649·2021-11-11 16:55
閱讀 2160·2021-11-11 16:55
閱讀 1951·2021-11-11 16:55
閱讀 2341·2021-10-25 09:46
閱讀 1598·2021-09-22 15:20
閱讀 2270·2021-09-10 10:51
閱讀 1703·2021-08-25 09:38
閱讀 2613·2019-08-30 12:48