Spring依赖Jar包同名配置文件冲突

问题描述

昨天接到了一个需求是这样的,项目A作为公有工具类项目,被项目B和项目C所依赖,同时项目C依赖项目B。A中的配置依赖于外部的properties,在B和C中均配有同名properties以启动项目A,但是在实际运行过程中,项目B和项目C加载的是同一配置文件(可能取决于B和C的加载顺序)。现在的要求是在A中能读到所有配置的配置信息(同名配置append到属性上而不是覆盖)。之前的开发中一直用的都是SpringBoot不是Spring,对使用xml配置的这种方式感到很陌生,只能硬着头皮上。

项目A的xml配置信息

A是一个spring项目,使用classpath*的方式将外部配置加载到项目中。并使用@Value(${})的方式获取Properties里面的值。

<bean class="org.springframework.context.support.PropertySourcesPlaceholderConfigurer">
    <property name="ignoreUnresolvablePlaceholders" value="true" />
    <property name="ignoreResourceNotFound" value="true"/>
    <property name="order" value="2018062911" />
    <property name="locations">
        <list>
            <value>classpath*:conf_default.properties</value>
            <value>classpath*:conf.properties</value>
        </list>
    </property>
</bean>

探索

有关classpath和classpath*

Spring可以通过指定classpath*:或classpath:前缀加路径的方式从classpath下加载文件。

  • classpath*:可以从多个jar文件中加载相同的文件。
  • classpath:只能加载找到的第一个文件。
    而使用classpath加载一般的优先级为:当前classes > jar包中的classes

解决方案

找遍了也没找到这种类似的解决方案,但是有个自定义加载类从而不用@Value方式而是用静态方法读取配置的代码给了我思路。经过自己验证过目前有两种解决方案:

通过Resource读取

这种方法使用

Resource[] resources=resolver.getResources("classpath*:conf.properties" );

这样的方法来将所有的conf.properties配置文件加载到项目当中。经过检验,这种方式确实可以获取到所有的配置文件。后续思路是定义一个Properties的工具类,实现Properties的懒加载,后续项目中使用配置信息的时候使用静态方法来获取,而不是使用@Value注解的方式。

自定义加载类,重写重要方法

经过单步调试发现,Properties加载类中对于需要merge的属性,有一个方法进行处理。

public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    try {
        Properties mergedProps = this.mergeProperties();
        this.convertProperties(mergedProps);
        this.processProperties(beanFactory, mergedProps);
    } catch (IOException var3) {
        throw new BeanInitializationException("Could not load properties", var3);
    }
}

再经过漫长的调用链发现,最终调用对properties赋值时,Spring采用的是对value直接覆盖的做法(Properties继承自HashTable)

String key = loadConvert(lr.lineBuf, 0, keyLen, convtBuf);
String value = loadConvert(lr.lineBuf, valueStart, limit - valueStart, convtBuf);
put(key, value);

到这里我们的目标就很明确了,要做的有如下几点。

  • xml中自定义加载类PropertyUtil,其他不用改变
<bean class="com.zombie.a.PropertyUtil">
    <property name="ignoreUnresolvablePlaceholders" value="true" />
    <property name="ignoreResourceNotFound" value="true"/>
    <property name="order" value="2018062911" />
    <property name="locations">
        <list merge="true">
            <value>classpath*:conf-default.properties</value>
            <value>classpath*:conf.properties</value>
        </list>
    </property>
</bean>
  • 自定义MyProperties 继承自Properties,修改赋值逻辑
    实际这一步只要改一行代码,但是很多依赖的函数我直接也一道copy到MyProperties了
put(key, get(key)==null?value:get(key)+","+value);
  • 自定义加载类中替换Properties
    我的做法是直接重写mergeProperties方法,其实也只用该一行代码,即:Properties result = new MyProperties();
protected Properties mergeProperties() throws IOException {
    Properties result = new MyProperties();
    if (this.localOverride) {
        this.loadProperties(result);
    }

    if (this.localProperties != null) {
        Properties[] var2 = this.localProperties;
        int var3 = var2.length;

        for(int var4 = 0; var4 < var3; ++var4) {
            Properties localProp = var2[var4];
            CollectionUtils.mergePropertiesIntoMap(localProp, result);
        }
    }
    if (!this.localOverride) {
        this.loadProperties(result);
    }
    return result;
}

验证

最后做了下验证,我定义了3个conf.properties 1个conf_default.properties最终同一属性的所有值都读到了。

default,prod,aaaa,bbb

完美!收工。

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

推荐阅读更多精彩内容