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包以外的资源操作就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持。