java 從jar包中讀取資原始檔
Java程式碼
這段程式碼寫在Eclipse建立的java Project中,其目錄為:(其中將資原始檔res.txt放在了bin目錄下,以便打成jar包)//原始碼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); } }
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程式碼,來看看上面那段費解的話是什麼意思了:
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程式碼
//原始碼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檔案了。(4) 上面方法只提供了從jar中讀資原始檔功能,沒有提供改寫jar中資原始檔方法,
通過URL、URLConnection來得到jar中資原始檔的輸入流(InputStream)和輸出流 (OutputStream),不僅可以從jar中讀取資原始檔而且還可以改寫jar中資原始檔
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後資原始檔仍然是最新的,弊:這樣會造成頻繁寫檔案操作,程式效能降低,(也不一定哦,試具體程式來看,由於它是資原始檔,一般不會更新很頻繁)。
(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檔案。