从jar包中读取资源文件

文章转自：http://www.diyhi.net/bbs/thread-436-1-1.html

JAVA从jar包中读取资源文件

 

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

1. import java.io.*;
2. public class Resource {
3.         public  void getResource() throws IOException{
4.                 File file=new File("bin/resource/res.txt");
5.                 BufferedReader br=new BufferedReader(new FileReader(file));
6.                 String s="";
7.                 while((s=br.readLine())!=null)
8.                         System.out.println(s);
9.         }
10. }

复制代码

这段代码写在Eclipse建立的java Project中，其目录为：(其中将资源文件res.txt放在了bin目录下，以便打成jar包): I/ \2 Z" q% s. d: T# h/ e6 P
      1、src/' H' B8 h. x. r# J+ M
              src/edu/hxraid/Resource.java+ R. F9 w! d" S' h$ B% a
      2、bin/
  R  f! Z$ M2 w" e/ O( N" @              bin/resource/res.txt
+ F5 [# @$ _, E5 Q* o9 K              bin/edu/hxraid/Resource.class 0 }+ u( D. S2 s2 M$ {1 ~
/ ?7 V* n* f- p6 I
      很显然运行源代码1是能够找到资源文件res.txt。但当我们把整个工程打成jar包以后(ResourceJar.jar)，这个jar包内的目录为：+ p. J5 Q  o) H; Z
              edu/hxraid/Resource.class  G4 H+ T7 q! z$ V3 A
              resource/res.txt
. J! p. }! J. W: ?
) n$ Y3 I) y  R# x- r  d
$ O' P7 s. S) k' l  ^. P8 J" W3 V- ~2 z
         而这时jar包中Resource.class字节码：ldc <String "bin/resource/res.txt"> [20] 将无法定位到jar包中的res.txt位置上。就算把bin/目录去掉：ldc <String "resource/res.txt"> [20] 仍然无法定位到jar包中res.txt上。 ' o8 f* r8 q" p: R

2 Z: u+ H( _6 A$ b      这主要是因为jar包是一个单独的文件而非文件夹，绝对不可能通过"file:/e:/.../ResourceJar.jar/resource /res.txt"这种形式的文件URL来定位res.txt。所以即使是相对路径，也无法定位到jar文件内的txt文件(读者也许对这段原因解释有些费解，在下面我们会用一段代码运行的结果来进一步阐述)。 . z; O- B4 h6 H/ z3 d
$ @9 _7 m; K" F
6 a9 [- x5 @8 G/ {

; p, K  A4 C5 G) i# I          那么把资源打入jar包，无论ResourceJar.jar在系统的什么路径下，jar包中的字节码程序都可以找到该包中的资源。这会是幻想吗？
+ b9 G4 t1 ?) S8
1 R6 d, R% A$ @9
3 j+ T1 S9 P& V+ H1 }*
' E9 P. a5 Q7 s' o9 r. z.
& J" m' r! b+ k      当然不是，我们可以用类装载器(ClassLoader)来做到这一点： $ |$ ?9 p; c; q9 z7 R& d

+ x% \7 H0 A) [& l& ?. U& E         (1) ClassLoader 是类加载器的抽象类。它可以在运行时动态的获取加载类的运行信息。 可以这样说，当我们调用ResourceJar.jar中的Resource类时，JVM加载进Resource类，并记录下Resource运行时信息(包括Resource所在jar包的路径信息)。而ClassLoader类中的方法可以帮助我们动态的获取这些信息:' d# _! v: \& }; s
          ● public URL getResource(String name)
9 r+ h  {4 h2 v! x: Q% ^            查找具有给定名称的资源。资源是可以通过类代码以与代码基无关的方式访问的一些数据(图像、声音、文本等)。并返回资源的URL对象。
4 X# {( n: p: G! v# M          ● public InputStream getResourceAsStream(String name); ) x' V+ s* Z6 F
             返回读取指定资源的输入流。这个方法很重要，可以直接获得jar包中文件的内容。 $ l# I; G0 D8 g% z5 A

& Y) l% m; p, u" a          - N  F. C& b7 x9 W2 l' g6 q% i, ^

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

1. import java.io.*;
2. import java.net.URL;
3. public class Resource {
4.         public  void getResource() throws IOException{       
5.               //查找指定资源的URL，其中res.txt仍然开始的bin目录下
6.                 URL fileURL=this.getClass().getResource("/resource/res.txt");
7.                 System.out.println(fileURL.getFile());
8.         }
9.         public static void main(String[] args) throws IOException {
10.                 Resource res=new Resource();
11.                 res.getResource();
12.         }
13. }

复制代码

运行这段源代码结果：/E:/Code_Factory/WANWAN/bin/resource/res.txt  (../ Code_Factory/WANWAN/.. 是java project所在的路径) + [4 m2 }; p3 ]  n
$ z& j: ]" b8 R+ E. V
           我们将这段代码打包成ResourceJar.jar ,并将ResourceJar.jar放在其他路径下(比如 c:\ResourceJar.jar)。然后另外创建一个java project并导入ResourceJar.jar，写一段调用jar包中Resource类的测试代码：

1. import java.io.IOException;
2. public class TEST {
3.         public static void main(String[] args) throws IOException {
4.                 Resource res=new Resource();
5.                 res.getResource();
6.         }
7. }  

复制代码

这时的运行结果是：file:/C:/ResourceJar.jar!/resource/res.txt
0 L# a) S! S. b3 a: M
8 j" s( A7 u! s) o% [ / w: x, r, M: M- b2 W4 e
5 P7 O4 i/ w* s0 n* E3 b# i
           我们成功的在运行时动态获得了res.txt的位置。然而，问题来了，你是否可以通过下面这样的代码来得到res.txt文件？' s" }8 O$ D- |$ n- Q
                      File f=new File("C:/ResourceJar.jar!/resource/res.txt");8 J+ `9 X6 \9 i2 o9 ^: _8 E  e
            当然不可能，因为".../ResourceJar.jar!/resource/...."并不是文件资源定位符的格式 (jar中资源有其专门的URL形式： jar:<url>!/{entry} )。所以，如果jar包中的类源代码用File f=new File(相对路径);的形式，是不可能定位到文件资源的。这也是为什么源代码1打包成jar文件后，调用jar包时会报出FileNotFoundException的症结所在了。 7 t, d# n" T8 X5 l+ O
& d$ x1 a4 N6 S- D% X' a

& c0 K3 K/ Y6 }3 `- T, v8 d+ R2 M" _% E
          (3) 我们不能用常规操作文件的方法来读取ResourceJar.jar中的资源文件res.txt，但可以通过Class类的getResourceAsStream()方法来获取 ，这种方法是如何读取jar中的资源文件的，这一点对于我们来说是透明的。我们将Resource.java改写成：

1. import java.io.*;   
2. public class Resource {   
3.     public void getResource() throws IOException{   
4.         //返回读取指定资源的输入流   
5.         InputStream is=this.getClass().getResourceAsStream("/resource/res.txt");   
6.         BufferedReader br=new BufferedReader(new InputStreamReader(is));   
7.         String s="";   
8.         while((s=br.readLine())!=null)   
9.             System.out.println(s);   
10.     }   

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