Java中getResourceAsStream的用法

[轉載]class.getResource()的用法

用JAVA獲取文件，聽似簡單，但對於很多像我這樣的新人來說，還是掌握頗淺，用起來感覺頗深，大常最經常用的，就是用JAVA的File類，如要取得c:/test.txt文件，就會這樣用File file = newFile("c:/test.txt");這樣用有什么問題，相信大家都知道，就是路徑硬編碼，對於JAVA精神來說，應用應該一次成型，到處可用，並且從現實應用來講，最終生成的應用也會部署到Windows外的操作系統中，對於linux來說，在應用中用了c:/這樣的字樣，就是失敗，所以，我們應該盡量避免使用硬編碼，即直接使用絕對路徑。 

　　在Servlet應用中，有一個getRealPath(String str)的方法，這個方法盡管也可以動態地獲得文件的路徑，不秘直接手寫絕對路徑，但這也是一個不被建議使用的方法，那么，我們有什么方法可以更好地獲得文件呢? 

      那就是Class.getResource()與Class.getResourceAsStream()方法，但很多人還是不太懂它的用法，因為很多人（比如不久前的我）都不知道應該傳怎么樣的參數給它，當然，有些人己經用得如火純青，這些人是不需要照顧的，在此僅給不會或者還不是很熟的人解釋一點點。 


比如我們有以下目錄 
|--project 
     |--src 
         |--javaapplication 
             |--Test.java 
             |--file1.txt 
         |--file2.txt 
     |--build 
         |--javaapplication 
             |--Test.class 
             |--file3.txt 
         |--file4.txt 

