Java中如何以类为相对路径或以库为相对路径定位资源

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

比如当前类为 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)

Class clazz = this.getClass();

URLClassLoader loader = (URLClassLoader)clazz.getClassLoader();

URL url = loader.getResource(imageName);

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

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 源代码中还有如下一段定位文件资源的代码 , 还没有时间研究 , 以后再谈 :

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();