Class类下的getResource和ClassLoader类下的getResource方法使用和区别

Class类下的getResource和ClassLoader类下的getResource方法使用和区别

通过getResource(String name)方法，我们能获得一个URL对象读取资源

先说结论：

1. MyClass.class.getResource(“xxx”)方法中传的参数如果是相对路径，那么传递的路径是相对于MyClass而言

2. MyClass.class.getResource("/xxx")方法中传的参数如果是绝对路径，那么传递的路径是相对于classpath而言

3.MyClass.class.getClassLoader().getResource(“xxx”)方法中传的参数如果是相对路径，那么传递的路径是相对于classpath而言

4.MyClass.class.getClassLoader().getResource("/xxx")方法中传的参数如果是绝对路径，也就是只要参数开头带/那么返回的都是null

案例说明

目录结构

测试类

public class Test {
    public static void main(String[] args) {
        
    }


    private static void testMethod(String name) {
        URL classUrl = ClassTwo.class.getResource(name);
        URL classLoaderUrl = ClassTwo.class.getClassLoader().getResource(name);
        System.out.println("传递的参数是：" + name);
        System.out.println("ClassTwo类下的getResource方法获取的路径：" + classUrl);
        System.out.println("ClassTwo类的ClassLoader下的getResource方法获取的路径：" + classLoaderUrl);
        System.out.println("=====================================================================================================");
    }
}

方法调用

下面对传递不同路径时，Class的getResource(String name)方法和ClassLoader的getResource(String name)方法所返回的结果进行比较。

1.当传入的参数是空串时

 public static void main(String[] args) {
        // 当传入的参数是空串时
        String name = "";
        testMethod(name);
    }

返回的结果：
传递的参数是：
ClassTwo类下的getResource方法获取的路径：file:/H:/Wu/IDEAWorkspce2/gupao/demo/target/classes/com/wsp/
ClassTwo类的ClassLoader下的getResource方法获取的路径：file:/H:/Wu/IDEAWorkspce2/gupao/demo/target/classes/

2.当传入的参数是 / 时

public static void main(String[] args) {
        // 当传入的参数是 / 时
        String name = "/";
        testMethod(name);
    }

返回的结果是：
传递的参数是：/
ClassTwo类下的getResource方法获取的路径：file:/H:/Wu/IDEAWorkspce2/gupao/demo/target/classes/
ClassTwo类的ClassLoader下的getResource方法获取的路径：null

3.当传入的参数是ClassTwo类的相对路径时

public static void main(String[] args) {
        // 当传入的参数是ClassTwo类的相对路径时
        String name = "test";
        testMethod(name);
    }

返回的结果是：
传递的参数是：test
ClassTwo类下的getResource方法获取的路径：file:/H:/Wu/IDEAWorkspce2/gupao/demo/target/classes/com/wsp/test
ClassTwo类的ClassLoader下的getResource方法获取的路径：null

4.当传入的参数是classpath的相对路径时

public static void main(String[] args) {
        // 当传入的参数是classpath的相对路径时
        String name = "com/wsp";
        testMethod(name);
    }

返回的结果：
传递的参数是：com/wsp
ClassTwo类下的getResource方法获取的路径：null
ClassTwo类的ClassLoader下的getResource方法获取的路径：file:/H:/Wu/IDEAWorkspce2/gupao/demo/target/classes/com/wsp

5.当传入的参数是classpath的绝对路径时

 public static void main(String[] args) {
        // 当传入的参数是classpath的绝对路径时
        String name = "/com/wsp";
        testMethod(name);
    }

返回的结果：
传递的参数是：/com/wsp
ClassTwo类下的getResource方法获取的路径：file:/H:/Wu/IDEAWorkspce2/gupao/demo/target/classes/com/wsp
ClassTwo类的ClassLoader下的getResource方法获取的路径：null

使用小结

通过上面的例子，简单来说就是如果使用ClassLoader的getResource(String name)方法时，传递的路径不能是绝对路径，且传递的路径必须是相对于classpath的路径，如果传入""就相当于获取classpath路径。使用Class的getResource(String name)方法，如果传递的是绝对路径则是相对于classpath而已，如果传递的是相对路径，那么就是相对于Class而言的，比如ClassTwo.class.getResource(name)，那么传递的路径就是相对于ClassTwo这个类的路径而言。

源码分析

上面的案例只是让我们知道了该如何使用ClassLoader的getResource(String name)和Class的getResource(String name)方法，那么他们到底有啥区别的，下面我们对源码进行简单的分析。

首先我们先来看一下ClassLoader的getResource(String name)的源码，这里有用到类加载机制的知识，具体参考这篇博客java类加载机制

 public URL getResource(String name) {
        URL url;
     // 这里的parent是ExtensionClassLoader（标准扩展类加载器）
        if (parent != null) {
            // 递归调用，第二次进入时，parent为null
            url = parent.getResource(name);
        } else {
            //到达系统启动类加载器
            url = getBootstrapResource(name);
        }
        if (url == null) {
            //系统启动类加载器没有加载到，递归回退到第一次调用然后是扩展类加载器
            url = findResource(name);
        }
     //最后如果都没有加载到，双亲委派加载失败，则加载应用本身自己的加载器。
        return url;
    }

再来看下Class的getResource(String name)方法

public java.net.URL getResource(String name) {
        name = resolveName(name);
    	// 获取加载该Class的ClassLoader
        ClassLoader cl = getClassLoader0();
        if (cl==null) {
            //如果加载该Class的ClassLoader为null，则表示这是一个系统class
            return ClassLoader.getSystemResource(name);
        }
    	//调用ClassLoader的getResource方法
        return cl.getResource(name);
    }

我们看到Class的getResource先是调用了resolveName(name)方法然后又获取了该类的ClassLoader，再调用ClassLoader的getResource方法，因此关键的方法就是resolveName方法，我们看看这个方法对传进去的参数做了什么操作。

private String resolveName(String name) {
        if (name == null) {
            return name;
        }
    	// 判断是不是/开头的绝对路径
        if (!name.startsWith("/")) {
            // 获取calss信息
            Class<?> c = this;
            while (c.isArray()) {
                c = c.getComponentType();
            }
            // 获取class全路径,在之前案例中的beanName的值为com.wsp.ClassTwo
            String baseName = c.getName();
            int index = baseName.lastIndexOf('.');
            if (index != -1) {
                // 也就是com.wsp.ClassTwo变成com/wsp + / + name
                name = baseName.substring(0, index).replace('.', '/')
                    +"/"+name;
            }
        } else {
            // 如果是/开头的则去掉/
            name = name.substring(1);
        }
        return name;
    }

这个方法也就是对传进来的name参数进行了改变，如果是/开头的则去掉/直接返回，如果不是以/开头的则获取Class所在的路径加上name返回，以之前的例子为例，ClassTwo.class.getResource("");，在resolveName(String name)中返回的结果是com/wsp/。

小结

Class.getResource和ClassLoader.getResource最终都是使用ClassLoader.getResource加载资源的，不同的是Class.getResource真正调用ClassLoader.getResource方法之前，会先获取文件的路径（path不以’/‘开头时，默认是从此类所在的包下取资源；path以’/'开头时，则是从项目的ClassPath根下获取资源）。ClassLoader.getResource方法会通过双亲委派机制，先委派双亲去加载类，如果双亲没有加载到，则再由自己加载。

参考博客：
彻底搞懂Class.getResource和ClassLoader.getResource的区别和底层原理
java类加载机制