getResource和getResourceAsStream以及路径问题

用JAVA获取文件，听似简单，但对于很多像我这样的新人来说，还是掌握颇浅，用起来感觉颇深，大常最经常用的，就是用JAVA的File类，如要取得c:/test.txt文件，就会这样用Filefile = 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 =new File(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 =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文件后，再newInputStream(file)一样的结果

◆一般情况下,我们都使用相对路径来获取资源,这样的灵活性比较大.

比如当前类为com/bbebfe/Test.class

而图像资源比如sample.gif应该放置在com/bbebfe/sample.gif

而如果这些图像资源放置在icons目录下,则应该是com/bbebfe/icons/sample.gif

通过当前类文件的路径获取资源主要有如下几种方式:

· 假设当前类为com.bbebfe.Test

· 包所在的文件夹为bin

StringimageName ="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();

URLClassLoaderloader = (URLClassLoader)clazz.getClassLoader();

URL url =loader.getResource(imageName);

3, 通过ClassLoader.findResource()提供自己定制的方式定位资源

URL url = loader.findResource(imageName);

 

◆那么这三种方法有那些区别, 我们应该在何时使用哪种方法呢?

· Class.getResource() 方法

该方法实际通过该Class的ClassLoader的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.getSystemResource(java.lang.String).

· 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程序的语法是javacom.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 cancheck the form

File file = new File(path);

path = file.toString().replace('""','/');

// create a file URL (via File) to normalize theform (e.g., put

// the leading / on if necessary)

path = new File(path).toURL().getFile();

 

 

刚才试了一下，发现如果类路径上有重复的资源， getResource () 方法会返回类路径上碰到的第一个资源。  

而 getResources() 则会返回当前类加载器路径上的所有重复资源以及父类加载器上的所有重复资源。  

比如，在 tomcat/lib 目录下放置一个 zip 文件，包含 config/aaa.txt 文件，  
在 WEB-INF/lib 目录下复制一份这个 zip 文件，  
再在 src 目录下放上 config/aaa.txt 文件，  

getResource("config/aaa.txt") 返回结果是：  
file:/D:/eclipse/workspace/demo/WebContent/WEB-INF/classes/config/aaa.txt 

getResources("config/aaa.txt") 返回结果是：  
file:/D:/eclipse/workspace/demo/WebContent/WEB-INF/classes/config/aaa.txt 
jar:file:/D:/apache-tomcat-6.0.16/lib/aaaaa.jar!/config/aaa.txt 
jar:file:/D:/eclipse/workspace/demo/WebContent/WEB-INF/lib/bbbbb.jar!/config/aaa.txt