SpringMVC Root WebApplicationContext启动流程

传统的SpringMVC项目中,需要在web.xml中配置ContextlistenerContextLoaderListener是负责引导启动和关闭Spring的Root上下文的监听器。主要将处理委托给ContextLoaderContextCleanupListener
类的继承关系。

ContextLoaderListener实现了ServletContextListener接口。该接口主要定义了两个行为:监听上下文创建(contextInitialized)和监听上下文销毁(contextDestroyed)。
ContextLoaderListener只是将方法的处理委托给ContextLoader

package org.springframework.web.context;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class ContextLoaderListener extends ContextLoader implements ServletContextListener {

    public ContextLoaderListener() {
    }

    public ContextLoaderListener(WebApplicationContext context) {
        super(context);
    }

    //初始化Root WebApplication
    @Override
    public void contextInitialized(ServletContextEvent event) {
    //委托给ContextLoader
        initWebApplicationContext(event.getServletContext());
    }

    //销毁Root WebApplication
    @Override
    public void contextDestroyed(ServletContextEvent event) {
    //委托给ContextLoader
        closeWebApplicationContext(event.getServletContext());
        //委托给ContextCleanupListener
        ContextCleanupListener.cleanupAttributes(event.getServletContext());
    }

}

ContextLoaderinitWebApplicationContext方法负责创建root web application context。

//初始化root web application context
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
        //校验是否已经存在root application,
        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,并保存到变量中,等关闭时使用
            if (this.context == null) {
                this.context = createWebApplicationContext(servletContext);
            }
            //如果是ConfigurableWebApplicationContext,则配置上下文并刷新
            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);
                }
            }
            //在ServletContext中设置属性,表明已经配置了root web application context
            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. 校验是否已经存在root WebApplicationContext
  2. 创建root WebApplicationContext
  3. 配置上下文并刷新
  4. 绑定root WebApplicationContext到servlet context上

这四步具体分析如下:

1.校验

校验的过程比较简单,主要是判断Servlet Context是否已经绑定过WebApplicationContext

2.创建对象

createWebApplicationContext()方法负责创建WebApplicationContext对象,主要过程是确定WebApplicationContext类,并实例化:

    protected WebApplicationContext createWebApplicationContext(ServletContext sc) {
    //查找WebApplicationContext的类
        Class<?> contextClass = determineContextClass(sc);
        if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
            throw new ApplicationContextException("Custom context class [" + contextClass.getName() +
                    "] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");
        }
        //实例化对象
        return
        (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
    }

决定WebApplicationContext类的主要策略是先判断ServletContext是否配置了contextClass属性,如果是,则用该属性指定的类作为WebApplicationContext类,否则则是否默认策略。默认策略是根绝classpath下的ContextLoader.properties中配置的类作为WebApplicatioNCOntext类:

protected Class<?> determineContextClass(ServletContext servletContext) {
        //优先根据servletContext配置的contextClass属性
        String contextClassName = servletContext.getInitParameter(CONTEXT_CLASS_PARAM);
        if (contextClassName != null) {
            try {
                return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());
            }
            catch (ClassNotFoundException ex) {
                throw new ApplicationContextException(
                        "Failed to load custom context class [" + contextClassName + "]", ex);
            }
        }
        //在通过classpath下的`ContextLoader.properties`文件制定的类作为WebApplicationContext类
        //默认是XmlWebApplicationContext
        else {
            contextClassName = defaultStrategies.getProperty(WebApplicationContext.class.getName());
            try {
                return ClassUtils.forName(contextClassName, ContextLoader.class.getClassLoader());
            }
            catch (ClassNotFoundException ex) {
                throw new ApplicationContextException(
                        "Failed to load default context class [" + contextClassName + "]", ex);
            }
        }
    }
配置与刷新

创建WebApplicationContext对象后,ContextLoader会判断是否是ConfigurableWebApplicationContext
ConfigurableWebApplicationContext拓展了WebApplicationContext的能力。其不仅扩展了自身方法,还继承了ConfigurableApplicationContext接口。

配置与刷新的步骤也正是利用了这些接口提供的能力。

    //配置并刷新上下文
    protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
        //设置ID
        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()));
            }
        }

        //WebApplicationContext绑定Servlet Context
        wac.setServletContext(sc);
        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);
        //刷新上下文,加载bean
        wac.refresh();
    }

