1 Spring MVC WEB配置

Spring Framework自身没有Web性能,Spring MVC应用WebApplicationContext类扩大ApplicationContext,使得领有web性能。那么,Spring MVC是如何在web环境中创立IoC容器呢?web环境中的IoC容器的构造又是什么构造呢?web环境中,Spring IoC容器是怎么启动呢?

以Tomcat为例,在Web容器中应用Spirng MVC,必须进行四项的配置:

  1. 批改web.xml,增加servlet定义;
  2. 编写servletname-servlet.xml(servletname是在web.xm中配置DispactherServlet时使servlet-name的值)配置;
  3. contextConfigLocation初始化参数、配置ContextLoaderListerner;

Web.xml配置如下

 <!-- servlet定义:前端处理器,承受的HTTP申请和转发申请的类 -->    <servlet>        <servlet-name>court</servlet-name>        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>        <init-param>            <!-- court-servlet.xml:定义WebAppliactionContext上下文中的bean -->            <param-name>contextConfigLocation</param-name>            <param-value>classpath*:court-servlet.xml</param-value>        </init-param>        <load-on-startup>0</load-on-startup>    </servlet>                 <servlet-mapping>        <servlet-name>court</servlet-name>        <url-pattern>/</url-pattern>    </servlet-mapping>     <!-- 配置contextConfigLocation初始化参数:指定Spring IoC容器须要读取的定义了非web层的Bean(DAO/Service)的XML文件门路 -->    <context-param>        <param-name>contextConfigLocation</param-name>        <param-value>/WEB-INF/court-service.xml</param-value>    </context-param>     <!-- 配置ContextLoaderListerner:Spring MVC在Web容器中的启动类,负责Spring IoC容器在Web上下文中的初始化 -->    <listener>        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>    </listener>复制代码

如果感觉看完文章有所播种的话,能够关注我一下哦
知乎:秃顶之路
b站:linux亦有归途
每天都会更新咱们的公开课录播以及编程干货和大厂面经
或者间接点击链接c/c++ linux服务器开发高级架构师
来课堂上跟咱们讲师面对面交换
须要大厂面经跟学习纲要的小伙伴能够加群973961276获取

在web.xml配置文件中,有两个次要的配置:ContextLoaderListener和DispatcherServlet。同样的对于spring配置文件的相干配置也有两局部:context-param和DispatcherServlet中的init-param。那么,这两局部的配置有什么区别呢?它们都负责什么样的职责呢?

在Spring MVC中,Spring Context是以父子的继承构造存在的。Web环境中存在一个ROOT Context,这个Context是整个利用的根上下文,是其余context的双亲Context。同时Spring MVC也对应的持有一个独立的Context,它是ROOT Context的子上下文。

对于这样的Context构造在Spring MVC中是如何实现的呢?上面就先从ROOT Context动手,ROOT Context是在ContextLoaderListener中配置的,ContextLoaderListener读取context-param中的contextConfigLocation指定的配置文件,创立ROOT Context

Spring MVC启动过程大抵分为两个过程:

  1. ContextLoaderListener初始化,实例化IoC容器,并将此容器实例注册到ServletContext中;
  2. DispatcherServlet初始化;

2 Web容器中Spring根上下文的加载与初始化

