spring-framework的Resource知識(shí)點(diǎn)

Jonathan Shieber 發(fā)布于2019-08-15 12:26 / 1199人閱讀

摘要：接口類(lèi)三個(gè)具有代表性的實(shí)現(xiàn)類(lèi)通過(guò)的和，我們找到利用去解析路徑配置文件的路徑。上面可能講的有點(diǎn)繞，但卻是入口之一。根據(jù)路徑的特性，分別封裝為或?qū)ο蟆Ａ硗庥冒锏淖隽藢?shí)驗(yàn)，發(fā)現(xiàn)可以讀到包里的信息。則是包的根地方，如，用于公共配置文件。

接口類(lèi):org.springframework.core.io.Resource
三個(gè)具有代表性的實(shí)現(xiàn)類(lèi)：

org.springframework.web.context.support.ServletContextResource

org.springframework.core.io.ClassPathResource

org.springframework.core.io.UrlResource

通過(guò)XmlWebApplicationContext的loadBeanDefinitions(DefaultListableBeanFactory beanFactory)和loadBeanDefinitions(XmlBeanDefinitionReader reader)，我們找到ApplicationContext利用ServletContextResourcePatternResolver去解析路徑（配置文件的路徑）。
上面可能講的有點(diǎn)繞，但卻是入口之一。我們可以跳出這個(gè)細(xì)節(jié)來(lái)看，其實(shí)Resource是通過(guò)ResourceLoader去加載（名字也能看出啦），而ApplicationContex是ResourceLoader的一個(gè)實(shí)現(xiàn)。所以Application有g(shù)etResource()的方法，但具體實(shí)例化Resource，ApplicationContex不親自干，而是用組合的形式交給ResourcePatternResolver去處理，這是因?yàn)椴煌h(huán)境尋找配置文件的形式不一樣，而其中PathMatchingResourcePatternResolver和ServletContextResourcePatternResolver是ResourcePatternResolver的實(shí)現(xiàn)，用于不同環(huán)境中加載Resource。

ServletContextResourcePatternResolver會(huì)將路徑封裝成Resource對(duì)象。根據(jù)路徑的特性，分別封裝為ServletContextResource、ClassPathResource或UrlResource對(duì)象。

這里個(gè)路徑清理的工具類(lèi)StringUtils.cleanPath，參考《StringUtils知識(shí)點(diǎn)》

我們先看一些默認(rèn)路徑的知識(shí)：

package org.springframework.jc;

import org.apache.commons.logging.Log;

import java.io.File;
import java.io.IOException;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;

public class ClassGetResourceTest {

