一次SpringBoot自定义配置问题查找

背景:

SpringBoot项目,由于项目过程中,引入的外部配置比较多,造成配置文件臃肿,管理混乱,简直就像把一辆车开在了烂泥潭里,简直无法自拔。于是决定将配置文件归类,并按业务拆分成几个,提高清晰度,方便维护。

过程:

SpringBoot允许自定义配置的方式将配置文件在项目启动的时候进行加载。方式有几种,主要包括通过@PropertySource、EnviromentPostProcessor继承,或者通过@Configuration等。每种方法虽然都是一个目的,但还是有很大差别,具体先占坑,以后来详细谈谈,今天来谈谈EnviromentPostProcessor这种方法(谁让他比较长呢)。

废话勿多,直接上代码。根据官方文档的使用方法,先继承EnviromentPostProcessor,重写方法postProcessEnviroment。下面是官方例子,稍作修改,增加多个配置文件加载支持。(大概这个意思)

public class EnvironmentPostProcessorExample implements EnvironmentPostProcessor {

    private final YamlPropertySourceLoader loader = new YamlPropertySourceLoader();

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        // 资源文件A
        Resource path = new ClassPathResource("com/example/myapp/config-A.yml");
        PropertySource<?> propertySource = loadYaml(path);
        environment.getPropertySources().addLast(propertySource);
        // 资源文件B 
        path = new ClassPathResource("com/example/myapp/config-B.yml");
        propertySource = loadYaml(path);
        environment.getPropertySources().addLast(propertySource);
    }

    private PropertySource<?> loadYaml(Resource path) {
        if (!path.exists()) {
            throw new IllegalArgumentException("Resource " + path + " does not exist");
        }
        try {
            return this.loader.load("custom-resource", path).get(0);
        }
        catch (IOException ex) {
            throw new IllegalStateException("Failed to load yaml configuration from " + path, ex);
        }
    }
}

在META-INF下增加spring.factories文件,内容如下:

org.springframework.boot.env.EnvironmentPostProcessor=对应自定义EnviromentPostProcess类全路径

看来一切视乎很顺利,来个单元测试看是否可以加载相关配置项。但事实告诉我们,往往开头越顺利,后面就有越大的坑等你填。
启动项目,加载......果然,报错:Could not resolve placeholder .......。看错误日志,果然没有啥有用信息。

What!!!尽然没有找个配置项,第一直觉是哪里配置错误,反复检查,反复看官方例子,没错。
为啥没有加载到配置项内?再仔细看配置文件,感觉除最后一个配置文件加载到外,其他配置文件都似乎没加载。

这就很奇怪了呀!!!

为了验证自己的想法,我把几个拆分开的配置文件顺序颠倒,再次启动,果然,虽然还是报统一个错,但提示未加载的配置项换了。那估计就是这个问题没跑了。那问题来了,难道ConfigurableEnvironment对象,加载多个配置文件所用的方法并非官方的addLast()还是这个方法别有奥妙?还是看源码吧。果然,这一看,发真现了问题。源码如下:

public void addLast(PropertySource<?> propertySource) {
    if (logger.isDebugEnabled()) {
        logger.debug("Adding PropertySource '" + propertySource.getName() + "' with lowest search precedence");
    }
    removeIfPresent(propertySource);
    this.propertySourceList.add(propertySource);
}

removeIfPresent,根据传入的PropertySource对象,如果存在,先删除。那判断相同的依据是什么呢?继续往下翻,源码如下:

private final List<PropertySource<?>> propertySourceList = new CopyOnWriteArrayList<>();

protected void removeIfPresent(PropertySource<?> propertySource) {
    this.propertySourceList.remove(propertySource);
}

到这里就明朗了,维护PropertySource的是一个List,删除使用的是自带remove方法。根据List接口的remove方法约定,需要比较两个对象内存地址是否一致、equals()方法是否相等、等等。但我要找的,就是equals()方法。

查找PropertySource对象的equals()方法,代码如下:

@Override
public boolean equals(Object other) {
    return (this == other || (other instanceof PropertySource &&
            ObjectUtils.nullSafeEquals(this.name, ((PropertySource<?>) other).name)));
}

看到这段代码,OK,托拉,问题应该找到了。原来在重写equals()方法的时候,有一项内容就是比较name属性。而name属性,恰巧就是YamlPropertySourceLoader 对象在load资源的时候,需要定义的名字。(Spring为什么这么做?这部分源码,留待大家自己去分析查看吧)

问题找到,修改代码,根据自定义资源名称的不同,加载相关的资源。
启动,一切顺利。

总结

虽然这是一个非常小的问题,但其实也反映了对接口文档的不熟悉,或者说想当然,甚至压根不会去考虑。

以此文章,共勉之。

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

推荐阅读更多精彩内容