getResourceAsStream和getResource的用法及Demo实例

 
用JAVA获取文件，听似简单，但对于很多像我这样的新人来说，还是掌握颇浅，用起来感觉颇深，大家最经常用的，就是用JAVA的File类，如要取得 D:/test.txt文件，就会这样用File file = newFile("D:/test.txt");
这样用有什么问题，相信大家都知道，就是路径硬编码，对于JAVA精神来说，应用应该一次成型，到处可 用，并且从现实应用来讲，最终生成的应用也会部署到Windows外的操作系统中，对于linux来说，在应用中用了c:/这样的字样，就是失败，
所以， 我们应该尽量避免使用硬编码，即直接使用绝对路径。 

在Servlet应用中，有一个getRealPath(String str)的方法，这个方法尽管也可以动态地获得文件的路径，不秘直接手写绝对路径，但这也是一个不被建议使用的方法，那么，我们有什么方法可以更好地获得文件呢? 

       那就是Class.getResource()与Class.getResourceAsStream()方法！
 
 
一、getResourceAsStream用法
首先，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");   
 
二、getResource用法
 
 比如我们有以下目录 
|--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 （三种获取方式）：
 
Java代码  
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:（二种获取方式）：
 
Java代码  
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
Java代码  
File file1 = new File("c:/project/src/javaapplication/file1.txt");   
 
file2.txt
Java代码  
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");
 
 

//取得classes顶级目录下的/xxx/yyy.txt文件     
System.out.println(Test.class.getResource("/xxx/yyy.txt"));     
//取得本class的上路径     
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
 
三、getResourceAsStream与getResource用法比较实例
注：testpinyin.txt 放于项目的src下
 
import java.io.IOException;  
import java.io.InputStream;  
  
public class Test {  
     public void getResource(String url){  
         InputStream stream = getClass().getResourceAsStream(url);  
         System.out.println(getClass().getResource(url));  
         byte[] line = new byte[1024*1024];  
         try {  
             stream.read(line);  
         } catch (IOException e) {  
             // TODO Auto-generated catch block  
             e.printStackTrace();  
         }  
         String str = new String(line);  
         System.out.println(str.trim());  
     }  
       
     public static void main(String[] args) {  
         new Test().getResource("/testpinyin.txt");  
     }  
}  
 
 运行结果：
file:/E:/workspace/testhttpclient/bin/testpinyin.txt
emergency
第一行得到的是testpinyin.txt的路径，第二行是testpinyin.txt的内容。
需要注意的是必须有前面的“/”，“/”代表的是工程名，否则找不到。