dubbo导致Cannot initialize context because there is already a root application context present - ch...

背景:
采用javaconfig的方式配置spring的开发框架的时候,采用dubbo2.6.2可以很顺利地集成进来,但是一旦换为dubbo2.6.3版本后,只是maven引入,哪怕没有任何dubbo的配置,此时在启动项目的tomcat时候便会启动异常:

2018-09-27 22:54:19 [RMI TCP Connection(3)-127.0.0.1] ERROR org.springframework.web.context.ContextLoader - Context initialization failed
org.springframework.beans.factory.BeanDefinitionStoreException: IOException parsing XML document from ServletContext resource [/WEB-INF/applicationContext.xml]; nested exception is java.io.FileNotFoundException: Could not open ServletContext resource [/WEB-INF/applicationContext.xml]
at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java:344) ~[spring-beans-4.2.6.RELEASE.jar:4.2.6.RELEASE]
at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java:304) ~[spring-beans-4.2.6.RELEASE.jar:4.2.6.RELEASE]
at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java:181) ~[spring-beans-4.2.6.RELEASE.jar:4.2.6.RELEASE]
............................................................
1
2
3
4
5
6
1
2
3
4
5
6
异常类型为spring上下文初始化找不到“/WEB-INF/applicationContext.xml]”此文件,这就奇怪了,项目采用的javaconfig的方式初始化spring的上下文,为什么启动的时候仍然去寻找applicationContext.xml文件,并且maven去掉dubbo的依赖或者将dubbo的依赖改为2.6.2便不会出现相关的异常。

问题分析
异常栈是由ContextLoader爆出来的,所以问题只能先从ContextLoad加载类中进行查找了,通过“Context initialization failed”的提示信息找到是该函数初始化错误:

public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
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) {
            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);
            }
        }
        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;
    }
}

通过一步步的debug,发现在代码处出现异常:

configureAndRefreshWebApplicationContext(cwac, servletContext);
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);
        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();
    }

继续挨个加断点,debug后发现执行完customizeContext完之后,直接爆出了异常了,发现"wac.refresh()"没有进行相关调用。通过查看相关资料得知,wac.refresh()在调用前会执行各种bean的初始化:

    /**
 * Load or refresh the persistent representation of the configuration,
 * which might an XML file, properties file, or relational database schema.
 * <p>As this is a startup method, it should destroy already created singletons
 * if it fails, to avoid dangling resources. In other words, after invocation
 * of that method, either all or no singletons at all should be instantiated.
 * @throws BeansException if the bean factory could not be initialized
 * @throws IllegalStateException if already initialized and multiple refresh
 * attempts are not supported
 */
void refresh() throws BeansException, IllegalStateException;

按照这个思路的话,如果加上dubbo2.6.3的依赖导致项目无法启动的话,说明dubbo2.6.3中可能是引入了相关的bean的初始化操作。
继续看ContextLoadListener的相关代码:

/**
 * Initialize the root web application context.
 */
@Override
public void contextInitialized(ServletContextEvent event) {
    initWebApplicationContext(event.getServletContext());
}

我们在ContextLoadListener及ContextLoad代码中加断点调试,发现很有意思的一点,ContextLoadListener中的contextInitialized方法竟然被调用了两遍,即是执行了两次spring上下文的初始化,
第一次:

注意这里的ContextLoadListener的Id为3251,从其父类ContextLoad中我们看到该次上下文的初始化完美的执行完成,并且id仍为3251:

而后继续debug,发现ContxtLoadListener的contextInitialized又进入了断点:

发现Id已经变成了3543。
通过查看的spring上下文的初始化类发现在使用dubbo2.6.3后采用了XmlWebApplicationContext的方式加载的,而正常来说我们采用的javaconfig的方式应该采用的是AnnotationConfigWebApplicationContext该类才对:
通过更换为dubbo2.6.2验证了这一想法,加载类改为了AnnotationConfigWebApplicationContext(两者都是继承了AbstractRefreshableWebApplicationContext类,通过重写loadBeanDefinitions实现了不同的加载方式)。

