`

【解惑】深入jar包：从jar包中读取资源文件

SpringXMLHibernateEclipseJVM 
阅读更多

     我们常常在代码中读取一些资源文件(比如图片，音乐，文本等等)。在单独运行的时候这些简单的处理当然不会有问题。但是，如果我们把代码打成一个jar包以后，即使将资源文件一并打包，这些东西也找不出来了。看看下面的代码： 

//源代码1：
package edu.hxraid;
import java.io.*;
public class Resource {
	public  void getResource() throws IOException{
		File file=new File("bin/resource/res.txt");
		BufferedReader br=new BufferedReader(new FileReader(file));
		String s="";
		while((s=br.readLine())!=null)
			System.out.println(s);
	}
}

        这段代码写在Eclipse建立的java Project中，其目录为：(其中将资源文件res.txt放在了bin目录下，以便打成jar包)
      1、src/
              src/edu/hxraid/Resource.java
      2、bin/
              bin/resource/res.txt
              bin/edu/hxraid/Resource.class

      很显然运行源代码1是能够找到资源文件res.txt。但当我们把整个工程打成jar包以后(ResourceJar.jar)，这个jar包内的目录为：
              edu/hxraid/Resource.class
              resource/res.txt

 

         而这时jar包中Resource.class字节码：ldc <String "bin/resource/res.txt"> [20] 将无法定位到jar包中的res.txt位置上。就算把bin/目录去掉：ldc <String "resource/res.txt"> [20] 仍然无法定位到jar包中res.txt上。

      这主要是因为jar包是一个单独的文件而非文件夹，绝对不可能通过"file:/e:/.../ResourceJar.jar/resource /res.txt"这种形式的文件URL来定位res.txt。所以即使是相对路径，也无法定位到jar文件内的txt文件(读者也许对这段原因解释有些费解，在下面我们会用一段代码运行的结果来进一步阐述)。

 

          那么把资源打入jar包，无论ResourceJar.jar在系统的什么路径下，jar包中的字节码程序都可以找到该包中的资源。这会是幻想吗？


      当然不是，我们可以用类装载器(ClassLoader)来做到这一点：

         (1) ClassLoader 是类加载器的抽象类。它可以在运行时动态的获取加载类的运行信息。 可以这样说，当我们调用ResourceJar.jar中的Resource类时，JVM加载进Resource类，并记录下Resource运行时信息(包括Resource所在jar包的路径信息)。而ClassLoader类中的方法可以帮助我们动态的获取这些信息:
          ● public URL getResource(String name)
            查找具有给定名称的资源。资源是可以通过类代码以与代码基无关的方式访问的一些数据(图像、声音、文本等)。并返回资源的URL对象。
          ● public InputStream getResourceAsStream(String name);
             返回读取指定资源的输入流。这个方法很重要，可以直接获得jar包中文件的内容。

         

          (2) ClassLoader是abstract的，不可能实例化对象，更加不可能通过ClassLoader调用上面两个方法。所以我们真正写代码的时候，是通过Class类中的getResource()和getResourceAsStream()方法，这两个方法会委托ClassLoader中的getResource()和getResourceAsStream()方法 。好了，现在我们重新写一段Resource代码,来看看上面那段费解的话是什么意思了： 

//源代码2：
package edu.hxraid;
import java.io.*;
import java.net.URL;
public class Resource {
	public  void getResource() throws IOException{	
              //查找指定资源的URL，其中res.txt仍然开始的bin目录下 
		URL fileURL=this.getClass().getResource("/resource/res.txt"); 
		System.out.println(fileURL.getFile());
	}
	public static void main(String[] args) throws IOException {
		Resource res=new Resource();
		res.getResource();
	}
}

        运行这段源代码结果：/E:/Code_Factory/WANWAN/bin/resource/res.txt  (../ Code_Factory/WANWAN/.. 是java project所在的路径)

           我们将这段代码打包成ResourceJar.jar ,并将ResourceJar.jar放在其他路径下(比如 c:\ResourceJar.jar)。然后另外创建一个java project并导入ResourceJar.jar，写一段调用jar包中Resource类的测试代码： 

import java.io.IOException;
import edu.hxraid.Resource;
public class TEST {
	public static void main(String[] args) throws IOException {
		Resource res=new Resource();
		res.getResource();
	}
}

           这时的运行结果是：file:/C:/ResourceJar.jar!/resource/res.txt

 

           我们成功的在运行时动态获得了res.txt的位置。然而，问题来了，你是否可以通过下面这样的代码来得到res.txt文件？
                      File f=new File("C:/ResourceJar.jar!/resource/res.txt");
            当然不可能，因为".../ResourceJar.jar!/resource/...."并不是文件资源定位符的格式 (jar中资源有其专门的URL形式： jar:<url>!/{entry} )。所以，如果jar包中的类源代码用File f=new File(相对路径);的形式，是不可能定位到文件资源的。这也是为什么源代码1打包成jar文件后，调用jar包时会报出FileNotFoundException的症结所在了。

 

          (3) 我们不能用常规操作文件的方法来读取ResourceJar.jar中的资源文件res.txt，但可以通过Class类的getResourceAsStream()方法来获取 ，这种方法是如何读取jar中的资源文件的，这一点对于我们来说是透明的。我们将Resource.java改写成： 

//源代码3：
package edu.hxraid;
import java.io.*;
public class Resource {
	public void getResource() throws IOException{
		//返回读取指定资源的输入流
		InputStream is=this.getClass().getResourceAsStream("/resource/res.txt"); 
		BufferedReader br=new BufferedReader(new InputStreamReader(is));
		String s="";
		while((s=br.readLine())!=null)
			System.out.println(s);
	}
}

           我们将java工程下/bin目录中的edu/hxraid/Resource.class和资源文件resource/res.txt一并打包进ResourceJar.jar中，不管jar包在系统的任何目录下，调用jar包中的Resource类都可以获得jar包中的res.txt资源，再也不会找不到res.txt文件了。

 

分享到：
| 【环境搭建】Eclipse 打jar包小问题
评论
30 楼 evilseed 2009-12-30  
如果我想在spring的配置文件中引用jar中的hibernate映射xml文件，怎么办？
<property name="mappingResources">
    <list>
        <value>com/dao/maps/Order.hbm.xml</value>       
     </list>
</property>

Order.hbm.xml这个文件是放在一个框架的jar中的。
如果我不在自己的项目内相同目录创建Order.hbm.xml这个文件，则系统启动加载该文件时抛出文件不存在的异常。
29 楼 zhao_xiao_dong 2009-12-10  
呵呵，不错，以前我老师这么讲过，可是我忘了，现在又复习了一下，彻底的明白了，
谢了
28 楼 CapsLk 2009-12-10  
思考一个问题：执行下面一个命令
java -jar xxx.jar
是否有方法可以拿到java -jar执行时，解析xxx.jar的JarFile对象呢？
深入了解jvm...
27 楼 xiebiao110 2009-11-12  
这个问题我遇到过，后来看了一下 java security才明白,jvm 在加载了jar包后，所有的资源访问都是通过java的安全机制的，就像你在本地pc上启动了一个虚拟系统，然后在虚拟系统中要来访问你本地pc的文件是不行的。所有只能通过java 类加载机制来寻找文件。
26 楼 ziyu_1 2009-10-12  
虽然没碰到过这样的问题,但是今天受教了
25 楼 lcllcl987 2009-10-12  
这样的方式，在动态热部署中，依然无法读取jar类的东西。
并且错误很怪异。
上半年遇到的问题。
最后改用zip流读入了
24 楼 goddy128 2009-10-11  
收藏了,以前也一直碰到这样都问题,我是直接把资源文件暴露在jar包外面然后调用的!!
23 楼 ThinkInMyLife 2009-10-10  
受教了，能少走弯路了！
22 楼 admires 2009-10-10  
mallon 写道
admires 写道
读取jar文件中的文件，用类加载器，亦可以读取到文件。URL中有一个getFile()方法。
File f = new File(URL.getFile());
这样就可以了。但是带来的问题是URL的路径中不支持文件夹包含空格（用%20代替了），如果要使用，需要再次转义。
虽然新的URI支持空格。但是URL.toURI().getPath()却不能够作为参数new出一个File对象。


我也碰到过，不过new File(url.getFile()); 改成new File(url.toURI())很完美，File的构造函数支持以URI作为参数的，哈哈


后来也有尝试过用URI作为参数构造File对象。但如果这个文件是存在于jar包中，也是不可以的。
在数次尝试之后发现可以用url.toURI().getSchemeSpecificPart()作为参数来构造File对象。
这样可以避免路径文件夹中有空格，或者汉字。
官方文档中对于getSchemeSpecificPart()方法的说明是：
Returns the decoded scheme-specific part of this URI
而对于getPath()
Returns the decoded path component of this URI
以上为人肉测试结果。
21 楼 OuYangGod 2009-10-10  
thx so much.
20 楼 qianhd 2009-10-10  
pipilu 写道
Heart.X.Raid 写道
pipilu 写道
引用


这主要是因为jar包是一个单独的文件而非文件夹，绝对不可能通过&quot;file:/e:/.../ResourceJar.jar/resource

/res.txt&quot;这种形式的文件URL来定位res.txt。所以即使是相对路径，也无法定位到jar文件内的txt文件(读者也许对这段原因解释有些费解，在下面我们会用一段代码运行的结果来进一步阐述)。


这里说的不对吧！
jar包不是文件，而是一个文件夹

如果你的说法成立
引用
jar包是一个单独的文件而非文件夹
，那么，我们写类路径时，就不用把jar包的文件名写到类路径里了，假设你依赖的jar包在程序执行路径下，那就直接写成：
java -classpath . 类名
就可以了，何必要写成：
java -classpath .;xxx.jar;yyy.jar;zzz.jar 类名
呢？



我绝对jar包是一种特殊的文件，如果说是文件夹的话，试问.rar文件算文件夹还是文件那？
其实我绝对就是URL解析的问题，jar包有自己的URL，不同于File的URL，所以不能简单的File f=new File(url);来访问。可能我的解释有些不准确，但我想说的原因不是jar是什么，而是访问jar中资源的特殊之处。

从这个意义上说，楼上的兄弟说的也挺在理的。

当然，访问jar的方法很多。这张贴有很多好心人回复了不少方法，谢谢大家了!


我强调这一点的原因在于，正是因为jar包是作为一个文件夹引入类路径的，才有之后的getResourceAsStream方法获得到类路径下的资源文件。在类路径中，我们是把它看作文件夹的。


你之所以能以目录形式访问jar包中的资源 是因为java可以解析路径 并映射到相关文件中的Entry
就好像你可以以表的形式访问数据库 可实际上表真的是以表的形式存放吗??

你这种说法是在误导初学者
19 楼 pipilu 2009-10-10  
Heart.X.Raid 写道
pipilu 写道
引用


这主要是因为jar包是一个单独的文件而非文件夹，绝对不可能通过&quot;file:/e:/.../ResourceJar.jar/resource

/res.txt&quot;这种形式的文件URL来定位res.txt。所以即使是相对路径，也无法定位到jar文件内的txt文件(读者也许对这段原因解释有些费解，在下面我们会用一段代码运行的结果来进一步阐述)。


这里说的不对吧！
jar包不是文件，而是一个文件夹

如果你的说法成立
引用
jar包是一个单独的文件而非文件夹
，那么，我们写类路径时，就不用把jar包的文件名写到类路径里了，假设你依赖的jar包在程序执行路径下，那就直接写成：
java -classpath . 类名
就可以了，何必要写成：
java -classpath .;xxx.jar;yyy.jar;zzz.jar 类名
呢？



我绝对jar包是一种特殊的文件，如果说是文件夹的话，试问.rar文件算文件夹还是文件那？
其实我绝对就是URL解析的问题，jar包有自己的URL，不同于File的URL，所以不能简单的File f=new File(url);来访问。可能我的解释有些不准确，但我想说的原因不是jar是什么，而是访问jar中资源的特殊之处。

从这个意义上说，楼上的兄弟说的也挺在理的。

当然，访问jar的方法很多。这张贴有很多好心人回复了不少方法，谢谢大家了!


我强调这一点的原因在于，正是因为jar包是作为一个文件夹引入类路径的，才有之后的getResourceAsStream方法获得到类路径下的资源文件。在类路径中，我们是把它看作文件夹的。
18 楼 rrsy23 2009-10-09  
spring  jsf 不都有这个功能

阿里软件的 邱文初的 blog也写过遇到这个问题

不过还是 感谢 lz的 研究精神
17 楼 mallon 2009-10-09  
admires 写道
读取jar文件中的文件，用类加载器，亦可以读取到文件。URL中有一个getFile()方法。
File f = new File(URL.getFile());
这样就可以了。但是带来的问题是URL的路径中不支持文件夹包含空格（用%20代替了），如果要使用，需要再次转义。
虽然新的URI支持空格。但是URL.toURI().getPath()却不能够作为参数new出一个File对象。


我也碰到过，不过new File(url.getFile()); 改成new File(url.toURI())很完美，File的构造函数支持以URI作为参数的，哈哈
16 楼 Heart.X.Raid 2009-10-09  
pipilu 写道
引用


这主要是因为jar包是一个单独的文件而非文件夹，绝对不可能通过&quot;file:/e:/.../ResourceJar.jar/resource

/res.txt&quot;这种形式的文件URL来定位res.txt。所以即使是相对路径，也无法定位到jar文件内的txt文件(读者也许对这段原因解释有些费解，在下面我们会用一段代码运行的结果来进一步阐述)。


这里说的不对吧！
jar包不是文件，而是一个文件夹

如果你的说法成立
引用
jar包是一个单独的文件而非文件夹
，那么，我们写类路径时，就不用把jar包的文件名写到类路径里了，假设你依赖的jar包在程序执行路径下，那就直接写成：
java -classpath . 类名
就可以了，何必要写成：
java -classpath .;xxx.jar;yyy.jar;zzz.jar 类名
呢？



我绝对jar包是一种特殊的文件，如果说是文件夹的话，试问.rar文件算文件夹还是文件那？
其实我绝对就是URL解析的问题，jar包有自己的URL，不同于File的URL，所以不能简单的File f=new File(url);来访问。可能我的解释有些不准确，但我想说的原因不是jar是什么，而是访问jar中资源的特殊之处。

从这个意义上说，楼上的兄弟说的也挺在理的。

当然，访问jar的方法很多。这张贴有很多好心人回复了不少方法，谢谢大家了!
15 楼 whaosoft 2009-10-09  
其实和从哪个路径读文件 没什么区别 只是中问问题罢了
14 楼 pipilu 2009-10-09  
引用


这主要是因为jar包是一个单独的文件而非文件夹，绝对不可能通过&quot;file:/e:/.../ResourceJar.jar/resource

/res.txt&quot;这种形式的文件URL来定位res.txt。所以即使是相对路径，也无法定位到jar文件内的txt文件(读者也许对这段原因解释有些费解，在下面我们会用一段代码运行的结果来进一步阐述)。


这里说的不对吧！
jar包不是文件，而是一个文件夹

如果你的说法成立
引用
jar包是一个单独的文件而非文件夹
，那么，我们写类路径时，就不用把jar包的文件名写到类路径里了，假设你依赖的jar包在程序执行路径下，那就直接写成：
java -classpath . 类名
就可以了，何必要写成：
java -classpath .;xxx.jar;yyy.jar;zzz.jar 类名
呢？
13 楼 myworkfirst 2009-10-09  
   这个类一下就可以搞定：java.util.jar.JarFile
12 楼 ansjsun 2009-10-09  
受教了受教了
11 楼 LargeBean 2009-10-09  
downpour 写道
XWork中有个工具类，叫做ClassLoaderUtil，可以深入读取jar包中的资源文件。Struts2就是用这个工具类读取所有的plugin中的struts-default.xml的。

原理应该和楼主的一样。所以不得不赞叹很多前人的工作，当我们碰到难题时，其实很多前人已经总结了很多最佳实践了。


实实在在地站在巨人肩膀上
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

Magicbox
Global site tag (gtag.js) - Google Analytics