在代碼中讀取一些資源文件(好比圖片,音樂,文本等等),在集成環境(Eclipse)中運行的時候沒有問題。但當打包成一個可執行的jar包(將資源文件一併打包)之後,這些資源文件找不到,以下代碼:
Java代碼 :java
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代碼 :性能
//源代碼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代碼 :this
//源代碼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文件了。url
(4) 上面方法只提供了從jar中讀資源文件功能,沒有提供改寫jar中資源文件方法,.net
經過URL、URLConnection來獲得jar中資源文件的輸入流(InputStream)和輸出流 (OutputStream),不只能夠從jar中讀取資源文件並且還能夠改寫jar中資源文件code
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後資源文件仍然是最新的,弊:這樣會形成頻繁寫文件操做,程序性能下降,(也不必定哦,試具體程序來看,因爲它是資源文件,通常不會更新很頻繁)。ip
(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文件。