Java

访问资源的主要方式

在Java中，通常可以通过以下方式来访问资源：

  • Class的getResource方法;
  • ClassLoader的getResource方法;
  • ClassLoader的getResources方法; //获取批量资源
  • ClassLoader的getSystemResource; //静态方法

在使用中，Class可通过直接引用类的class属性而获得，或是通过实例的 getClass() 方法来获得。获取ClassLoader的方式则比较多，常见以下几种：

  • 调用Class的getClassLoader方法，如：getClass().getClassLoader()
  • 由当前线程获取ClassLoader：Thread.currentThread().getContextClassLoader()

  • 获取系统ClassLoader：ClassLoader.getSystemClassLoader()

    Class.getResource 与 ClassLoader.getResource 的区别

    1. public class ClassLoaderAndClassContrast {
    3.   public static void main(String[] args) throws Exception {
    4.       Class<ClassLoaderAndClassContrast> aClass = ClassLoaderAndClassContrast.class;
    5.       ClassLoader classLoader = aClass.getClassLoader();
    7.       URL resource = classLoader.getResource("cookies.properties");
    8.       URL resource1 = aClass.getResource("dir/cookies.properties");
    9.       if(resource!=null){
    10.           byte[] bytes = FileCopyUtils.copyToByteArray(resource.openStream());
    11.           System.out.println(new String(bytes));
    12.       }
    13.   }
    14. }

    两者最大的区别，是从哪里开始寻找资源。

  • ClassLoader并不关心当前类的包名路径，它永远以classpath为基点来定位资源。需要注意的是在用ClassLoader加载资源时，路径不要以”/“开头，所有以”/“开头的路径都返回null；

  • Class.getResource如果资源名是绝对路径(以”/“开头)，那么会以classpath为基准路径去加载资源，如果不以”/“开头，那么以这个类的Class文件所在的路径为基准路径去加载资源。

在实际开发过程中建议使用Class.getResource这个方法，但是如果想获取批量资源，那么就必须使用到ClassLoader的getResources()方法。

  1. public class ClassLoaderAndClassContrast {
  3.     Class<ClassLoaderAndClassContrast> cls = ClassLoaderAndClassContrast.class;
  4.     ClassLoader ldr = cls.getClassLoader();
  6.     public static void println(Object s) {
  7.         System.out.println(s);
  8.     }
  10.     void showResource(String name) {
  11.         println("## Test resource for: “" + name + "” ##");
  12.         println(String.format("ClassLoader#getResource(\"%s\")=%s", name, ldr.getResource(name)));
  13.         println(String.format("Class#getResource(\"%s\")=%s", name, cls.getResource(name)));
  14.     }
  16.     public final void testForResource() throws Exception {
  17.         showResource("");
  18.         //对于Class来，返回这个类所在的路径
  19.         showResource("/");
  20.         showResource(cls.getSimpleName() + ".class");
  21.         String n = cls.getName().replace('.', '/') + ".class";
  22.         showResource(n);
  23.         showResource("/" + n);
  24.         showResource("java/lang/Object.class");
  25.         showResource("/java/lang/Object.class");
  26.     }
  28.     public static void main(String[] args) throws Exception {
  29.         println("java.class.path: " + System.getProperty("java.class.path"));
  30.         println("user.dir: " + System.getProperty("user.dir"));
  31.         println("");
  32.         ClassLoaderAndClassContrast t = new ClassLoaderAndClassContrast();
  33.         t.testForResource();
  34.     }
  35. }

正确使用getResource方法

  • 避免使用 Class.getResource("/") 或 ClassLoader.getResource("")。应该传入一个确切的资源名，然后对输出结果作计算。比如，如果确实想获取当前类是从哪个类路径起点上执行的，以前面提到的test.App来说，可以调用 App.class.getResource(App.class.getSimpleName() + ".class")。如果所得结果不是 jar 协议的URL，说明 class 文件没有打包，将所得结果去除尾部的 “test/App.class”，即可获得 test.App 的类路径的起点；如果结果是 jar 协议的 URL，去除尾部的 “!/test/App.class”，和前面的 “jar:”，即是 test.App 所在的 jar 文件的url。
  • 如果要定位与某个类同一个包的资源，尽量使用那个类的getResource方法并使用相对路径。如前文所述，要获取与 test.App.class 同一个包下的 App.js 文件，应使用 App.class.getResource("App.js") 。当然，事无绝对，用 ClassLoader.getResource("test/App.js") 也可以，这取决于面对的问题是什么。
  • 如果对ClassLoader不太了解，那就尽量使用Class的getResource方法。
  • 如果不理解或无法确定该传给Class.getResource 方法的相对路径，那就以类路径的顶层包路径为参考起点，总是传给它以 “/“ 开头的路径吧。
  • 不要假设调试环境就是最后的运行环境。代码可能不打包，也可能打包，得考虑这些情况，不要埋坑。

    获取批量资源

    使用classLoader的getResources方法可以获得批量资源
    1. ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
    2. Enumeration<URL> resources = classLoader.getResources("META-INF/MANIFEST.MF");

    Spring的ResourceLoader

    在Spring框架中ResourceLoader和ResourcePatternResolver接口封装了获取资源的方法，可以直接拿来使用。ResourceUtils这个类中提供了很多判断资源类型的工具方法，可以直接使用。 ```java //前面三种的写法效果是一样的，必须从classpath基准目录开始写精确的匹配路径 //如果想匹配多个资源，需要以classpath*/打头，然后配合通配符使用 ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext(“beans.spring.xml”);

ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext(“/beans.spring.xml”);

ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext(“classpath:/beans.spring.xml”);

ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext(“classpath:/*/beans.spring.xml”);

  2. - `ResourceLoader` 接口
  3. - `ResourcePatternResolver` 接口 --- 重点
  5. 给出一个例子
  6. ```java
  7. String txt = "";
  8. ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
  9. Resource[] resources = resolver.getResources("templates/layout/email.html");
  10. Resource resource = resources[0];
  11. //获得文件流，因为在jar文件中，不能直接通过文件资源路径拿到文件，但是可以在jar包中拿到文件流
  12. InputStream stream = resource.getInputStream();
  13. StringBuilder buffer = new StringBuilder();
  14. byte[] bytes = new byte[1024];
  15. try {
  16.     for (int n; (n = stream.read(bytes)) != -1; ) {
  17.         buffer.append(new String(bytes, 0, n));
  18.     }
  19. } catch (IOException e) {
  20.     e.printStackTrace();
  21. }
  22. txt = buffer.toString();
  • ResourceUtils
  • ResourcePatternUtils