全站資源開放下載,感謝廣大網友的支持
鏈接失效請移步職業司平臺
非盈利平臺

非盈利平臺

只為分享一些優質內容

Java幫幫-微信公眾號

Java幫幫-微信公眾號

將分享做到極致

微信小程序

微信小程序

更方便的閱讀

職業司微信公眾號

職業司微信公眾號

實時動態通知

安卓APP

安卓APP

我們從此不分開

程序員生活志-公眾號

程序員生活志-公眾號

程序員生活學習圈,互聯網八卦黑料

支付寶贊助-Java幫幫社區
微信贊助-Java幫幫社區

spring學習:spring與springmvc父子容器【云圖智聯】

1
發表時間:2020-07-22 15:02

1.spring和springmvc父子容器概念介紹

在spring和springmvc進行整合的時候,一般情況下我們會使用不同的配置文件來配置spring和springmvc,因此我們的應用中會存在至少2個ApplicationContext實例,由于是在web應用中,因此最終實例化的是ApplicationContext的子接口WebApplicationContext。如下圖所示:

mvc-context-hierarchy.png

上圖中顯示了2個WebApplicationContext實例,為了進行區分,分別稱之為:Servlet WebApplicationContext、Root WebApplicationContext。 其中:

Servlet WebApplicationContext:這是對J2EE三層架構中的web層進行配置,如控制器(controller)、視圖解析器(view resolvers)等相關的bean。通過spring mvc中提供的DispatchServlet來加載配置,通常情況下,配置文件的名稱為spring-servlet.xml。

Root WebApplicationContext:這是對J2EE三層架構中的service層、dao層進行配置,如業務bean,數據源(DataSource)等。通常情況下,配置文件的名稱為applicationContext.xml。在web應用中,其一般通過ContextLoaderListener來加載。

