Java jar包资源 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>

补充知识：java中jar包内的类访问jar包内部的资源文件的路径问题

在本地项目中，若我们要访问项目中的资源文件，则一般使用相对路径或者用System.getProperities("user.dir")得到项目根目录，然后再访问资源文件，但是在将该工程和资源文件打包为jar包，运行该jar文件时，会显示找不到资源文件的错误。

在如下项目结构树中，项目根目录为nlpir，如果我们要在src下的某个package的某个java文件中访问blackWhite文件夹中的文件，则相对路径为"blackWhite/....."即可。但是在打包为jar包时，即使我们把blackWhite文件夹同样加入到打包的文件行列，在运行该jar包时，会出错：找不到blackWhite中某文件的路径。

解决方法：

使用Class.getResource或者是ClassLoader.getResourceAsStream()将文件内容放到InputStream中，具体使用如下：

String s1 = this.getClass().getResource("/library.properties").getPath();

或者为：

String s1 = CodeTest.class.getResource("/library.properties").getPath();

注意，使用class的getRescource时，要注意路径前要加"/"，即根目录，此处的根目录是src

若像如下使用：

String class_str = this.getClass().getResource("logback.xml").getPath();

则会出错如下：

使用ClassLoader时，如下：

this.getClass().getClassLoader().getResource()

在使用ClassLoader时，路径前面不能加"/",使用相对路径。

如下示例：

@Test
 public void test4(){
 String class_str = this.getClass().getResource("/logback.xml").getPath();
 String class_str2 = TempTest.class.getResource("/logback.xml").getPath();
   String classLoader_str = this.getClass().getClassLoader().getResource("logback.xml").getPath();
   InputStream is = this.getClass().getClassLoader().getResourceAsStream("logback.xml");
 System.out.println(class_str);
   System.out.println(class_str2);
 System.out.println(classLoader_str);
   System.out.println(is == null );
 }

结果如下：

String ss = TempTest.class.getResource("/").getPath();

上述该代码得到的是项目的根目录，即nlpir的根目录，结果如下：

/C:/eclipse/eclipse/workspace/nlpir/out/production/nlpir/

如下代码：

@Test
 public void readProperties(){
 String ss = TempTest.class.getResource("/").getPath();
 System.out.println(ss);
 String s = new File(ss).getParentFile().getPath();
 System.out.println(s);
 String system_str = System.getProperty("user.dir");
 System.out.println(system_str);
 }</span>

运行结果如下：

其中，File.getParentFile()可用于求父目录

将上述readProperties函数打包为jar包在命令行使用java -jar TempTest.jar运行时，结果如下：

由此可见，打包成jar包时和在ide中直接运行的结果并不一样，所以在jar包中的class类要访问自己jar包中的资源文件时，应该使用Class.getResource或者是getResourceAsStream放在InputStream中，再进行访问。但是该方法只能访问到src下的资源文件，因为其根目录对应的就是src，无法访问到项目根目录下src外的文件，如上述项目结构图中的blackWhite中的文件无法访问到，解决方法还木有找到。。。。。。

当jar包外部的类需要访问某个jar包的资源文件时，使用JarFile类，

具体使用方法如下：

如果你对于常用的ZIP格式比较熟悉的话，JAR文件也就差不多。JAR文件提供一种将多个文件打包到一个文件中的方法，其中每一个文件可能独立地被压缩。JAR文件所增加的内容是manifest，它允许开发者可以提供附加的关于内容的信息。例如，manifest表明JAR文件中的哪个文件是用来运行一个程序的，或者库的版本号等。

J2SEDK提供了一个JAR工具，你可以用它从控制台读写JAR文件。然而，如果你需要在程序中代码读写JAR文件，可能需要一点时间（本文只包含如何在程序中读写JAR文件）。好消息是你可以做到这一点，而且你不用担心解压的事，因为类库将帮助你完成这些。

