spring resource以及ant路徑匹配規(guī)則 源碼學(xué)習(xí)

spring中resource是一個接口,為資源的抽象提供了一套操作方式颅悉,可匹配類似于classpath:XXX,file://XXX等不同協(xié)議的資源訪問隧土。

image.png

如上圖所示鹿榜,spring已經(jīng)提供了多種訪問資源的實體類,還有DefaultResourceLoader類土匀,使得與具體的context結(jié)合子房。在spring中根據(jù)設(shè)置的配置文件路徑轉(zhuǎn)換為對應(yīng)的文件資源


// AbstractBeanDefinitionReader 文件
Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);

// DefaultResourceLoader 文件
public Resource getResource(String location) {
    Assert.notNull(location, "Location must not be null");

    for (ProtocolResolver protocolResolver : this.protocolResolvers) {
        Resource resource = protocolResolver.resolve(location, this);
        if (resource != null) {
            return resource;
        }
    }

    if (location.startsWith("/")) {
       // ClassPathContextResource 
        return getResourceByPath(location);
    }
    else if (location.startsWith(CLASSPATH_URL_PREFIX)) {
        return new ClassPathResource(location.substring(CLASSPATH_URL_PREFIX.length()), getClassLoader());
        // 如果是以classpath:開頭,認(rèn)為是classpath樣式的資源,返回ClassPathResource
    }
    else {
        try {
            URL url = new URL(location);
            return new UrlResource(url);
            // 符合URL協(xié)議池颈,返回UrlResource
        }
        catch (MalformedURLException ex) {
            return getResourceByPath(location);
            // 剩下的無法判斷的全部返回ClassPathContextResource
        }
    }
}

// 然后在真正的使用resource的文件流時尾序,XmlBeanDefinitionReader文件內(nèi)
InputStream inputStream = encodedResource.getResource().getInputStream();
image.png

有多種具體的Resource類的獲取輸入流的實現(xiàn)方式。
FileSystemResource 類

    public InputStream getInputStream() throws IOException {
        return new FileInputStream(this.file);
        // this.file 是個File對象
    }

ClassPathContextResource和ClassPathResource的獲取IO流的方法是同一個

現(xiàn)在基本上清楚了spring針對不同協(xié)議的文件路徑是如何操作路徑躯砰,以什么樣子的方式獲取IO流每币,不過還是有幾個疑問需要深入了解下。

  • 如何匹配多個資源文件
  • FileSystemXmlApplicationContext和ClassPathXmlApplicationContext的區(qū)別

匹配多個資源文件

之前說的例子都是明確指定context.xml 的情況琢歇,可是現(xiàn)實中會配置多個配置文件兰怠,然后依次加載,例如*.xml會匹配當(dāng)前目錄下面所有的.xml文件李茫。來到了PathMatchingResourcePatternResolver.class匹配出多個xml的情況

至于為什么會定位到PathMatchingResourcePatternResolver.class這個文件揭保,可以看

AbstractApplicationContext 文件

public AbstractApplicationContext() {
    this.resourcePatternResolver = getResourcePatternResolver();
}

protected ResourcePatternResolver getResourcePatternResolver() {
    return new PathMatchingResourcePatternResolver(this);
}

// 也就意味著在context類初始化的時候,就直接設(shè)置了好了resourcePatternResolver對象為PathMatchingResourcePatternResolver

PathMatchingResourcePatternResolver 文件

