Java加载依赖中properties文件

properties文件是常用的配置文件类型,本文以properties为例,总结了线上环境常遇到的加载properties文件的问题

先给一个例子

项目A:

maven工程 A

其中ReadProperties内容如下:

package com.young.properties;

public class ReadProperties {
    static {
        read();
    }

    public ReadProperties(){
        System.out.println("+++++++++++++++");
        readInner();
    }

    private void readInner() {
        //方式 1
        InputStream inputStream = this.getClass().getResourceAsStream("/test.properties");
        Properties properties = new Properties();

        try {
            properties.load(inputStream);
        } catch (IOException var13) {
        }

        System.out.println(properties);
    }

    private static void read() {
        //方式 2
        InputStream inputStream = ReadProperties.class.getClassLoader().getResourceAsStream("test.properties");
        Properties properties = new Properties();

        try {
            properties.load(inputStream);
        } catch (IOException var13) {
        }

        System.out.println(properties);
    }
}

test.properties 内容如下:

key=A
value=2
加载配置文件的方式

上述方式1方式2是常用的加载方式,使用方式1加载test.properties时,要加上代表根目录的前缀;若以不带"/"的方式加载,如下图显示,实际上是在当前class的路径下寻找,自然是找不到的。
方式2不能添加"/",默认是在classpath的根路径下寻找文件。

方式1 不带"/"加载


项目B:

另有Maven工程B依赖A
maven工程 B

工程B下面也包含了一个同名的test.properties文件。
test.properties

key=B
value=1
public class App {
    public static void main( String[] args ) {
        new ReadProperties();
    }
}

如果在idea中运行上述main方法,结果是什么呢?可以发现读的是项目B的配置。

{key=B, value=1}
+++++++++++++++
{key=B, value=1}

为什么呢?
idea里默认的classpath的顺序如下图所示(这些路径下的class都由SystemClassLoader加载),第一个为jdk下的jar,第二个Module source代表target/classes,第三个就是项目A的class;因为项目B的配置在第二个Module source下,所以上面读的是项目B的配置。如果把下图中的相对顺序改变一下,读的配置就会不同(你可以试一下)。


idea默认的classpath顺序

线上环境运行

大家都知道,线上运行代码的方式与编辑器里稍有不同。要么将代码打成fat-jar,要么将所有的依赖单独放在一起(通常是放在单独的文件夹lib中),并将这些依赖放入classpath中。

fat-jar

fat jar会将依赖以及配置文件都打包进一个jar文件中,使用maven的朋友可能会使用maven-assembly-plugin来进行打包。把上述工程B打成fat jar目录如下:

fat-jar

此时会发现该配置文件test.properties是工程A的配置,工程B的配置被工程A中同名的配置覆盖掉了。因此在开发时,依赖中配置和主项目的配置名称最好不要相同,否则打成fat jar时会出现上述问题。maven-assembly-plugin可能有相关配置可以解决这个覆盖问题,本人并没有找到。

依赖单独打包

除了fat jar,通常线上也会采用将依赖放在独立的文件夹中的方式进行部署。
将上述工程B这样打包后,目录如下:


image.png

运行下面的命令

//读到了B.jar里的配置
java -classpath B.jar:lib/A.jar  com.young.App
//读到了A.jar里的配置
java -classpath lib/A.jar:B.jar com.young.App
//读到了lib下即A.jar里的配置
java -Djava.ext.dirs=/.../lib -classpath B.jar com.young.App
java -cp B.jar -Djava.ext.dirs=/.../lib  com.young.App

前两种都是按照classpath下jar包字典顺序寻找,找到第一个就停止遍历;第三个依赖是由ExtClassLoader加载的,所以jar包的顺序不重要。当com.young.App去加载配置时,先委托给父ClassLoader(ExtClassLoader)加载,所以先加载了A.jar的配置。

//resource的加载也是双亲委派模型
public URL getResource(String name) {
        URL url;
        if (parent != null) {
            url = parent.getResource(name);
        } else {
            url = getBootstrapResource(name);
        }
        if (url == null) {
            url = findResource(name);
        }
        return url;
    }

总结

当项目中多个地方出现相同的配置文件时,读取的文件会与打包的方式以及项目的名称有关。尽量在项目中保持配置文件命名的唯一性。

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

推荐阅读更多精彩内容

  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,788评论 6 342
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,644评论 18 139
  • 入门 介绍 Spring Boot Spring Boot 使您可以轻松地创建独立的、生产级的基于 Spring ...
    Hsinwong阅读 16,869评论 2 89
  • 下载简书APP还是去年的事情了,一共写了两篇文章就没再坚持下去了。我不想承认自己是一个懒人,我为自己找了很多借口:...
    枝南枝北阅读 185评论 0 0
  • “自杀”“自残”“伤人”,这些戏剧化的词语常常被用在抑郁症患者的身上。事实上,这些夸大的有色词语,给本来就痛苦的抑...
    lilythedog阅读 805评论 0 0