资源获取解析

在 开发java程序的过程当中，咱们常常要作的一件事就是获取资源。那么什么是资源呢？说白了，在计算机里那就是一堆数据。只是这堆数据对咱们的java程 序有多种表现形式，通常来讲有File，URL，InputStream等等。而单就文件这一项就有不少种：配置文件，java类文件，jps文件，图 片、css、js文件等等。面对这林林总总的资源，咱们在设计一个读取资源的接口时，就须要针对不一样形式的资源提供方法，这样就致使咱们的接口仍是与实际 的资源形式绑定在一块儿，未能彻底的抽象。另外，在java程序中资源的存放位置也是各异的。有的存放在classpath中，有的存放在文件系统中，有的 存放在web应用中。而对于不一样位置的资源，java程序获取这些资源的方法各有不一样。
 
A、获取classpath中的资源：
Java代码  URL url = this.getClass().getResource("resource_name");  
URL url = this.getClass().getClassLoader().getResource("resource_name");  
URL url = Thread.currentThread().getContextClassLoader().getResource("resource_name");  
 那么在jdk中为何又提供了三种方式来获取classpath下的资源呢？这其中是有些来头的。 
第一行代码中是利用Class类的实例来获取，第二行代码是使用加载当前类的classloader来获取。看下jdk中的源代码会发现class类的实例最后仍是委托加载他的classloader来获取资源的。
Java代码  public java.net.URL getResource(String name) {  
    name = resolveName(name);  
    ClassLoader cl = getClassLoader0();  
    if (cl==null) {  
        // A system class.  
        return ClassLoader.getSystemResource(name);  
    }  
    return cl.getResource(name);  
}  
 从上面的代码中能够看出，对于资源的加载并无像类加载所采用的双亲委托机制。而是当前类的classloader不为null的情 况下先从当前类的 classloader中加载资源。而只有当前类的classloader为null的时候才从system classloader中去加载资源。这样能够方便咱们自定义配置类覆盖一些默认配置。固然，j2se应用中若是没有特别定制classloader时， 咱们本身写的类都是被system classloader加载的。到底利用class去获取资源和利用classloader去获取资源有什么区别呢？区别就在 resolveName(name)这个方法中。两种方式对于资源名称的表示方式不一样。下面是一个简单的包结构，/表示类路径的根 
/ 
|-com.cn.test 
   |-Test.class 
   |-test2.txt  
|-test1.txt
Java代码  // 获取与当前类在同一个包下的资源  
URL url1 = this.getClass().getResource("test2.txt");  
// 获取com.cn.test包下的资源,需加/  
URL url2 = this.getClass().getResource("/com/cn/test/test2.txt");  
// 获取类路径根下的资源  
URL url3 = this.getClass().getClassLoader().getResource("test1.txt");  
// 获取包com.cn.test包下的资源  
URL url4 = this.getClass().getResource("com/cn/test/test2.txt");  
 而第三利用当前线程的contextClassLoader来获取资源的解释能够参考个人另外一篇

B、获取文件系统中的资源
Java代码  // 一、得到File对象  
File file = new File("test.txt");  
// 二、得到File对象的字节流  
InputStream in = new FileInputStream(file);  
 值得注意的是在File的构造函数File(String name) 中的name参数能够是相对路径和绝对路径。相对路径是相对于System.getProperties("user.dir")的。

C、获取web应用中的资源
Java代码  servletContext.getResourceAsStream(resource_name);  
 
resource_names为相对于webroot的路径表示。例如获取web.xml，resource_name表示为"/WEB-INF/web.xml" 

    面对上面介绍的各类资源表现形式和存放位置，难道java中就没有提供一个统一处理方式吗？有，java.net.URL。 
从名称上来看 URL(Uniform Resource Locator) 统一资源定位器。看起来很好很强大。但不少时候使用它并不能定位到咱们须要的资源。 
    首先，它jdk中体统的URL能访问的协议很是有限（固然能够进行扩展，不过很麻烦）；经常使用的有http,file,ftp等等。并无提供对classpath和servletContext中的资源的获取方法。 
    另外，它没有提供判断资源是否存在的方法。每次只有等咱们真正去获取资源的时候抛出异常才能知道资源没法获取。 
    其次，URL这个类的职责未划分清楚，既用来表示资源有用来获取其资源。
 
如下内容
From :  http://blog.csdn.net/ruyanhai/archive/2007/11/07/1871663.aspx
 
◆通常状况下,咱们都使用相对路径来获取资源,这样的灵活性比较大.
 
好比当前类为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)
 
Java代码  Class clazz = this.getClass();  
  
URLClassLoader loader = (URLClassLoader)clazz.getClassLoader();  
  
URL url = loader.getResource(imageName);  
 3, 经过ClassLoader.findResource()提供本身定制的方式定位资源
Java代码  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.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程序的语法是java com.bbebfe.ui.Test, 因此根目录是com目录的上级目录).
 
 
 
◆最后, 在Java中对资源进行定位的方法有不少种, 在Eclipse源代码中还有以下一段定位文件资源的代码,尚未时间研究:
 
Java代码  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();