首先，通过把将JAR文件位置传给构造函数，创建一个JarFile的实例，位置可能是String或File的形式，如下：

JarFile jf = new JarFile("C:/jxl.jar");

或者为：

File file = new File("C:/jxl.jar");

JarFile jarFile = new JarFile(file);

你可能注意到当文件不在class path中时，JarFile类对于从JAR中读取文件文件是很有用的。当你想指定目标JAR文件时，JarFile类对于从JAR中读取文件同样也很有用。

当然，如果JAR文件在class path中，从其中读取文件的方法比较简单，你可以用下面的方法：

URL url = ClassLoader.getSystemResource(name);

或者为：

InputStream stream =

ClassLoader.getSystemResourceAsStream("javax/servlet/LocalStrings_fr.properties");

当你有了该JAR文件的一个引用之后，你就可以读取其文件内容中的目录信息了。JarFile的entries方法返回所有entries的枚举集合 (Enumeration)。通过每一个entry，你可以从它的manifest文件得到它的属性，任何认证信息，以及其他任何该entry的信息，如它的名字或者大小等。

Enumeration enu = jf.entries();
while (enu.hasMoreElements()) {
JarEntry element = (JarEntry) enu.nextElement();
        String name = element.getName();
        Long size = element.getSize();
        Long time = element.getTime();
        Long compressedSize = element.getCompressedSize();
        
        System.out.print(name+"/t");
        System.out.print(size+"/t");
        System.out.print(compressedSize+"/t");
        System.out.println(new SimpleDateFormat("yyyy-MM-dd").format(new Date(time)));
}

为了从JAR文件中真正读取一个指定的文件，你必须到其entry的InputStream。这和JarEntry不一样。这是因为JarEntry只是包含该entry的有关信息，但是并不实际包含该entry的内容。这和File和FileInputStream的区别有点儿相似。访问文件没有打开文件，它只是从目录中读取了该文件的信息。

下面是如何得到entry的InputStream：

InputStream input = jarFile.getInputStream(entry);

当你有了输入流，你就可以像读取其他流一样读取它。在文本流中(text stream)，记得使用读取器(Reader)从流中取得字符。对于面向字节的流，如图片文件，直接读取就行了。

示例：

下面的程序演示如何从JAR文件中读取文件。指定JAR文件的名称，要读取的文件的名称（打包JAR文件中的某一个文件）作为参数来调用该程序。要读取的文件应该有一个文本类型的。

import java.io.*; 
　　　import java.util.jar.*; 
　　
　　　public class JarRead { 
　　　　public static void main (String args[]) 
　　　　　　throws IOException { 
　　　　　if (args.length != 2) { 
　　　　　　System.out.println( 
　　　　　　　"Please provide a JAR filename and file to read"); 
　　　　　　System.exit(-1); 
　　　　　} 
　　　　　JarFile jarFile = new JarFile(args[0]); 
　　　　　JarEntry entry = jarFile.getJarEntry(args[1]); 
　　　　　InputStream input = jarFile.getInputStream(entry); 
　　　　　process(input); 
　　　　　jarFile.close(); 
　　　　} 
　　
　　　　private static void process(InputStream input) 
　　　　　　throws IOException { 
　　　　　InputStreamReader isr = 
　　　　 new InputStreamReader(input); 
　　　　　BufferedReader reader = new BufferedReader(isr); 
　　　　　String line; 
　　　　　while ((line = reader.readLine()) != null) { 
　　　　　　System.out.println(line); 
　　　　　} 
　　　　　reader.close(); 
　　　　} 
　　　}

假设在myfiles.jar文件中有一个spider.txt文件，spider文件的内容如下：

The itsy bitsy spider
　　　Ran up the water spout
　　　Down came the rain and
　　　Washed the spider out 

可以通过下面的命令在命令行来显示该文本文件的内容：

java JarRead myfiles.jar spider.txt

以上这篇Java 获取 jar包以外的资源操作就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持。