java 從jar包中讀取資源檔案

 在代碼中讀取一些資源檔案(比如圖檔，音樂，文本等等)，在內建環境(Eclipse)中運作的時候沒有問題。但當打包成一個可執行的jar包（将資源檔案一并打包）以後，這些資源檔案找不到，如下代碼：

Java代碼  

[java] 

view plain copy

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

        這段代碼寫在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代碼,來看看上面那段費解的話是什麼意思了：

1. //源代碼2：    
4. import java.net.URL;    
6.     public  void getResource() throws IOException{      
7.               //查找指定資源的URL，其中res.txt仍然開始的bin目錄下     
8.         URL fileURL=this.getClass().getResource("/resource/res.txt");     
9.         System.out.println(fileURL.getFile());    
11.     public static void main(String[] args) throws IOException {    
12.         Resource res=new Resource();    
13.         res.getResource();    
15. }    

        運作這段源代碼結果：/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類的測試代碼：

1. import java.io.IOException;    
2. import edu.hxraid.Resource;    
3. public class TEST {    

           這時的運作結果是：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改寫成：

1. //源代碼3：    
5.     public void getResource() throws IOException{    
6.         //傳回讀取指定資源的輸入流    
7.         InputStream is=this.getClass().getResourceAsStream("/resource/res.txt");       
8.        //InputStream is=目前類.class.getResourceAsStream("XX.config");     
9.         BufferedReader br=new BufferedReader(new InputStreamReader(is));    

           我們将java工程下/bin目錄中的edu/hxraid/Resource.class和資源檔案resource/res.txt一并打包進ResourceJar.jar中，不管jar包在系統的任何目錄下，調用jar包中的Resource類都可以獲得jar包中的res.txt資源，再也不會找不到res.txt檔案了。

 (4) 上面方法隻提供了從jar中讀資源檔案功能，沒有提供改寫jar中資源檔案方法，

    通過URL、URLConnection來得到jar中資源檔案的輸入流（InputStream）和輸出流 (OutputStream)，不僅可以從jar中讀取資源檔案而且還可以改寫jar中資源檔案

1. URL url = 類.class.getResource("XX.config");  
2. URLConnection  urlConnection=url.openConnection();  
3. //讀資源檔案  
4. InputStream inputStream=urlConnection.getInputStream();  
5. BufferedReader in=new BufferedReader(new InputStreamReader(inputStream,"utf-8"));  
6. //寫資源檔案  
7. OutputStream outputStream=urlConnection.getOutputStream();  
8. 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後資源檔案仍然是最新的，弊：這樣會造成頻繁寫檔案操作，程式性能降低，(也不一定哦，試具體程式來看，由于它是資源檔案，一般不會更新很頻繁)。

（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檔案。