在Java中，為了從相對路徑讀取檔案，經常會使用的方法便是:

xxx.class.getResource();

xxx.class.getClassLoader().getResource();

在Spring中，我們還可以通過Spring提供的Resource進行一些操作：

ClassPathResource

FileSystemResource

ServletContextResource

Resource template = ctx.getResource("some/resource/path/myTemplate.txt");

這裡簡單總結下他們的區別：

---

ClassLoader##getResource()

這個方法是今天的主角。

我們都知道ClassLoader的作用是用來載入.class檔案的，並且ClassLoader是遵循Java類載入中的雙親委派機制的。

那麼，ClassLoader是如何找到這個.class檔案的呢？答案是URLClassPath

Java中自帶了3個ClassLoader分別是BootStrap ClassLoader，EtxClassLoader,AppClassLoader,

這3個ClassLoader都繼承自URLClassLoader,而URLClassLoader中包含一個URLClassPath用來記錄每個ClassLoader對應的載入.class檔案的路徑，當需要載入資源的時候，只管從URLClassPath

對應的路徑查詢即可。

下面是測試程式碼：

System.out.println("BootStrap ClassLoader ");
Stream.of(System.getProperty("sun.boot.class.path").split(";")).forEach(System.out::println);

System.out.println("ExtClassLoader:");  
Stream.of(System.getProperty("java.ext.dirs").split(";")).forEach(System.out::println)；

System.out.println("AppClassLoader:");  
Stream.of(System.getProperty("java.class.path").split(";")).forEach(System.out::println);
 

輸出如下：

BootStrap ClassLoader 

H:\java\jdk1.8\jre\lib\resources.jar
H:\java\jdk1.8\jre\lib\rt.jar
H:\java\jdk1.8\jre\lib\sunrsasign.jar
H:\java\jdk1.8\jre\lib\jsse.jar
H:\java\jdk1.8\jre\lib\jce.jar
H:\java\jdk1.8\jre\lib\charsets.jar
H:\java\jdk1.8\jre\lib\jfr.jar
H:\java\jdk1.8\jre\classes

ExtClassLoader:

H:\java\jdk1.8\jre\lib\ext
C:\Windows\Sun\Java\lib\ext

AppClassLoader:

H:\java\jdk1.8\jre\lib\charsets.jar
H:\java\jdk1.8\jre\lib\deploy.jar
H:\java\jdk1.8\jre\lib\ext\access-bridge-64.jar
H:\java\jdk1.8\jre\lib\ext\cldrdata.jar
H:\java\jdk1.8\jre\lib\ext\dnsns.jar
H:\java\jdk1.8\jre\lib\ext\jaccess.jar
H:\java\jdk1.8\jre\lib\ext\jfxrt.jar
H:\java\jdk1.8\jre\lib\ext\localedata.jar
H:\java\jdk1.8\jre\lib\ext\nashorn.jar
H:\java\jdk1.8\jre\lib\ext\sunec.jar
H:\java\jdk1.8\jre\lib\ext\sunjce_provider.jar
H:\java\jdk1.8\jre\lib\ext\sunmscapi.jar
H:\java\jdk1.8\jre\lib\ext\sunpkcs11.jar
H:\java\jdk1.8\jre\lib\ext\zipfs.jar
H:\java\jdk1.8\jre\lib\javaws.jar
H:\java\jdk1.8\jre\lib\jce.jar
H:\java\jdk1.8\jre\lib\jfr.jar
H:\java\jdk1.8\jre\lib\jfxswt.jar
H:\java\jdk1.8\jre\lib\jsse.jar
H:\java\jdk1.8\jre\lib\management-agent.jar
H:\java\jdk1.8\jre\lib\plugin.jar
H:\java\jdk1.8\jre\lib\resources.jar
H:\java\jdk1.8\jre\lib\rt.jar
F:\spring-test\target\classes

AppClassLoader負責常用的JDK jar以及專案所依賴的jar包

上述引數可以通過 sun.misc.Launcher.class獲得

通過輸出的引數，我們可以清晰的看出來各個ClassLoader負責的區域

說了這麼多，這個和ClassLoader#getResource()有什麼關係呢？

關係很大，前面剛剛提問過，ClassLoader是如何讀取.class檔案的呢？

答案是URLClassPath#getResource()方法：每個UrlClassLoader都是通過URLClassPath來儲存對應的載入區域，當需要查詢.class檔案的時候，就通過URLClassPath#getResource()查詢即可。

---

下面再來看看ClassLoader#getResource()

//雙親委派查詢   
public URL getResource(String name) {
        URL url;
        if (parent != null) {
            url = parent.getResource(name);
        } else {
            url = getBootstrapResource(name);
        }
        if (url == null) {
            url = findResource(name);
        }
        return url;
}

//由於BootStrap ClassLoader是C++寫的，Java拿不到其引用。
//因此這裡單獨寫了一個方法獲取BootStrapResource()
private static URL getBootstrapResource(String name) {
    URLClassPath ucp = getBootstrapClassPath();
    Resource res = ucp.getResource(name);
    return res != null ? res.getURL() : null;
}