Web容器调用contextInitialized办法初始化ContextLoaderListener,在此办法中,ContextLoaderListener通过调用继承自ContextLoader的initWebApplicationContext办法实例化Spring Ioc容器。

  1. 先看一下WebApplicationContext是如何扩大ApplicationContext来增加对Web环境的反对的。WebApplicationContext接口定义如下:
 public interface WebApplicationContext extends ApplicationContext {        //根上下文在ServletContext中的名称        String ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.class.getName() + ".ROOT";        //获得web容器的ServletContext        ServletContext getServletContext();    }复制代码
  1. 上面看一下ContextLoaderListener中创立context的源码:ContextLoader.java
 public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {        //PS : ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE=WebApplicationContext.class.getName() + ".ROOT" 根上下文的名称        //PS : 默认状况下,配置文件的地位和名称是: DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml"         //在整个web利用中,只能有一个根上下文        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) {                // 在这里执行了创立WebApplicationContext的操作                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);                }            }            // PS: 将根上下文搁置在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;        }    }复制代码
  1. 再看一下WebApplicationContext对象是如何创立的:ContextLoader.java
 protected WebApplicationContext createWebApplicationContext(ServletContext sc, ApplicationContext parent) {        //依据web.xml中的配置决定应用何种WebApplicationContext。默认状况下应用XmlWebApplicationContext        //web.xml中相干的配置context-param的名称“contextClass”        Class<?> contextClass = determineContextClass(sc);        if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {            throw new ApplicationContextException("Custom context class [" + contextClass.getName() + "] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");        }        //实例化WebApplicationContext的实现类        ConfigurableWebApplicationContext wac = (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);        // Assign the best possible id value.        if (sc.getMajorVersion() == 2 && sc.getMinorVersion() < 5) {        // Servlet <= 2.4: resort to name specified in web.xml, if any.            String servletContextName = sc.getServletContextName();            if (servletContextName != null) {                wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + servletContextName);            } else {        wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX);            }        } else {            // Servlet 2.5's getContextPath available!            wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + sc.getContextPath());        }        wac.setParent(parent);        wac.setServletContext(sc);        //设置spring的配置文件        wac.setConfigLocation(sc.getInitParameter(CONFIG_LOCATION_PARAM));        customizeContext(sc, wac);        //spring容器初始化        wac.refresh();        return wac;    }复制代码
  1. ContextLoaderListener构建Root Context时序图:

3 Spring MVC对应的上下文加载与初始化

Spring MVC中外围的类是DispatcherServlet,在这个类中实现Spring context的加载与创立,并且可能依据Spring Context的内容将申请分发给各个Controller类。DispatcherServlet继承自HttpServlet,对于Spring Context的配置文件加载和创立是在 init()办法中进行的,次要的调用程序是init-->initServletBean-->initWebApplicationContext

  1. 先来看一下initWebApplicationContext的实现:FrameworkServlet.java
 protected WebApplicationContext initWebApplicationContext() {        //先从web容器的ServletContext中查找WebApplicationContext        WebApplicationContext wac = findWebApplicationContext();        if (wac == null) {            // No fixed context defined for this servlet - create a local one.            //从ServletContext中获得根上下文            WebApplicationContext parent = WebApplicationContextUtils.getWebApplicationContext(getServletContext());            //创立Spring MVC的上下文,并将根上下文作为起双亲上下文            wac = createWebApplicationContext(parent);        }        if (!this.refreshEventReceived) {            // Apparently not a ConfigurableApplicationContext with refresh support:            // triggering initial onRefresh manually here.            onRefresh(wac);        }        if (this.publishContext) {            // Publish the context as a servlet context attribute.            // 获得context在ServletContext中的名称            String attrName = getServletContextAttributeName();            //将Spring MVC的Context搁置到ServletContext中            getServletContext().setAttribute(attrName, wac);            if (this.logger.isDebugEnabled()) {                this.logger.debug("Published WebApplicationContext of servlet '" + getServletName() + "' as ServletContext attribute with name [" + attrName + "]");            }        }            return wac;    }复制代码

通过initWebApplicationContext办法的调用,创立了DispatcherServlet对应的context,并将其搁置到ServletContext中,这样就实现了在web容器中构建Spring IoC容器的过程。

  1. DispatcherServlet创立context时序图:

  1. DispatcherServlet初始化的大体流程:

  1. 控制器DispatcherServlet的类图及继承关系:

4 Spring中DispacherServlet、WebApplicationContext、ServletContext的关系

要想很好了解这三个上下文的关系,须要先相熟Spring是怎么在web容器中启动起来的。Spring的启动过程其实就是其IOC容器的启动过程,对于web程序,IOC容器启动过程即是建设上下文的过程。

Spring的启动过程:

  1. 首先,对于一个web利用,其部署在web容器中,web容器提供其一个全局的上下文环境,这个上下文就是ServletContext,其为前面的spring IoC容器提供宿主环境;
  2. 其次,在web.xml中会提供有contextLoaderListener。在web容器启动时,会触发容器初始化事件,此时contextLoaderListener会监听到这个事件,其contextInitialized办法会被调用,在这个办法中,spring会初始化一个启动上下文,这个上下文被称为根上下文,即WebApplicationContext,这是一个接口类,确切的说,其理论的实现类是XmlWebApplicationContext。 这个就是spring的IoC容器,其对应的Bean定义的配置由web.xml中的context-param标签指定。在这个IoC容器初始化结束后,spring以 WebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTE 为属性Key,将其存储到ServletContext中,便于获取;
  3. 再次,contextLoaderListener监听器初始化结束后,开始初始化web.xml中配置的Servlet,这个servlet能够配置多个,以最常见的DispatcherServlet为例,这个servlet实际上是一个规范的前端控制器,用以转发、匹配、解决每个servlet申请。DispatcherServlet上下文在初始化的时候会建设本人的IoC上下文,用以持有spring mvc相干的bean。在建设DispatcherServlet本人的IoC上下文时,会利用 WebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTE 先从ServletContext中获取之前的根上下文(即WebApplicationContext)作为本人上下文的parent上下文。有了这个parent上下文之后,再初始化本人持有的上下文。这个DispatcherServlet初始化本人上下文的工作在其initStrategies办法中能够看到,大略的工作就是初始化处理器映射、视图解析等。这个servlet本人持有的上下文默认实现类也是XmlWebApplicationContext。初始化结束后,spring以与servlet的名字相干(此处不是简略的以servlet名为Key,而是通过一些转换,具体可自行查看源码)的属性为属性Key,也将其存到ServletContext中,以便后续应用。这样每个servlet就持有本人的上下文,即领有本人独立的bean空间,同时各个servlet共享雷同的bean,即根上下文(第2步中初始化的上下文)定义的那些bean。

在Web容器(比方Tomcat)中配置Spring时,你可能曾经司空见惯于web.xml文件中的以下配置代码:

 <context-param>        <param-name>contextConfigLocation</param-name>        <param-value>/WEB-INF/applicationContext.xml</param-value>    </context-param>                                                                                                                                                 <listener>        <listener-class>            org.springframework.web.context.ContextLoaderListener        </listener-class>    </listener>                                                                                                                                                 <servlet>        <servlet-name>mvc-dispatcher</servlet-name>        <servlet-class>            org.springframework.web.servlet.DispatcherServlet        </servlet-class>        <load-on-startup>1</load-on-startup>    </servlet>                                                                                                                                             <servlet-mapping>        <servlet-name>mvc-dispatcher</servlet-name>        <url-pattern>/</url-pattern>    </servlet-mapping></span>复制代码

以上配置 首先会在ContextLoaderListener中通过<context-param>中的applicationContext.xml创立一个ApplicationContext,再将这个ApplicationContext塞到ServletContext外面,通过ServletContext的setAttribute办法达到此目标,在ContextLoaderListener的源代码中,咱们能够看到这样的代码:

servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);复制代码

以上由ContextLoaderListener创立的ApplicationContext是共享于整个Web应用程序的,而你可能早曾经晓得,DispatcherServlet会维持一个本人的ApplicationContext,默认会读取/WEB-INFO/<dispatcherServletName>-servlet.xml文件,而也能够重新配置:

 <servlet>          <servlet-name>             customConfiguredDispacherServlet          </servlet-name>          <servlet-class>              org.springframework.web.servlet.DispatcherServlet          </servlet-class>          <init-param>              <param-name>                  contextConfigLocation              </param-name>              <param-value>                  /WEB-INF/dispacherServletContext.xml              </param-value>          </init-param>          <load-on-startup>1</load-on-startup>      </servlet>复制代码

问题是:以上两个ApplicationContext的关系是什么,它们的作用作用范畴别离是什么,它们的用处别离是什么?

ContextLoaderListener中创立ApplicationContext次要用于整个Web应用程序须要共享的一些组件,比方DAO,数据库的ConnectionFactory等。而 由DispatcherServlet创立的ApplicationContext次要用于和该Servlet相干的一些组件,比方Controller、ViewResovler等。

对于作用范畴而言,在DispatcherServlet中能够援用由ContextLoaderListener所创立的ApplicationContext,而反过来不行。

在Spring的具体实现上,这两个ApplicationContext都是通过ServletContext的setAttribute办法放到ServletContext中的。然而,ContextLoaderListener会先于DispatcherServlet创立ApplicationContext,DispatcherServlet在创立ApplicationContext时会先找到由ContextLoaderListener所创立的ApplicationContext,再将后者的ApplicationContext作为参数传给DispatcherServlet的ApplicationContext的setParent()办法,在Spring源代码中,你能够在FrameServlet.java中找到如下代码:

wac.setParent(parent);复制代码

其中,wac即为由DisptcherServlet创立的ApplicationContext,而parent则为有ContextLoaderListener创立的ApplicationContext。尔后,框架又会调用ServletContext的setAttribute()办法将wac退出到ServletContext中。

当Spring在执行ApplicationContext的getBean时,如果在本人context中找不到对应的bean,则会在父ApplicationContext中去找。这也解释了为什么咱们能够在DispatcherServlet中获取到由ContextLoaderListener对应的ApplicationContext中的bean。