java读取jar包中的文件

时间 2019-11-12

标签 java 读取 jar 文件栏目 Java 繁體版

原文原文链接

在代码中读取一些资源文件(好比图片，音乐，文本等等)，在集成环境(Eclipse)中运行的时候没有问题。但当打包成一个可执行的jar包（将资源文件一并打包）之后，这些资源文件找不到，以下代码：
Java代码 :java

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包)
一、src/
src/edu/hxraid/Resource.java
二、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代码,来看看上面那段费解的话是什么意思了：
Java代码 :性能

//源代码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类的测试代码：
Java代码测试

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的症结所在了。
注：咱们能够经过 new ImageIcon(类.class.getResource("XX.gif"))得到ImageIcon对象，但若是你要得到jar文件中的资源文件流，上面方法行不通。
  (3) 咱们不能用常规操做文件的方法来读取ResourceJar.jar中的资源文件res.txt，但能够经过Class类的getResourceAsStream()方法来获取，这种方法是如何读取jar中的资源文件的，这一点对于咱们来讲是透明的。咱们将Resource.java改写成：
Java代码 :this

//源代码3：    
package edu.hxraid;    
import java.io.*;    
public class Resource {    
    public void getResource() throws IOException{    
        //返回读取指定资源的输入流    
        InputStream is=this.getClass().getResourceAsStream("/resource/res.txt");       
       //InputStream is=当前类.class.getResourceAsStream("XX.config");     
        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文件了。url

(4) 上面方法只提供了从jar中读资源文件功能，没有提供改写jar中资源文件方法，.net

经过URL、URLConnection来获得jar中资源文件的输入流（InputStream）和输出流 (OutputStream)，不只能够从jar中读取资源文件并且还能够改写jar中资源文件code

URL url = 类.class.getResource("XX.config");  
URLConnection  urlConnection=url.openConnection();  
//读资源文件  
InputStream inputStream=urlConnection.getInputStream();  
BufferedReader in=new BufferedReader(new InputStreamReader(inputStream,"utf-8"));  
//写资源文件  
OutputStream outputStream=urlConnection.getOutputStream();  
PrintStream printStream=new PrintStream(outputStream);

补充：刚测试了一下，利用URL、URLConnection来获得jar中资源文件的输出流 (OutputStream)很差使，提示java.net.UnknownServiceException: protocol doesn't support output，因为上述改写jar中资源文件方法很差使。对象

咱们能够换个角度，不要死扣非得读写jar中的资源文件，只有当软件第一次启动程序时才读jar中的资源文件，并将其备份到用户主目录或用户当前目录中，之后读写用户目录中的资源文件便可。首先咱们把资源文件打包到jar中，程序第一次程序启动时，仍然从jar中读资源文件信息（显然能够实现），并将所读取的信息保存到内存中（如：每次启动程序时，都将资源文件信息读到List或Map集合中保存），程序运行期间对资源文件的更新都是对List和Map的更新，当第一次关闭程序时，才将内存中保存的资源信息写到System.getProperty("user.home")用户主目录（或System.getProperty("user.dir")用户当前目录）中，并生成一个与jar中资源文件如出一辙的文件，之后程序启动时都从用户目录的资源文件中读写。只有当用户目录中的资源文件不存在时（这里程序能够判断一下），才从jar中的资源文件读信息，所以jar中的资源文件只是起到原始备份做用。图片

固然，这样作会有2个问题(1)：就是每次程序安装在一新机器上时，读取的资源文件信息都是jar中的原始资源信息，中途咱们可能更新过，解决方法：将更新的资源文件再一次打包到jar中(2):因为每次对资源文件信息的更新都是对对应的内存数据的更新，只有在关闭程序时才写回到资源文件中，没有随改随写，这样就可能形成这样一种后果，若是程序不是很健壮，程序中途bug并没有响应，此时只能强制关闭，务必形成更新的资源信息没有写回到资源文件中！！！解决方案：每次对内存中资源信息的更新后立刻写回到文件中，利：保证了程序bug后资源文件仍然是最新的，弊：这样会形成频繁写文件操做，程序性能下降，(也不必定哦，试具体程序来看，因为它是资源文件，通常不会更新很频繁)。ip

（5）利用java.util.jar.JarFile?????没试过

从一个jar文件读取内容，而后写回一个jar文件。

首先经过一个JarFile file = new JarFile(fileName);

而后file.entries()能够获得一个jar文件内部元素的迭代器。同过这个迭代器咱们能够得到全部的JarEntry,

而后经过InputStream is = jarFile.getInputStream(jarEntry);能够得到这个JarEntry的输入流。

最后将is的内容同过JarOutputStream out = new JarOutputStream(new FileOutputStream(distJar));的out的out.write(int data)方法写入目标jar文件。