    public static void main(String[] args) throws IOException {
        System.out.println("============================================env===================================");
        Map map = System.getenv();
        for (Iterator itr = map.keySet().iterator(); itr.hasNext(); ) {
            String key = itr.next();
            System.out.println(key + "=" + map.get(key));
        }
        System.out.println("============================================properties===================================");
        Properties properties = System.getProperties();
        for(String key:properties.stringPropertyNames()){
            System.out.println(key + "=" + properties.get(key));  // user.dir=/home/cherry/git/spring-framework
        }
        System.out.println(ClassGetResourceTest.class.getResource(""));  //file:/home/cherry/git/spring-framework/spring-core/out/test/classes/org/springframework/jc/
        System.out.println(ClassGetResourceTest.class.getResource("/")); //file:/home/cherry/git/spring-framework/spring-core/out/test/classes/

        //喲喲，不同包下的類(lèi)，Log.class.getResource("")是不一樣的！！！ 可以獲取jar包里的配置文件哦，如commons-logging-1.2.jar包
        System.out.println(Log.class.getResource(""));  //jar:file:/home/cherry/.gradle/caches/modules-2/files-2.1/commons-logging/commons-logging/1.2/4bfc12adfe4842bf07b657f0369c4cb522955686/commons-logging-1.2.jar!/org/apache/commons/logging/
        System.out.println(Log.class.getResource("/")); //file:/home/cherry/git/spring-framework/spring-core/out/test/classes/


        File file = new File("test.txt");
        file.createNewFile();
        System.out.println(file.getAbsolutePath());  //使用user.dir作為根目錄

        System.out.println(ClassGetResourceTest.class.getName() + ".ROOT");

        System.out.println(ClassGetResourceTest.class.getClassLoader());                        //sun.misc.Launcher$AppClassLoader@18b4aac2
        System.out.println(ClassGetResourceTest.class.getClassLoader().getResource(""));  //file:/home/cherry/git/spring-framework/spring-core/out/test/classes/
                                                                                                //作用和ClassGetResourceTest.class.getResource("/")一樣

        System.out.println(ClassGetResourceTest.class.getClassLoader().getResource("/")); //null
                                                                                                //ClassLoader.getResource不可以使用"/"

        //不同包下的類(lèi)，結(jié)果也與ClassGetResourceTest.class.getClassLoader()一樣，于是不可以獲取jar包里的配置文件哦，如commons-logging-1.2.jar包
        System.out.println(Log.class.getClassLoader());                        //sun.misc.Launcher$AppClassLoader@18b4aac2
        System.out.println(Log.class.getClassLoader().getResource(""));  //file:/home/cherry/git/spring-framework/spring-core/out/test/classes/
                                                                                                //作用和ClassGetResourceTest.class.getResource("/")一樣

        System.out.println(Log.class.getClassLoader().getResource("/")); //null
                                                                                                //ClassLoader.getResource不可以使用"/"


    }
}

從上可以得出一些結(jié)論：

user.dir是jvm的系統(tǒng)屬性，默認(rèn)是取你執(zhí)行命令時(shí)的目錄，也就是說(shuō)如果在/mydata使用命令 /mydata/jc-test/server.sh start，此時(shí)user.dir為/mydata，如果在/mydata/other目錄執(zhí)行/mydata/jc-test/server.sh start，則此時(shí)user.dir為/mydata/other

class.getResource方法，根據(jù)是否以根目錄“/”開(kāi)始來(lái)決定文件目錄：

class.getResource("")相對(duì)于當(dāng)前類(lèi)的目錄，是個(gè)相對(duì)路徑。例如一些不是公共的配置文件，僅僅這個(gè)類(lèi)或這個(gè)包下使用的配置文件。   另外用jar包里的class做了實(shí)驗(yàn)，發(fā)現(xiàn)可以讀到j(luò)ar包里的信息。   
class.getResource("/")則是包的根地方，如..../classes/，用于公共配置文件。

ClassLoader.getResource方法，不可以根目錄“/”開(kāi)始來(lái)決定文件目錄，否則為null：

ClassLoader.getResource("")則是包的根地方，如..../classes/  
ClassLoader.getResource("")為null

好了，我們現(xiàn)在回歸主題，org.springframework.core.io.ClassPathResource能夠根據(jù)類(lèi)或加載器（classload）來(lái)加載類(lèi)路徑的文件，原文：

Resource implementation for class path resources. Uses either a given ClassLoader or a given Class for loading resources.

核心邏輯：

/**
     * This implementation opens an InputStream for the given class path resource.
     * @see java.lang.ClassLoader#getResourceAsStream(String)
     * @see java.lang.Class#getResourceAsStream(String)
     */
    @Override
    public InputStream getInputStream() throws IOException {
        InputStream is;
        if (this.clazz != null) {
            is = this.clazz.getResourceAsStream(this.path);
        }
        else if (this.classLoader != null) {
            is = this.classLoader.getResourceAsStream(this.path);
        }
        else {
            is = ClassLoader.getSystemResourceAsStream(this.path);
        }
        if (is == null) {
            throw new FileNotFoundException(getDescription() + " cannot be opened because it does not exist");
        }
        return is;
    }