1. 程式人生 > >深入jar包:從jar包中讀取資原始檔getResourceAsStream

深入jar包:從jar包中讀取資原始檔getResourceAsStream

一、背景

  我們常常在程式碼中讀取一些資原始檔(比如圖片,音樂,文字等等)。

  在單獨執行的時候這些簡單的處理當然不會有問題。但是,如果我們把程式碼打成一個jar包以後,即使將資原始檔一併打包,這些東西也找不出來了。

  myproject

    |___src

  |___edu.hxraid

        |__Resource.java

|___bin

  |___resource

      |__res.txt

       |__edu.hxraid

              |__Resource.class

二、情況1 (本地 對;部署 錯) 

//原始碼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是能夠找到資原始檔res.txt。但當我們把整個工程打成jar包以後(ResourceJar.jar),這個jar包內的目錄

為:
              

             而這時jar包中Resource.class位元組碼:"bin/resource/res.txt"  將無法定位到jar包中的res.txt位置上。就算把bin/目錄去掉, "resource/res.txt" 仍然無法定位到jar包中res.txt上。

          這主要是因為jar包是一個單獨的檔案而非資料夾,絕對不可能通過"file:/e:/.../ResourceJar.jar/resource/res.txt"這種形式的檔案URL來定位res.txt。

        所以即使是相對路徑,也無法定位到jar檔案內的txt檔案。

 

三、情況2 (本地 對;部署 錯)  

    (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()方法 

//原始碼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中的資原始檔的,這一點對於我們來說是透明的。

//原始碼3:  
package edu.hxraid;  
import java.io.*;  
public class Resource {  
    public void getResource() throws IOException{  
        //返回讀取指定資源的輸入流  
        InputStream is=this.getClass().getResourceAsStream("/resource/res.txt");   
        // 或者 this..getClass().getClassLoader().getResourceAsStream("res.txt");
        // 如果是resource目錄下可以直接寫檔名稱
        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檔案了。

 

原文地址

【解惑】深入jar包:從jar包中讀取資原始檔