Java 如何获取 jar 包外的资源

在使用 jar 执行 java 代码时,有一个需求是从 jar 包所在目录的同级目录下读取配置文件的需求,从网上找了很多方法感觉都挺复杂的,在这里总结一下.

以classpath 开头的 URL 表示该文件为jar包内文件的路径.
如:classpath://config/app.config表示jar包根路径config文件夹下的app.config文件
以file开头的URL表示该文件为jar 包外文件的路径
如:file://./config/app.config表示

摘要

// 当前我想从jar包的同级目录下读取一个名为 'config.txt'的文件的话,我需要指定目录为.
File file = new File(".","config.txt")

说明

File file = new File("config.txt")

当只包含文件名称时,java程序会默认尝试从jar包的根路径去读取文件,当尝试使用 file.getCanonicalPath() 方法读取时,便会得到该文件在jar包内的路径.

示例

我当前的工程的路径为D:\WorkSpace\path_demo01\
在工程执行以下java代码:

当指定parent时:

• 会从parent下查找path资源.

log(FileUtil.file(".", "/config/app.config").getCanonicalPath());
log(FileUtil.file(".", "config/app.config").getCanonicalPath());
// D:\WorkSpace\path_demo01\config\app.config

//加载与当前jar包同级目录下的文件
log(FileUtil.file(".", "app.config").getCanonicalPath());

当没有指定parent:

• 如果path为绝对路径时,会从绝对路径下查找
• 如果path为相对路径时,会从classpath的根路径下开始查找

log(FileUtil.file("/config/app.config").getCanonicalPath());
// D:\config\app.config

log(FileUtil.file("config/app.config").getCanonicalPath());
// D:\WorkSpace\path_demo01\target\classes\config\app.config

通过当前类加载资源:

• 如果path为相对路径会指定要加载的资源路径与当前类所在包的路径一致
• 如果path为绝对路径,那么就会从classpath的根路径下开始查找

log(App.class.getResource("/config/app.config"));
// file:/D:/WorkSpace/path_demo01/target/classes/config/app.config

log(App.class.getResource("config/app.config"));
// file:/D:/WorkSpace/path_demo01/target/classes/top/ghimi/config/app.config

通过类加载器加载资源:

默认是从ClassPath根下获取,path不能以/开头,最终是由ClassLoader获取资源.

log(App.class.getClassLoader().getResource("/config/app.config"));
// null

log(App.class.getClassLoader().getResource("config/app.config"));
// file:/D:/WorkSpace/path_demo01/target/classes/config/app.config

加载jar包内的资源

当代码打包成jar包的形式后,是无法通过new File()的形式加载jar包内的资源的.此时有可能抛出

• FileNotFoundException异常,是由于将path当成jar包外的目录查找不到资源导致的.
• URI is not hierarchical异常,是由于无法直接读取jar包中资源(透明)而抛出的异常.

解决方法:

使用 getResourceAsStream()方法直接获取资源的流而不是getResource()获取资源文件对象的方式读取资源.

//修改前,未打包成jar包时能够正常执行,打包后会抛出异常
log(App.class.getClassLoader().getResource("config/app.config"));

// 修改后,打成jar包后也可以正常加载资源
log(App.class.getClassLoader().getResourceAsStream("config/app.config"));

加载jar包外的资源

• 会从parent目录下查找path资源.

//加载与当前jar包同级目录下的文件
log(FileUtil.file(".", "app.config").getCanonicalPath());
// D:\WorkSpace\path_demo01\app.config

//加载与当前jar包的上一级目录下的文件
log(FileUtil.file("..", "app.config").getCanonicalPath());
// D:\WorkSpace\app.config

借用工具hutool:

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>4.5.6</version>
</dependency>

参考资料:
URI is not hierarchical
Class.getResourceAsStream()