`

【解惑】深入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包小问题
评论
50 楼 小宇宙_WZY 2019-07-02  
膜拜一下大神，解决了我一个大问题，非常感谢 orz
49 楼 JKL852qaz 2018-12-17  
感谢，遇到相同的问题！
48 楼 sp42 2016-06-22  
很详细，谢谢哦
47 楼 世界杯2009 2015-04-17  
java.io.FileNotFoundException: E:\workspaces\eclipse4.4_64\aaa\src\AutoAnnotation.jar!\temp\tempXMLFile.xml (系统找不到指定的路径。)

太坑人了，你只得到了路径，根本操作不了？？？？？？、
46 楼 世界杯2009 2015-04-17  
java.io.FileNotFoundException: E:\workspaces\eclipse4.4_64\aaa\src\AutoAnnotation.jar!\temp\tempXMLFile.xml (系统找不到指定的路径。)


为啥不行呢？？？？？？、
求解？？
45 楼 wbgen 2014-06-26  
就从来没搞懂过，谢了，这次明白了……
44 楼 waitgod 2014-04-08  
真心解惑！！！
43 楼 罗德席 2013-07-21  

十分感谢楼主~~~~
最近刚接触android 不懂android的资源是怎么回事，就只能放jar里了
42 楼 biaoice 2013-05-29  
zprill 写道
evilseed 写道
如果我想在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这个文件，则系统启动加载该文件时抛出文件不存在的异常。


      <property name="mappingJarLocations">
            <list>
                <value>WEB-INF/lib/test.jar</value>
            </list>
        </property>


这样能够获取到jar中的配置文件吗，我试过怎么还是不行呢
41 楼 ddjj7 2013-01-21  
Mr.TianShu 写道
ddjj7 写道
Mr.TianShu 写道
试过往这个打好包的jar文件中写入文件吗，可读可写才是王道。

有什么需求要把一个需要写入的文件放在jar包里而不是放在工程中呢


比如，做个swing，带数据库的桌面程序，数据库文件只是一个单独的文件，如果每次运行需解压然后运行完毕后要将数据库文件再存入jar中，绿色版，可以随时携带而不担心又需要复制程序，又需要复制数据库，只复制程序到处运行。表达能力不好，不知明白否。

懂了,确实有这种需求,这种隔几个月的对话感觉好奇妙...
40 楼 Mr.TianShu 2012-12-12  
ddjj7 写道
Mr.TianShu 写道
试过往这个打好包的jar文件中写入文件吗，可读可写才是王道。

有什么需求要把一个需要写入的文件放在jar包里而不是放在工程中呢


比如，做个swing，带数据库的桌面程序，数据库文件只是一个单独的文件，如果每次运行需解压然后运行完毕后要将数据库文件再存入jar中，绿色版，可以随时携带而不担心又需要复制程序，又需要复制数据库，只复制程序到处运行。表达能力不好，不知明白否。
39 楼 liguocai2009 2012-07-02  
devworks 写道
遇到点奇怪的问题
getClass().getResource(...) 空指针
getClass().getClassLoader().getResource(...) 正常

根路径不一样。
前者从类文件的所在目录开始查找
后者从classpath的目录开始查找
38 楼 ddjj7 2012-05-31  
Mr.TianShu 写道
试过往这个打好包的jar文件中写入文件吗，可读可写才是王道。

有什么需求要把一个需要写入的文件放在jar包里而不是放在工程中呢
37 楼 Mr.TianShu 2012-04-10  
试过往这个打好包的jar文件中写入文件吗，可读可写才是王道。
36 楼 tsinglongwu 2012-01-09  
好文章，mark一下！
35 楼 devworks 2010-09-05  
遇到点奇怪的问题
getClass().getResource(...) 空指针
getClass().getClassLoader().getResource(...) 正常
34 楼 zprill 2010-09-04  
evilseed 写道
如果我想在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这个文件，则系统启动加载该文件时抛出文件不存在的异常。


      <property name="mappingJarLocations">
            <list>
                <value>WEB-INF/lib/test.jar</value>
            </list>
        </property>
33 楼 KimShen 2010-09-03  
1,万能的SpringResource
Resource rs = new ClassPathResource("以/分隔jar资源");
2,差不多可以用用的ClassLoader
InputStream strean = Thread.currentThread().getContextClassLoader().getResourceAsStream("以/分隔jar资源");
3,恶心的JarFile-JarEntry

32 楼 fei78945678 2010-09-03  
巨人的肩膀，让我茅舍顿开
31 楼 kingxip 2009-12-30  
这有啥好奇怪的，你随便找个开源项目看看，他们读取配置文件都是从classpath开始算路径的，你那个bin文件夹明显是eclipse中定义的class存放目录，最后打包bin是不会存在的，也就是说相对资源而言真正的根路径是/resources而不是/bin/resources。
个人理解，不知道对不对，请指正。
发表评论

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

相关推荐

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