Java中如何以類為相對路徑或以庫為相對路徑定位資源
◆一般情況下,我們都使用相對路徑來獲取資源,這樣的靈活性比較大.
比如當前類為com/bbebfe/Test.class
而影象資源比如sample.gif應該放置在com/bbebfe/sample.gif
而如果這些影象資源放置在icons目錄下,則應該是com/bbebfe/icons/sample.gif
通過當前類檔案的路徑獲取資源主要有如下幾種方式:
· 假設當前類為com.bbebfe.Test
· 包所在的資料夾為bin
String imageName = "icons/sample.gif"
1, 通過Class.getResource()定位類路徑下的資源(bin/com/bbebfe/icons/sample.gif)
Class clazz = this.getClass();
URL url = clazz.getResource(imageName);
2,通過ClassLoader.getResource()定位包的根目錄下的資源(bin/icons/sample.gif)
Class clazz = this.getClass();
URLClassLoader loader = (URLClassLoader)clazz.getClassLoader();
URL url = loader.getResource(imageName);
3, 通過ClassLoader.findResource()
URL url = loader.findResource(imageName);
◆那麼這三種方法有那些區別, 我們應該在何時使用哪種方法呢?
· Class.getResource() 方法
該方法實際通過該Class的Class Loader的getResource()方法來獲得資源, 在呼叫ClassLoader的getResource()方法之前, Class.getResource()方法會對資源名稱做一定的處理,構建一個該資源的絕對名稱(absolute name, 大意是:
＋如果資源名稱以'/'('/u002f') 開始, 則資源的絕對名稱是'/'以後的部分
如果imageName是"/icons/sample.gif", 則在這裡會變成"icons/sample.gif"
＋否則對於其他情況, 絕對名稱將是如下形式(給資源名稱的前面加上modified_package_name/):
modified_package_name/resource_name (修正的包名稱/資源名稱)
其中修正的包名稱含義是將當前物件所在的包名稱中的'.'('/u002e')替換為'/'
如果ClassLoader.getResource()方法返回一個值為null的URL, 則Class.getResource()方法最終會將資源請求交給
· ClassLoader.getResource() 方法
該對資源進行查詢, 資源的名稱是以'/'分隔的路徑, 這個方法首先查詢自己的父親ClassLoader, 由自己的父ClassLoader來查詢資源(實際上, 如果父親的父親不是空, 則父親仍會向上提交查詢請求). 如果自己的父ClassLoader是null, 則查詢Java虛擬機器中內建的class loader, 並將資源請求提交給它們, 如果這些操作都失敗了, 則ClassLoader會呼叫自己的findResource()方法來查詢資源.
· ClassLoader.findResource() 方法
該方法在內部查詢指定的資源, 如果你實現了自己的Class Loader,則應該過載這個方法以自己特定的方式來查詢類檔案和資源.
◆通過以上的總結, 我們可以看到三點.
1, 無論是getResource(), 還是findResource(), 這些方法都只是資源的定位方法, 最終都只是返回一個URL, 只是對資源的定位而已, 我們隨後應通過自己的方法來讀取這些資源. 而在Class和ClassLoader中還定義的有getResourceAsStream方法, 該方法是getResource的增強版, 這裡就不介紹了.
2,如果需要以類為相對路徑查詢資源, 則應該呼叫Class.getResource()方法, 不要直接呼叫ClassLoader.getResource()方法. 另外, 除非是你自己定義了ClassLoader並重載了findResource方法,否則也不要直接呼叫ClassLoader.findResource方法, 因為在Class.getResource()方法中會對資源名稱作一定的處理, 這在上面介紹了, 下面舉個例項:
假設我的當前類在Eclipse工程Database下, 類所在的包是com.bbebfe.test, 而icons目錄放在bin/com/bbebfe/test/目錄下, 我需要得到icons/sample.gif檔案的URL, 則呼叫this.getClass().getResource()得到的URL是:
file:/E:/MyLife/MyProjects/Eclipse3.2/Database/bin/com/bbebfe/test/icons/disremove.gif
3, 有時候我們希望某個jar庫的影象資源在同一個icons下統一管理, 而不是為每個包下面的Class建一個icons, 也就是說需要以庫為相對路徑來查詢資源, 此時則應該呼叫ClassLoader.getResource()方法, 舉個例子:
·某個工程有如下的包結構:
com.bbebfe.ui
com.bbebfe.test
com.bbebfe.database
·如果以類為相對路徑, 則在每個包下都必須建立一個icons目錄, 並放置相應的資原始檔. 如下:
com.bbebfe.ui/icons/...
com.bbebfe.test/icons/...
com.bbebfe.database/icons/...
·而我們可能希望在根目錄下放置一個icons目錄, 把所有資源放置在這裡管理, 這樣還可以防止資源的重複. 就是如下形式
com.bbebfe.ui
com.bbebfe.test
com.bbebfe.database
icons/sample.gif ...
則此時我們應該呼叫ClassLoader.getResource方法, 由於它沒有對資源名稱作處理, 也就是說沒有將修正的包名新增到資源名稱前, 所以它會在類所在的包的根下去查詢資源.(執行java程式的語法是java com.bbebfe.ui.Test, 所以根目錄是com目錄的上級目錄).
◆最後, 在Java中對資源進行定位的方法有很多種, 在Eclipse原始碼中還有如下一段定位檔案資源的程式碼, 還沒有時間研究, 以後再談:
ProtectionDomain domain = Main.class.getProtectionDomain();
CodeSource source = null;
URL result = null;
if (domain != null)
source = domain.getCodeSource();//獲得code source
if (source != null)
result = source.getLocation();//獲得URL
String path = decode(result.getFile());//
// normalize to not have leading / so we can check the form
File file = new File(path);
path = file.toString().replace('//', '/');
// create a file URL (via File) to normalize the form (e.g., put
// the leading / on if necessary)
path = new File(path).toURL().getFile();