Maven插件开发遇坑 - 关于ClassLoader和Resources文件

前言

对于 Java 开发人员来说,写一个配置文件是非常常见的,比如日志,又比如早期的 Spring,以及让人又爱又恨的 mybatis 和 hibernate 到现在也没有摆脱各种配置文件。

至少在某种层面上来说,读一个配置文件、写一个配置文件,是最基础不过、最必须掌握的事情了。

所以很多的时候,我们简单的写下:

Properties properties = new Properties();
properties.load(new FileInputStream("config.properties"));

然后,我们就开始了读取数据。

当然有些人可能小心一些,毕竟是从 classpath 读资源文件,所以他们喜欢用 ClassLoader 来读取,例如:

File configFile = this.getClassLoader().getResources("config.properties"));
Properties properties = new Properties();
properties.load(configFile);

习以为常之后,我根本没有意识到这有什么问题。

问题出现

这两天问题出现了,我们计划在写一个 Maven 插件,对于一个插件来说,一个配置文件也是少不了的,至少你需要配置一下我在哪个项目里、做什么事情、怎么做。

所以,我们写了一个配置文件,用来连接数据库,就像你们经常做的那样:

db.username = xxx
db.password = xxx
db.driver = com.mysql.jdbc.Driver
db.url = xxx

然后保存成 database.properties 存放在 resources 的根目录下,这是一个 maven 的项目,maven 已经帮我们设置了 classPath,并让 resources 文件夹成为了 resources root 类型的 path。

然后我开始了读取,在maven插件的项目里,所有的程序入口,都在一个 execute 的方法实现里。

@Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        Props props = new Props("database.properties");
        getLog().info("get configuration of ")
        try {
            
            properties.load(new FileInputStream("database.properties"));
            for(Object p : properties.keySet()){
                getLog().info(props.getStr(p.toString()));
            }
        } catch (IOException e) {
            getLog().error("error ", e);
        }
    }

ok,一切正常,我开始了测试,就像所有 maven 的项目一样:

// 现在显然还不需要测试
mvn clean package install -DsktipTest

然后在另外一个项目的pom文件里引用在 <build> <plugins> <plugin> 标签下。

然后。。。

[图片上传失败...(image-fcc351-1516635482197)]

WTF???

No such file or directory...

Ok,下面来检查一下。。。

检查

检查首先需要看看文件是不是存在。

嗯,存在,没毛病。

[图片上传失败...(image-d9347e-1516635482197)]

那么接下来的问题就是,为什么没有找到。

看看刚才输出的路径:

// reverse-maven-plugin是工程的名字 v1.0是版本
file:/Users/HMH/.m2/repository/cn/hhchat/reverse-maven-plugin/v1.0/reverse-maven-plugin-v1.0.jar!/database.properties

毫无疑问,这是一个带了 file: 前缀的路径,那么应该是一个 URI,然后,指向的是一个名称为 reverse-maven-plugin-v1.0.jar 的jar包中的 database.properties

这大概就是问题了,当我将程序作为一个 maven 插件引用的时候,运行时应该是一个 Jar 包,所以 ClassLoader 没有办法直接定位到 database.properties 的位置。

解决方案

原来从 resources 文件夹里读取文件的需求,变成了从 jar 包的目录下读取文件。那么 maven 会把 resources 里的文件放在 jar 包的什么位置呢?

[图片上传失败...(image-19cedb-1516635482197)]

嗯,原来是在 Jar 包的根目录了,所以,现在需要看看如何从Jar包中读取文件了。

读取Jar中的文件

方法1 getResourceAsStream()

这里仍然是两种办法,第一种办法,你可以使用Stream来读取,这个变动非常小,如下所示即可:

Properties properties = new Properties();
properties.load(LoadProjectJar.class.getResourceAsStream("/database.properties"));

[图片上传失败...(image-aedb1e-1516635482197)]

这说明对于 Jar 包运行状态下的resources文件,通过 getResourceAsStream() 的方式是可以获取的文件数据的。

方法2 JarFile

使用 JarFile 来连接 jar 包中的内容是另外一种办法,可以从 jar 包中读取到文件和数据。对于 Maven 来说,这也是一种好办法,因为你可以从 Maven 运行时通过 getClassLoader() 来获取 jar 包的具体位置。

// 待续

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,672评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,827评论 6 342
  • 所有项目的构建都是有生命周期的,这个生命周期包括:项目清理、初始化、编译、测试、打包、集成测试、验证、部署、站点生...
    zlcook阅读 2,773评论 0 21
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,193评论 25 707
  • 穷人之所以穷是因为缺钱通常人们遇到稀缺的事物,行为会有所改变,这个稀缺的事物,可以是具体的东西,也可以是时间和金钱...
    晓晓you连阅读 316评论 0 0