public Resource[] getResources(String locationPattern) throws IOException {
    Assert.notNull(locationPattern, "Location pattern must not be null");
    if (locationPattern.startsWith(CLASSPATH_ALL_URL_PREFIX)) {
        // 通過classpath:開頭的地址
        if (getPathMatcher().isPattern(locationPattern.substring(CLASSPATH_ALL_URL_PREFIX.length()))) {
            // 地址路徑中包含了 【*】這個匹配的關(guān)鍵字魄宏,意味著要模糊匹配
            return findPathMatchingResources(locationPattern);
        }
        else {
            // 查找當(dāng)前所有的classpath資源并返回
            return findAllClassPathResources(locationPattern.substring(CLASSPATH_ALL_URL_PREFIX.length()));
        }
    }
    else {
        // and on Tomcat only after the "*/" separator for its "war:" protocol.
        int prefixEnd = (locationPattern.startsWith("war:") ? locationPattern.indexOf("*/") + 1 :
                locationPattern.indexOf(":") + 1);
        if (getPathMatcher().isPattern(locationPattern.substring(prefixEnd))) {
            // 除去前綴秸侣,包含【*】,進(jìn)行模糊匹配
            return findPathMatchingResources(locationPattern);
        }
        else {
            // 這個是針對具體的xml文件的匹配規(guī)則,會進(jìn)入到DefaultResourceLoader裝載資源文件
            return new Resource[] {getResourceLoader().getResource(locationPattern)};
        }
    }
}


// 根據(jù)模糊地址找出所有匹配的資源文件
protected Resource[] findPathMatchingResources(String locationPattern) throws IOException {
    String rootDirPath = determineRootDir(locationPattern);
    // 根路徑宠互,此處為xml/
    String subPattern = locationPattern.substring(rootDirPath.length());
    // 子路徑味榛,此處為*.xml
    Resource[] rootDirResources = getResources(rootDirPath);
    // 調(diào)用本身,算出根路徑的資源信息
    // 如果為xml/*.xml 則返回一個根路徑資源信息xml/
    // 如果為xml/**/*.xml 則還是返回一組根路徑資源信息xml/
    Set<Resource> result = new LinkedHashSet<Resource>(16);
    for (Resource rootDirResource : rootDirResources) {
        rootDirResource = resolveRootDirResource(rootDirResource);
        URL rootDirURL = rootDirResource.getURL();
        // 獲取其URL信息
        if (equinoxResolveMethod != null) {
            if (rootDirURL.getProtocol().startsWith("bundle")) {
                rootDirURL = (URL) ReflectionUtils.invokeMethod(equinoxResolveMethod, null, rootDirURL);
                rootDirResource = new UrlResource(rootDirURL);
            }
        }
        if (rootDirURL.getProtocol().startsWith(ResourceUtils.URL_PROTOCOL_VFS)) {
        // jboss的文件協(xié)議
            result.addAll(VfsResourceMatchingDelegate.findMatchingResources(rootDirURL, subPattern, getPathMatcher()));
        }
        else if (ResourceUtils.isJarURL(rootDirURL) || 
        isJarResource(rootDirResource)) {
           // jar包
            result.addAll(doFindPathMatchingJarResources(rootDirResource, rootDirURL, subPattern));
        }
        else {
           // 默認(rèn)掃描當(dāng)前的所有資源予跌,添加到result中
            result.addAll(doFindPathMatchingFileResources(rootDirResource, subPattern));
        }
    }
    if (logger.isDebugEnabled()) {
        logger.debug("Resolved location pattern [" + locationPattern + "] to resources " + result);
    }
    return result.toArray(new Resource[result.size()]);
}

// 通過路徑去匹配到合適的資源搏色,此處的rootDir包含了絕對路徑
protected Set<File> retrieveMatchingFiles(File rootDir, String pattern) 
      throws IOException {
    if (!rootDir.exists()) {
       // 根路徑都不存在,則返回空
        if (logger.isDebugEnabled()) {
            logger.debug("Skipping [" + rootDir.getAbsolutePath() + "] because it does not exist");
        }
        return Collections.emptySet();
    }
    if (!rootDir.isDirectory()) {
        // 不是文件夾券册,返回空
        if (logger.isWarnEnabled()) {
            logger.warn("Skipping [" + rootDir.getAbsolutePath() + "] because it does not denote a directory");
        }
        return Collections.emptySet();
    }
    if (!rootDir.canRead()) {
       // 文件不可讀频轿,也返回空
        if (logger.isWarnEnabled()) {
            logger.warn("Cannot search for matching files underneath directory [" + rootDir.getAbsolutePath() +
                    "] because the application is not allowed to read the directory");
        }
        return Collections.emptySet();
    }
    String fullPattern = StringUtils.replace(rootDir.getAbsolutePath(), File.separator, "/");
    // 得到當(dāng)前系統(tǒng)下的文件絕對地址
    if (!pattern.startsWith("/")) {
        fullPattern += "/";
    }
    fullPattern = fullPattern + StringUtils.replace(pattern, File.separator, "/");
    // 得到完整的全路徑 例如/user/...*.xml
    Set<File> result = new LinkedHashSet<File>(8);
    doRetrieveMatchingFiles(fullPattern, rootDir, result);
    // 得到當(dāng)前rootDir下面的所有文件,然后配合fullPattern進(jìn)行匹配烁焙,得到的結(jié)果在result中
    return result;
}