URLClassLoader#findResource()

 public URL findResource(final String name) {

        URL url = AccessController.doPrivileged(
            new PrivilegedAction<URL>() {
                public URL run() {
                    return ucp.findResource(name, true);
                }
            }, acc);

        return url != null ? ucp.checkURL(url) : null;
    }

我們只用注意這一句ucp.findResource(name, true);，這邊是查詢.class檔案的方法，因此我們可以總結出通過ClassLoader#getResource()的流程：

• 首先，AppClassLoader委派給ExtClassLoader查詢是否存在對應的資源
• ExtClassLoader委派給BootStrap ClassLoader查詢是有存在對應的資源
• BootStrap ClassLoader通過URLClasspath查詢自己載入的區域，查詢到了即返回
• BootStrap ClassLoader未查詢到對應資源，ExtClassLoader通過URLClasspath查詢自己載入的區域，查詢到了即返回
• ExtClassLoader未查詢到對應資源，AppClassLoader通過URLClasspath查詢自己載入的區域，查詢到了即返回
• AppClassLoader未查詢到，丟擲異常。

這個過程，就和雙親委派模型載入.class檔案的過程一樣。

在這裡我們就可以發現，通過ClassLoader#getResource()可以獲取JDK資源，所依賴的JAR包資源等

因此，我們甚至可以這樣寫：

//讀取`java.lang.String.class`的位元組碼
InputStream inputStream =Test.class.getClassLoader().getResourceAsStream("java/lang/String.class");
try(BufferedInputStream bufferedInputStream=new BufferedInputStream(inputStream)){
    byte[] bytes=new byte[1024];
    while (bufferedInputStream.read(bytes)>0){
        System.out.println(new String(bytes, StandardCharsets.UTF_8));
    }
}

---

明白了ClassLoader#getResource(),其實本篇文章就差不多了，因為後面要將的幾個方法，底層都是ClassLoader#getResource()

class##getResource()

class##getResource()底層就是ClassLoader#getResource()

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

不過有個小區別就在於class#getResource()多了一個resolveName()方法：

    private String resolveName(String name) {
        if (name == null) {
            return name;
        }
        if (!name.startsWith("/")) {
            Class<?> c = this;
            while (c.isArray()) {
                c = c.getComponentType();
            }
            String baseName = c.getName();
            int index = baseName.lastIndexOf('.');
            if (index != -1) {
                name = baseName.substring(0, index).replace('.', '/')
                    +"/"+name;
            }
        } else {
            name = name.substring(1);
        }
        return name;
    }

這個resolveName()大致就是判斷路徑是相對路徑還是絕對路徑，如果是相對路徑，則資源名會被加上當前專案的根路徑：

Test.class.getResource("spring-config.xml");

resolve之後變成

com/dengchengchao/test/spring-config.xml

這樣的資源就只能在當前專案中找到。

Test.class.getResource("test.txt");    //相對路徑

Test.class.getResource("/");           //根路徑

注意：ClassLoader#getResource()不能以/開頭

---

Spring # ClassPathResource()

在Spring中，對Resource進行了擴充套件，使得Resource能夠適應更多的應用場景，

不過ClssPathResource()底層依然是ClassLoader##getResource()，因此ClassLoader##getResource()d的特性，ClassPathResource也支援。

    protected URL resolveURL() {
        if (this.clazz != null) {
            return this.clazz.getResource(this.path);
        } else {
            return this.classLoader != null ? this.classLoader.getResource(this.path) : ClassLoader.getSystemResource(this.path);
        }
    }

ClassPathResource用於讀取classes目錄檔案

一般來說，對於SpringBoot專案，打包後的專案結構如下：

|-- xxx.jar

|--- BOOT-INF

|--------|--classes

|--------|----|--com

|--------|----|-- application.properties

|--------|----|--logback.xml

| -------|-- lib

|--- META-INF

|--- org

可以看到，ClassPathResource()的起始路徑便是classes，平時我們讀取的application.properties便是使用ClasspathResource()獲取的

在平時使用的過程中，有三點需要注意：

1. classpath 和 classpath* 區別：

   classpath：只會返回第一個查詢到的檔案
   classpath*：會返回所有查詢到的檔案

2. 在Spring中，需要直接表示使用ClassPathResource()來查詢的話，可以直接新增classpath:頭

3. 使用classpath以/和不以/開頭沒有區別

---

Spring # ServletContextResource

ServletContextResource是針對Servlet來做的，我們知道，Servlet規定webapp目錄如下：

而ServletContextResource的路徑則是xxx目錄下為起點。也就是可以通過ServletContextResource獲取到form.html等資源。

同時對比上面的ClassPathResource我們可以發現：

"classpath:com"   

等價於：

ServletContextResource("WEB-INF/classes/com")

---

Spring # FileSystemResource

FileSystemResource沒什麼好說的，就是系統目錄資源，比如

ApplicationContext ctx =
    new FileSystemXmlApplicationContext("D://test.xml");

它的標記頭為file:

例如：

ApplicationContext ctx =
    new FileSystemXmlApplicationContext("flie:D://test.xml");

---

如果覺得寫得不錯，歡迎關注微信公眾號：逸遊Java ,每天不定時釋出一些有關Java進階的文章，感謝關注

相關推薦