以下是一個web.xml配置案例:

  1. <?xml version="1.0" encoding="UTF-8"?>  

  2.  

  3. <web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"  

  4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  

  5.     xsi:schemaLocation="http://java.sun.com/xml/ns/javaeehttp://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">  

  6.    

  7.     <!—創建Root WebApplicationContext-->

  8.     <context-param>  

  9.         <param-name>contextConfigLocation</param-name>  

  10.         <param-value>/WEB-INF/spring/applicationContext.xml</param-value>  

  11.     </context-param>  

  12.  

  13.     <listener>  

  14.         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  

  15.     </listener>  

  16.    

  17.     <!—創建Servlet WebApplicationContext-->

  18.     <servlet>  

  19.         <servlet-name>dispatcher</servlet-name>  

  20.         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  

  21.         <init-param>  

  22.             <param-name>contextConfigLocation</param-name>  

  23.             <param-value>/WEB-INF/spring/spring-servlet.xml</param-value>  

  24.         </init-param>  

  25.         <load-on-startup>1</load-on-startup>  

  26.     </servlet>  

  27.     <servlet-mapping>  

  28.         <servlet-name>dispatcher</servlet-name>  

  29.         <url-pattern>/*</url-pattern>  

  30.     </servlet-mapping>  

  31.  

  32. </web-app>

在上面的配置中:

1. ContextLoaderListener會被優先初始化時,其會根據<context-param>元素中contextConfigLocation參數指定的配置文件路徑,在這里就是"/WEB-INF/spring/applicationContext.xml”,來創建WebApplicationContext實例。 并調用ServletContext的setAttribute方法,將其設置到ServletContext中,屬性的key為”org.springframework.web.context.WebApplicationContext.ROOT”,最后的”ROOT"字樣表明這是一個 Root WebApplicationContext。

2.DispatcherServlet在初始化時,會根據<init-param>元素中contextConfigLocation參數指定的配置文件路徑,即"/WEB-INF/spring/spring-servlet.xml”,來創建Servlet WebApplicationContext。同時,其會調用ServletContext的getAttribute方法來判斷是否存在Root WebApplicationContext。如果存在,則將其設置為自己的parent。這就是父子上下文(父子容器)的概念。

父子容器的作用在于,當我們嘗試從child context(即:Servlet WebApplicationContext)中獲取一個bean時,如果找不到,則會委派給parent context (即Root WebApplicationContext)來查找。

如果我們沒有通過ContextLoaderListener來創建Root WebApplicationContext,那么Servlet WebApplicationContext的parent就是null,也就是沒有parent context。

2.為什么要有父子容器

筆者理解,父子容器的作用主要是劃分框架邊界。

在J2EE三層架構中,在service層我們一般使用spring框架, 而在web層則有多種選擇,如spring mvc、struts等。因此,通常對于web層我們會使用單獨的配置文件。例如在上面的案例中,一開始我們使用spring-servlet.xml來配置web層,使用applicationContext.xml來配置service、dao層。如果現在我們想把web層從spring mvc替換成struts,那么只需要將spring-servlet.xml替換成Struts的配置文件struts.xml即可,而applicationContext.xml不需要改變。

事實上,如果你的項目確定了只使用spring和spring mvc的話,你甚至可以將service 、dao、web層的bean都放到spring-servlet.xml中進行配置,并不是一定要將service、dao層的配置單獨放到applicationContext.xml中,然后使用ContextLoaderListener來加載。在這種情況下,就沒有了Root WebApplicationContext,只有Servlet WebApplicationContext。

3.Root WebApplicationContext創建過程源碼分析

ContextLoaderListener用于創建ROOT WebApplicationContext,其實現了ServletContextListener接口的contextInitialized和contextDestroyed方法,在web應用啟動和停止時,web容器(如tomcat)會負責回調這兩個方法。而創建Root WebApplicationContext就是在contextInitialized中完成的,相關源碼片段如下所示:

org.springframework.web.context.ContextLoaderListener

  1. public class ContextLoaderListener extends ContextLoader implements ServletContextListener {

  2.    //...

  3.    @Override

  4.    public void contextInitialized(ServletContextEvent event) {

  5.       initWebApplicationContext(event.getServletContext());

  6.    }

  7.    //...

  8. }

    可以看到ContextLoaderListener繼承了ContextLoader類,真正的創建在操作,是在ContextLoader的initWebApplicationContext方法中完成。

org.springframework.web.context.ContextLoader#initWebApplicationContext

  1. public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {

  2.    //1、保證只能有一個ROOT WebApplicationContext

  3.    //嘗試以”org.springframework.web.context.WebApplicationContext.ROOT”為key從ServletContext中查找WebApplicationContext實例

  4.    //如果已經存在,則拋出異常。

  5.    //一個典型的異常場景是在web.xml中配置了多個ContextLoaderListener,那么后初始化的ContextLoaderListener就會拋出異常

  6.    if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {

  7.       throw new IllegalStateException(

  8.             "Cannot initialize context because there is already a root application context present - " +

  9.             "check whether you have multiple ContextLoader* definitions in your web.xml!");

  10.    }

  11.    

  12.    //2、打印日志,注意日志中的提示內容:"Initializing Spring root WebApplicationContext”

  13.    //這驗證了我們之前的說法,ContextLoaderListener創建的是root WebApplicationContext

  14.    Log logger = LogFactory.getLog(ContextLoader.class);

  15.    servletContext.log("Initializing Spring root WebApplicationContext");

  16.    if (logger.isInfoEnabled()) {

  17.       logger.info("Root WebApplicationContext: initialization started");

  18.    }

  19.    long startTime = System.currentTimeMillis();

  20.    try {

  21.      

  22.       if (this.context == null) {

  23.          // 3 創建WebApplicationContext實現類實例。其內部首先會確定WebApplicationContext實例類型。

  24.         // 首先判斷有沒有<context-param>元素的<param-name>值為contextClass,如果有,則對應的<param-value>值,就是要創建的WebApplicationContext實例類型

  25.         // 如果沒有指定,則默認的實現類為XmlWebApplicationContext。這是在spring-web-xxx.jar包中的ContextLoader.properties指定的

  26.         // 注意這個時候,只是創建了WebApplicationContext對象實例,還沒有加載對應的spring配置文件

  27.          this.context = createWebApplicationContext(servletContext);

  28.       }

  29.       //4 XmlWebApplicationContext實現了ConfigurableWebApplicationContext接口,因此會進入if代碼塊

  30.       if (this.context instanceof ConfigurableWebApplicationContext) {

  31.          ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;

  32.          // 4.1 由于WebApplicationContext對象實例還沒有加載對應配置文件,spring上下文還沒有被刷新,因此isActive返回false,進入if代碼塊

  33.          if (!cwac.isActive()) {

  34.             //4.2 當前ROOT WebApplicationContext的父context為null,則嘗試通過loadParentContext方法獲取父ApplicationContext,并設置到其中

  35.             //由于loadParentContext方法目前寫死返回null,因此可以忽略4.2這個步驟。

  36.             if (cwac.getParent() == null) {

  37.                ApplicationContext parent = loadParentContext(servletContext);

  38.                cwac.setParent(parent);

  39.             }

  40.             //4.3 加載配置spring文件。根據<context-param>指定的contextConfigLocation,確定配置文件的位置。

  41.             configureAndRefreshWebApplicationContext(cwac, servletContext);

  42.          }

  43.       }

  44.       // 5、將創建的WebApplicationContext實例以”org.springframework.web.context.WebApplicationContext.ROOT”為key設置到ServletContext中

  45.       servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);

  46.       ClassLoader ccl = Thread.currentThread().getContextClassLoader();

  47.       if (ccl == ContextLoader.class.getClassLoader()) {

  48.          currentContext = this.context;

  49.       }

  50.       else if (ccl != null) {

  51.          currentContextPerThread.put(ccl, this.context);

  52.       }

  53.       if (logger.isDebugEnabled()) {

  54.          logger.debug("Published root WebApplicationContext as ServletContext attribute with name [" +

  55.                WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE + "]");

  56.       }

  57.       if (logger.isInfoEnabled()) {

  58.          long elapsedTime = System.currentTimeMillis() - startTime;

  59.          logger.info("Root WebApplicationContext: initialization completed in " + elapsedTime + " ms");

  60.       }

  61.       return this.context;

  62.    }

  63.    catch (RuntimeException ex) {

  64.       logger.error("Context initialization failed", ex);

  65.       servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, ex);

  66.       throw ex;

  67.    }

  68.    catch (Error err) {

  69.       logger.error("Context initialization failed", err);

  70.       servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, err);

  71.       throw err;

  72.    }

  73. }

4.Servlet WebApplicationContext創建過程源碼分析

DispatcherServlet負責創建Servlet WebApplicationContext,并嘗試將ContextLoaderListener創建的ROOT WebApplicationContext設置為自己的parent。其類圖繼承關系如下所示:

32F0091A-E822-43D9-9289-400B6744673A.png

其中HttpServletBean繼承了HttpServlet,因此在應用初始化時,其init方法會被調用,如下:

org.springframework.web.servlet.HttpServletBean#init

  1. public final void init() throws ServletException {

  2.    //...

  3.    // 這個方法在HttpServletBean中是空實現

  4.    initServletBean();

  5.    if (logger.isDebugEnabled()) {

  6.       logger.debug("Servlet '" + getServletName() + "' configured successfully");

  7.    }

  8. }

HttpServletBean的init方法中,調用了initServletBean()方法,在HttpServletBean中,這個方法是空實現。FrameworkServlet覆蓋了HttpServletBean中的initServletBean方法,如下:

org.springframework.web.servlet.FrameworkServlet#initServletBean

  1. @Override

  2. protected final void initServletBean() throws ServletException {

  3.    getServletContext().log("Initializing Spring FrameworkServlet '" + getServletName() + "'");

  4.    if (this.logger.isInfoEnabled()) {

  5.       this.logger.info("FrameworkServlet '" + getServletName() + "': initialization started");

  6.    }

  7.    long startTime = System.currentTimeMillis();

  8.    try {

  9.       // initWebApplicationContext方法中,創建了Servlet WebApplicationContext實例

  10.       this.webApplicationContext = initWebApplicationContext();

  11.       initFrameworkServlet();

  12.    }

  13.    catch (ServletException ex) {

  14.       this.logger.error("Context initialization failed", ex);

  15.       throw ex;

  16.    }

  17.    catch (RuntimeException ex) {

  18.       this.logger.error("Context initialization failed", ex);

  19.       throw ex;

  20.    }

  21.    if (this.logger.isInfoEnabled()) {

  22.       long elapsedTime = System.currentTimeMillis() - startTime;

  23.       this.logger.info("FrameworkServlet '" + getServletName() + "': initialization completed in " +

  24.             elapsedTime + " ms");

  25.    }

  26. }

上述代碼片段中,我們可以看到通過調用FrameworkServlet的另一個方法initWebApplicationContext(),來真正創建WebApplicationContext實例,其源碼如下:

org.springframework.web.servlet.FrameworkServlet#initWebApplicationContext

  1. protected WebApplicationContext initWebApplicationContext() {

  2.    //1 通過工具類WebApplicationContextUtils來獲取Root WebApplicationContext

  3.    // 其內部以”org.springframework.web.context.WebApplicationContext.ROOT”為key從ServletContext中查找WebApplicationContext實例作為rootContext

  4.    WebApplicationContext rootContext =

  5.          WebApplicationContextUtils.getWebApplicationContext(getServletContext());

  6.    WebApplicationContext wac = null;

  7.    

  8.    //2、在我們的案例中是通過web.xml配置的DispatcherServlet,此時webApplicationContext為null,因此不會進入以下代碼塊

  9.    if (this.webApplicationContext != null) {

  10.       // A context instance was injected at construction time -> use it

  11.       wac = this.webApplicationContext;

  12.       if (wac instanceof ConfigurableWebApplicationContext) {

  13.          ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;

  14.          if (!cwac.isActive()) {

  15.             // The context has not yet been refreshed -> provide services such as

  16.             // setting the parent context, setting the application context id, etc

  17.             if (cwac.getParent() == null) {

  18.                // The context instance was injected without an explicit parent -> set

  19.                // the root application context (if any; may be null) as the parent

  20.                cwac.setParent(rootContext);

  21.             }

  22.             configureAndRefreshWebApplicationContext(cwac);

  23.          }

  24.       }

  25.    }

  26.    //3 經過第二步,wac依然為null,此時嘗試根據FrameServlet的contextAttribute 字段的值,從ServletContext中獲取Servlet WebApplicationContext實例,在我們的案例中,contextAttribute值為空,因此這一步過后,wac依然為null

  27.    if (wac == null) {

  28.       // No context instance was injected at construction time -> see if one

  29.       // has been registered in the servlet context. If one exists, it is assumed

  30.       // that the parent context (if any) has already been set and that the

  31.       // user has performed any initialization such as setting the context id

  32.       wac = findWebApplicationContext();

  33.    }

  34.  

  35.    //4 開始真正的創建Servlet WebApplicationContext,并將rootContext設置為parent

  36.    if (wac == null) {

  37.       // No context instance is defined for this servlet -> create a local one

  38.       wac = createWebApplicationContext(rootContext);

  39.    }

  40.    if (!this.refreshEventReceived) {

  41.       // Either the context is not a ConfigurableApplicationContext with refresh

  42.       // support or the context injected at construction time had already been

  43.       // refreshed -> trigger initial onRefresh manually here.

  44.       onRefresh(wac);

  45.    }

  46.    if (this.publishContext) {

  47.       // Publish the context as a servlet context attribute.

  48.       String attrName = getServletContextAttributeName();

  49.       getServletContext().setAttribute(attrName, wac);

  50.       if (this.logger.isDebugEnabled()) {

  51.          this.logger.debug("Published WebApplicationContext of servlet '" + getServletName() +

  52.                "' as ServletContext attribute with name [" + attrName + "]");

  53.       }

  54.    }

  55.    return wac;

  56. }

5.java方式配置

最后,對于Root WebApplicationContext和Servlet WebApplicationContext的創建,我們也可以通過java代碼的方式進行配置。spring通過以下幾個類對此提供了支持:

AbstractContextLoaderInitializer:其用于動態的往ServletContext中注冊一個ContextLoaderListener,從而創建Root WebApplicationContext

AbstractDispatcherServletInitializer:其用于動態的往ServletContext中注冊一個DispatcherServlet,從而創建Servlet WebApplicationContext

對應的類圖繼承關系如下所示:

B8A3DA37-3375-4A3F-8311-24C9B6568521.png

AbstractAnnotationConfigDispatcherServletInitializer用于提供AbstractContextLoaderInitializer和AbstractDispatcherServletInitializer所需要的配置。

AbstractAnnotationConfigDispatcherServletInitializer中有3個抽象方法需要實現:

  1. public class MyWebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

  2.     //獲得創建Root WebApplicationContext所需的配置類

  3.     @Override

  4.     protected Class<?>[] getRootConfigClasses() {

  5.         return new Class<?[] { RootConfig.class };

  6.     }

  7.     //獲得創建Servlet WebApplicationContext所需的配置類

  8.     @Override

  9.     protected Class<?>[] getServletConfigClasses() {

  10.         return new Class<?[] { App1Config.class };

  11.     }

  12.     //獲得DispatchServlet攔截的url

  13.     @Override

  14.     protected String[] getServletMappings() {

  15.         return new String[] { "/app1/*" };

  16.     }

  17. }

免費學習視頻歡迎關注云圖智聯:


Java幫幫學習群生態

Java幫幫學習群生態

總有一款能幫到你

Java學習群

Java學習群

與大牛一起交流

大數據學習群

大數據學習群

在數據中成長

九點編程學習群

九點編程學習群

深夜九點學編程

python學習群

python學習群

人工智能,爬蟲

測試學習群

測試學習群

感受測試的魅力

Java幫幫生態承諾

Java幫幫生態承諾

一直堅守,不負重望

初心
勤儉
誠信
正義
分享
友鏈交換:加幫主QQ2524138991 留言即可 24小時內答復  
業司
教育資訊
會員登錄
獲取驗證碼
登錄
登錄
我的資料
留言
回到頂部