protected void doRetrieveMatchingFiles(String fullPattern, File dir, Set<File> result) throws IOException {
    if (logger.isDebugEnabled()) {
        logger.debug("Searching directory [" + dir.getAbsolutePath() +
                "] for files matching pattern [" + fullPattern + "]");
    }
    File[] dirContents = dir.listFiles();
    // 得到當(dāng)前根路徑的所有文件(包含了文件夾)
    if (dirContents == null) {
        if (logger.isWarnEnabled()) {
            logger.warn("Could not retrieve contents of directory [" + dir.getAbsolutePath() + "]");
        }
        return;
    }
    Arrays.sort(dirContents);
    // 這個也需要注意到航邢,這個順序決定了掃描文件的先后順序,也意味著bean加載的情況
    for (File content : dirContents) {
        String currPath = StringUtils.replace(content.getAbsolutePath(), File.separator, "/");
        if (content.isDirectory() && getPathMatcher().matchStart(fullPattern, currPath + "/")) {
          // 如果是文件夾骄蝇,類似于xml/**/*.xml 文件
          // 訪問到了** 就會是文件夾
            if (!content.canRead()) {
                ...
            }
            else {
               // 循環(huán)迭代訪問文件
                doRetrieveMatchingFiles(fullPattern, content, result);
            }
        }
        if (getPathMatcher().match(fullPattern, currPath)) {
            result.add(content);
            // 匹配完成翠忠,添加到結(jié)果集合中
        }
    }
}

這樣整個的xml文件讀取過程就全部完成,也清楚了實際中xml文件是什么樣的形式被訪問到的乞榨。
其實spring的路徑風(fēng)格是和Apache Ant的路徑樣式一樣的秽之,Ant的更多細(xì)節(jié)可以自行學(xué)習(xí)了解。

FileSystemXmlApplicationContext和ClassPathXmlApplicationContext的區(qū)別

這個看名字就很明顯吃既,就是加載文件不太一樣考榨,一個通過純粹的文件協(xié)議去訪問,另一個卻可以兼容多種協(xié)議鹦倚。仔細(xì)分析他們的差異河质,會發(fā)現(xiàn)主要的差異就在于FileSystemXmlApplicationContext重寫的getResourceByPath方法

FileSystemXmlApplicationContext 文件

protected Resource getResourceByPath(String path) {
    if (path != null && path.startsWith("/")) {
        path = path.substring(1);
    }
    return new FileSystemResource(path);
}

上面代碼學(xué)習(xí),已經(jīng)清楚了在默認(rèn)的中是生成ClassPathContextResource資源,但是重寫之后意味著被強制性的設(shè)置為了FileSystemResource掀鹅,就會出現(xiàn)文件不存在的情況散休。

如下圖,設(shè)置的path只有context.xml乐尊,就會被提示找不到文件戚丸,因為此時的文件路徑是項目路徑 + context.xml

image.png

如果改為使用simple-spring-demo/src/main/resources/context.xml,此時需要注意修改xml內(nèi)的properties文件路徑扔嵌,否則也會提示文件找不到

image.png

image.png