创建流程图如下:

原文地址:https://www.cnblogs.com/insaneXs/p/11115862.html

时间: 2024-10-17 06:36:02

SpringMVC Root WebApplicationContext启动流程的相关文章

SpringMVC源码解析-DispatcherServlet启动流程和初始化

在使用springmvc框架,会在web.xml文件配置一个DispatcherServlet,这正是web容器开始初始化,同时会在建立自己的上下文来持有SpringMVC的bean对象. 先从DispatcherServlet入手,从名字来看,它是一个Servlet.它的定义如下: public class DispatcherServlet extends FrameworkServlet { 它是继承FrameworkServlet,来看一下整个的继承关系. 从继承关系来看,Dispatc

linux启动流程详解、破解root密码、添加服务脚本

1.Linux的组成 kernel+rootfs kernel:进程管理.内存管理.网络管理.安全管理.文件系统管理.驱动程序 rootfs:程序和glibc 库:函数集合,function,调用接口(头文件负责描述) 过程调用:procedure  ,无返回值 结果调用:function 程序:二进制文件 2.内核设计流派 单内核(monolithic kernel):Linux 把所有功能集成于同一个程序 微内核(micro kernel):Windows, Solaris 每种功能使用一个

tomcat启动停止在 Initializing Spring root WebApplicationContext,就不运行了

启动项目的时候,项目一直运行到 Initializing Spring root WebApplicationContext,就停止不运行了,也不报错,开始真的很苦恼,后来把log日志的模式改为 debugg模式,就可以看到报错的原因, 在网上百度了一些信息,大多看不懂,好多是大数据的错误,后来自己琢磨,发现是zookeeper注册中心没有开启,汗(⊙﹏⊙)b,开启zookeeper,就可以完美运行啦. tomcat启动停止,卡死,大概是连接不上一些服务,比如数据库啊,服务器啊,什么的,

关于Tomcat启动时,长时间停在Initializing Spring root webApplicationContext处的原因

1.大家肯定经常会遇到这样的问题,以前启动tomcat都不会出问题.现在一起动就会卡到Initializing Spring root webApplicationContext处,tomcat会报连接超时错误. 然后,发现改了timeout,之后还是不行,这你就应该看看是不是数据库连接出了问题.

Tomcat 启动卡在 Root WebApplicationContext: initialization completed in

tomcat 启动一直卡在 Root WebApplicationContext: initialization completed in 重启了很多次,更换jdk版本,tomcat版本都不行. tomcat所在的JVM进程已经被启动了所以可以排除是JVM退出引起的问题.那么问题真的就是JVM因为某种原因被阻塞了. https://blog.csdn.net/wwdwjm/article/details/77840113 主要是因为阿里云的熵池太小 熵池的大小是根据键盘 鼠标之类的噪音产生的数

Spring源码分析2 — 容器启动流程

1 主要类 部署web应用时,web容器(比如Tomcat)会读取配置在web.xml中的监听器,从而启动spring容器.有了spring容器之后,我们才能使用spring的IOC AOP等特性.弄清spring容器启动流程,有利于理解spring IOC中的各种特性,比如BeanPostProcessor,MessageSource,ApplicationListener等.我们先来看下容器启动流程中涉及的主要类. ContextLoaderListener:注册在web.xml中,web应

Initializing Spring root WebApplicationContext

Spring +SpringMVC+MyBatis 启动项目到 Initializing Spring root WebApplicationContext  不执行了 我的问题原因是  <select id="getUser" parameterType="String" resultType="result">      SELECT id,username,userpwd FROM t_admin_user       wher

TOMCAT启动流程分析

------------------tomcat服务开启----------2014-9-26 9:17:07 org.apache.catalina.core.AprLifecycleListener init    //Apache核心类中AprLifecycleListener监听器调用init初始化方法,作用:对服务端的启动,重启,关闭等进行监听.信息: The APR based Apache Tomcat Native library which allows optimal per

Spring的启动流程

spring的启动是建筑在servlet容器之上的,所有web工程的初始位置就是web.xml,它配置了servlet的上下文(context)和监听器(Listener),下面就来看看web.xml里面的配置: <!--上下文监听器,用于监听servlet的启动过程--> <listener> <description>ServletContextListener</description> <!--这里是自定义监听器,个性化定制项目启动提示--&g