【解惑】深刻jar包：從jar包中讀取資源文件

咱們經常在代碼中讀取一些資源文件(好比圖片，音樂，文本等等)。在單獨運行的時候這些簡單的處理固然不會有問題。可是，若是咱們把代碼打成一個jar包之後，即便將資源文件一併打包，這些東西也找不出來了。看看下面的代碼：

Java代碼  

//源代碼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包)
      一、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代碼  

1. //源代碼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改寫成：

Java代碼  

1. //源代碼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文件了。