這樣就符合設(shè)置了限府,運行正常,這也告訴我們一旦使用FileSystemXmlApplicationContext記得修改所有的路徑配置痢缎,以防止出現(xiàn)文件找不到的錯誤胁勺。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市独旷,隨后出現(xiàn)的幾起案子署穗,更是在濱河造成了極大的恐慌,老刑警劉巖嵌洼,帶你破解...
    沈念sama閱讀 222,807評論 6 518
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件案疲,死亡現(xiàn)場離奇詭異,居然都是意外死亡咱台,警方通過查閱死者的電腦和手機络拌,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,284評論 3 399
  • 文/潘曉璐 我一進(jìn)店門俭驮,熙熙樓的掌柜王于貴愁眉苦臉地迎上來回溺,“玉大人,你說我怎么就攤上這事混萝∫抛瘢” “怎么了?”我有些...
    開封第一講書人閱讀 169,589評論 0 363
  • 文/不壞的土叔 我叫張陵逸嘀,是天一觀的道長车要。 經(jīng)常有香客問我,道長崭倘,這世上最難降的妖魔是什么翼岁? 我笑而不...
    開封第一講書人閱讀 60,188評論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮司光,結(jié)果婚禮上琅坡,老公的妹妹穿的比我還像新娘。我一直安慰自己残家,他們只是感情好榆俺,可當(dāng)我...
    茶點故事閱讀 69,185評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般茴晋。 火紅的嫁衣襯著肌膚如雪陪捷。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,785評論 1 314
  • 那天诺擅,我揣著相機與錄音市袖,去河邊找鬼。 笑死掀虎,一個胖子當(dāng)著我的面吹牛凌盯,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播烹玉,決...
    沈念sama閱讀 41,220評論 3 423
  • 文/蒼蘭香墨 我猛地睜開眼驰怎,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了二打?” 一聲冷哼從身側(cè)響起县忌,我...
    開封第一講書人閱讀 40,167評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎继效,沒想到半個月后症杏,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,698評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡瑞信,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,767評論 3 343
  • 正文 我和宋清朗相戀三年厉颤,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片凡简。...
    茶點故事閱讀 40,912評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡逼友,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出秤涩,到底是詐尸還是另有隱情帜乞,我是刑警寧澤,帶...
    沈念sama閱讀 36,572評論 5 351
  • 正文 年R本政府宣布筐眷,位于F島的核電站黎烈,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏匀谣。R本人自食惡果不足惜照棋,卻給世界環(huán)境...
    茶點故事閱讀 42,254評論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望武翎。 院中可真熱鬧烈炭,春花似錦、人聲如沸后频。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,746評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至膏执,卻和暖如春驻售,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背更米。 一陣腳步聲響...
    開封第一講書人閱讀 33,859評論 1 274
  • 我被黑心中介騙來泰國打工欺栗, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人征峦。 一個月前我還...
    沈念sama閱讀 49,359評論 3 379
  • 正文 我出身青樓迟几,卻偏偏與公主長得像,于是被迫代替她去往敵國和親栏笆。 傳聞我的和親對象是個殘疾皇子类腮,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,922評論 2 361

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)蛉加,斷路器蚜枢,智...
    卡卡羅2017閱讀 134,717評論 18 139
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,867評論 6 342
  • 尋春?得到鄉(xiāng)下——城里沒有分明的四季针饥,就如沒有真正的夜晚厂抽。 跟我回鄉(xiāng)吧。 春早來了呢丁眼,在鄉(xiāng)下筷凤。 春天在小河邊。 小...
    木棉之秋閱讀 932評論 79 48
  • 明天公司又要開盤了苞七,最近的售樓部真的是門庭若市藐守,和我們本身的高端調(diào)性還有點不搭。誰叫今年市場好呢莽鸭?誰叫國人買漲不買...
    杜美慧閱讀 407評論 0 0
  • “死亡”是令我們恐懼的一個詞吗伤,很多時候吃靠,我們都會避諱提及這兩個字硫眨。 事實上,伴隨死亡而來的一切比死亡本身更可怕巢块。 ...
    WendyKoo閱讀 370評論 3 3