java中Class.getResource用法

转自： http://blog.sina.com.cn/s/blog_5f3d71430100ww8t.html

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

 

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

 

     那就是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 = newFile(Test.class.getResource("file3.txt").getFile());

方法二：File file3 = newFile(Test.class.getResource("/javaapplication/file3.txt").getFile());

方法三：File file3 = newFile(Test.class.getClassLoader().getResource("javaapplication/file3.txt").getFile());

 

file4.txt:

方法一：File file4 = newFile(Test.class.getResource("/file4.txt").getFile());

方法二：File file4 = newFile(Test.class.getClassLoader().getResource("file4.txt").getFile());

很好，我们可以有多种方法选择，但是file1与file2文件呢？如何获得？

答案是，你只能写上它们的绝对路径，不能像file3与file4一样用class.getResource()这种方法获得，它们的获取方法如下

假如整个project目录放在c:/下，那么file1与file2的获取方法分别为

file1.txt

方法一：File file1 = newFile("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文件后，再newInputStream(file)一样的结果

=========================================================================================

jar中读文件

我们常常在代码中读取一些资源文件(比如图片，音乐，文本等等)。在单独运行的时候这些简单的处理当然不会有问题。但是，如果我们把代码打成一个jar包以后，即使将资源文件一并打包，这些东西也找不出来了。看看下面的代码：

Java代码

//源代码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);  
    }  
}  

   

       这段代码写在Eclipse建立的javaProject中，其目录为：(其中将资源文件res.txt放在了bin目录下，以便打成jar包)
     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)。然后另外创建一个javaproject并导入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=newFile("C:/ResourceJar.jar!/resource/res.txt");
           当然不可能，因为".../ResourceJar.jar!/resource/...."并不是文件资源定位符的格式(jar中资源有其专门的URL形式：jar:<url>!/{entry})。所以，如果jar包中的类源代码用Filef=newFile(相对路径);的形式，是不可能定位到文件资源的。这也是为什么源代码1打包成jar文件后，调用jar包时会报出FileNotFoundException的症结所在了。

 

         (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");   
        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文件了。

ClassLoader.getSystemResourceAsStream("/t.xml");
ClassLoader.getSystemResourceAsStream("t.xml");
两个之间的区别是什么?

/t不是控制字符（如果你指的是转义字符的话），因为“\t”才是制表符。

“/”代表的是“根”~~就是windows里分区根目录，linux里的“ROOT”，而不写“/”默认表示当前文件夹。

比如，你工作在“c:\prog\java”下，“t.xml”表示“c:\prog\java\t.xml”，而“/t.xml”表示“c:\t.xml”

注：windows中“\”、“/”都可以表示路径分割线，linux中只能用“/”。