在上面的目錄中，有一個src目錄，這是JAVA源文件的目錄，有一個build目錄，這是JAVA編譯后文件(.class文件等）的存放目錄 
那么，我們在Test類中應該如何分別獲得 
file1.txt file2.txt file3.txt file4.txt這四個文件呢？ 

首先講file3.txt與file4.txt 
file3.txt: 
方法一：File file3 = new File(Test.class.getResource("file3.txt").getFile()); 
方法二：File file3 = new File(Test.class.getResource("/javaapplication/file3.txt").getFile()); 
方法三：File file3 = new File(Test.class.getClassLoader().getResource("javaapplication/file3.txt").getFile()); 

file4.txt: 
方法一：File file4 = new File(Test.class.getResource("/file4.txt").getFile()); 
方法二：File file4 = new File(Test.class.getClassLoader().getResource("file4.txt").getFile()); 

很好，我們可以有多種方法選擇，但是file1與file2文件呢？如何獲得？ 
答案是，你只能寫上它們的絕對路徑，不能像file3與file4一樣用class.getResource()這種方法獲得，它們的獲取方法如下 
假如整個project目錄放在c:/下，那么file1與file2的獲取方法分別為 
file1.txt 
方法一：File file1 = new File("c:/project/src/javaapplication/file1.txt"); 
方法二：。。。沒有 

file2.txt 
方法一：File file2 = new File("c:/project/src/file2.txt"); 
方法二：。。。也沒有 

總結一下，就是你想獲得文件，你得從最終生成的.class文件為着手點，不要以.java文件的路徑為出發點，因為真正使用的就是.class，不會拿個.java文件就使用，因為java是編譯型語言嘛 

至於getResouce()方法的參數，你以class為出發點，再結合相對路徑的概念，就可以准確地定位資源文件了，至於它的根目錄嘛，你用不同的IDEbuild出來是不同的位置下的，不過都是以頂層package作為根目錄，比如在Web應用中，有一個WEB-INF的目錄，WEB-INF目錄里面除了web.xml文件外，還有一個classes目錄，沒錯了，它就是你這個WEB應用的package的頂層目錄，也是所有.class的根目錄“/”，假如clasaes目錄下面有一個file.txt文件，它的相對路徑就是"/file.txt"，如果相對路徑不是以"/"開頭，那么它就是相對於.class的路徑。。 

還有一個getResourceAsStream()方法，參數是與getResouce()方法是一樣的，它相當於你用getResource()取得File文件后，再new InputStream(file)一樣的結果 

   

class.getResource("/") --> 返回class文件所在的頂級目錄，一般為包名的頂級目錄。 --> file:/home/duanyong/workspace/cxxx/xxxx/bin/WEB-INF/classes/ 
class.getResource("/xxx.txt") --> 返回頂級目錄下的xxx.txt路徑。 file://..../bin/WEB-INF/classes/xxx.txt 

getResource(String path),path是以class文件的頂級目標所在的相對路徑。如果頂級目錄為classes，在classes/xxx/yyy.txt這樣一個文件。取得yyy.txt的語法為：class.getResource("/xxx/yyy.txt"); 

示例代碼： 
查看復制到剪切板打印

1. //取得classes頂級目錄下的/xxx/yyy.txt文件   

2. System.out.println(Test.class.getResource("/xxx/yyy.txt"));   

3. //取得本class的上路徑   

4. System.out.println(Test.class.getResource(Test.class.getSimpleName() + ".class"));          

Java代碼  

1. //取得classes頂級目錄下的/xxx/yyy.txt文件  

2. System.out.println(Test.class.getResource("/xxx/yyy.txt"));  

3. //取得本class的上路徑  

4. System.out.println(Test.class.getResource(Test.class.getSimpleName() + ".class"));          

結果： 
file:/home/duanyong/workspace/test/bin/WEB-INF/classes/xxx/yyy.txt 
file:/home/duanyong/workspace/test/bin/WEB-INF/classes/cn/duanyong/test/Test.class 

 

 

 

 

 

首先，Java中的getResourceAsStream有以下幾種： 
1. Class.getResourceAsStream(String path) ： path 不以’/'開頭時默認是從此類所在的包下取資源，以’/'開頭則是從ClassPath根下獲取。其只是通過path構造一個絕對路徑，最終還是由ClassLoader獲取資源。 

2. Class.getClassLoader.getResourceAsStream(String path) ：默認則是從ClassPath根下獲取，path不能以’/'開頭，最終是由ClassLoader獲取資源。 

3. ServletContext. getResourceAsStream(String path)：默認從WebAPP根目錄下取資源，Tomcat下path是否以’/'開頭無所謂，當然這和具體的容器實現有關。 

4. Jsp下的application內置對象就是上面的ServletContext的一種實現。 

其次，getResourceAsStream 用法大致有以下幾種： 

第一： 要加載的文件和.class文件在同一目錄下，例如：com.x.y 下有類me.class ,同時有資源文件myfile.xml 

那么，應該有如下代碼： 

me.class.getResourceAsStream("myfile.xml"); 

第二：在me.class目錄的子目錄下，例如：com.x.y 下有類me.class ,同時在 com.x.y.file 目錄下有資源文件myfile.xml 

那么，應該有如下代碼： 

me.class.getResourceAsStream("file/myfile.xml"); 

第三：不在me.class目錄下，也不在子目錄下，例如：com.x.y 下有類me.class ,同時在 com.x.file 目錄下有資源文件myfile.xml 

那么，應該有如下代碼： 

me.class.getResourceAsStream("/com/x/file/myfile.xml"); 

總結一下，可能只是兩種寫法 

第一：前面有 “   / ” 

“ / ”代表了工程的根目錄，例如工程名叫做myproject，“ / ”代表了myproject 

me.class.getResourceAsStream("/com/x/file/myfile.xml"); 

第二：前面沒有 “   / ” 

代表當前類的目錄 

me.class.getResourceAsStream("myfile.xml"); 

me.class.getResourceAsStream("file/myfile.xml"); 

最后，自己的理解： 
getResourceAsStream讀取的文件路徑只局限與工程的源文件夾中，包括在工程src根目錄下，以及類包里面任何位置，但是如果配置文件路徑是在除了源文件夾之外的其他文件夾中時，該方法是用不了的。