至此,我们得出结论中dubbo2.6.3中应该有相关的机制又重新执行了一遍ContextLoadListener。查看dubbo2.6.3的源码,果然,终于找到罪魁祸首:

有个web-fragment.xml的文件,通过网上的介绍说是在servlet3.0之后增加了web热插拔的功能,web-fragment.xml作为父项目web.xml的插件,可以动态追加到web.xml中。web-fragment.xml中内容为:

<web-fragment version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-fragment_3_0.xsd">

    <name>dubbo-fragment</name>

    <ordering>
        <before>
            <others/>
        </before>
    </ordering>

    <context-param>
        <param-name>contextInitializerClasses</param-name>
        <param-value>org.apache.dubbo.config.spring.initializer.DubboApplicationContextInitializer</param-value>
    </context-param>

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

</web-fragment>

终于找到原因了,在dubbo中又初始化了一个ContextLoadListener。

由dubbo启动的这个ContextLoadListener采用了Spring默认的bean加载方式XmlWebApplicationContext:

因为我们没有在web.xml文件中手动指定bean的定义位置,类似:

<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-context*.xml</param-value>
</context-param>

所以就会采用XmlWebApplicationContext默认加载位置,所以出现了开头的问题所在。

问题解决
既然知道了问题所在,我们就来将问题进行解决。
方法一:
在父项目中采用xml的配置方式,而不再在父项目的web.xml文件中配置ContextloaderListener的监听器,且需要配置contextConfigLocation。这里不进行讨论该这种方式,还是专注于javaconfig配置Spring的方式。
方式二:
首先需要禁用dubbo的web-fragment.xml文件中的ContextLoadListener,通过查询相关资料得知web.xml默认是会加载引用jar中的web-fragment.xml文件的,我们这里需要关闭该功能,父项目的web.xml修改为:

需要增加metadata-complete为true(默认没有或者false都会引用子web-fragment.xml)。
然后我们需要将dubbo的初始化监听器加载到我们的父项目中:

<context-param>
    <param-name>contextInitializerClasses</param-name>
    <param-value>org.apache.dubbo.config.spring.initializer.DubboApplicationContextInitializer</param-value>
</context-param>

一种方式是可以在父web.xml文件中加上这一个标签。
另一种方式采用javaconfig的方式引入,我们看到该标签为context-param,继续回到ContextLoadListener的源码中:

关键在于:

所以contextInitializerClasses是属于ServletContext的相关属性,所以我们应该在ServletContext初始化的时候将contextInitializerClasses配置进来。
javaconfig的方式是通过实现WebApplicationInitializer接口来实现ServletContext的初始化的,在其中只有一个onstartup的方法,我们可以在该方法中指定需要初始化化的相关参数:

在我们项目中采用的是javaconfig的方式配置的SpringMVC,:

AbstractAnnotationConfigDispatcherServletInitializer是实现的WebApplicationInitializer接口,所以我们可以重写onStartup方法,而后在这个方法中进行servletContext的设置:

@Override
public void onStartup(ServletContext servletContext) throws ServletException {
// 配置Servlet的相关参数,在ContextLoader中定义的相关参数
// Dubbo的初始化监听器
servletContext.setInitParameter(ContextLoader.CONTEXT_INITIALIZER_CLASSES_PARAM,DubboApplicationContextInitializer.class.getName());
super.onStartup(servletContext);
}

通过这种方式修改后,集成了dubbo2.6.3的项目已经可以成功启动,问题得到解决。

这里穿插一句:
Dubbo注入的应用上下文的初始化类:

public class DubboApplicationContextInitializer implements ApplicationContextInitializer {
public DubboApplicationContextInitializer() {
}

public void initialize(ConfigurableApplicationContext applicationContext) {
    applicationContext.addApplicationListener(new DubboApplicationListener());
}

}

我们看到它继承了ApplicationContextInitializer 的接口,凡是继承了该接口的类,都会在ContextLoaderListener执行wac.refresh()执行它的initialize的方法,这里是将DubboApplicationListener添加到了spring的上下文之中。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容