【第四章】 資源 之 4.4 Resource萬用字元路徑 ——跟我學spring3
4.4.1 使用路徑萬用字元載入Resource
前面介紹的資源路徑都是非常簡單的一個路徑匹配一個資源,Spring還提供了一種更強大的Ant模式萬用字元匹配,從能一個路徑匹配一批資源。
Ant路徑萬用字元支援“?”、“*”、“**”,注意萬用字元匹配不包括目錄分隔符“/”:
“?”:匹配一個字元,如“config?.xml”將匹配“config1.xml”;
“*”:匹配零個或多個字串,如“cn/*/config.xml”將匹配“cn/javass/config.xml”,但不匹配匹配“cn/config.xml”;而“cn/config-*.xml”將匹配“cn/config-dao.xml”;
“**”:匹配路徑中的零個或多個目錄,如“cn/**/config.xml”將匹配“cn /config.xml”,也匹配“cn/javass/spring/config.xml”;而“cn/javass/config-**.xml”將匹配“cn/javass/config-dao.xml”,即把“**”當做兩個“*”處理。
Spring提供AntPathMatcher來進行Ant風格的路徑匹配。具體測試請參考cn.javass.spring.chapter4. AntPathMatcherTest。
Spring在載入類路徑資源時除了提供字首“classpath:”的來支援載入一個Resource,還提供一個字首“classpath*:”來支援載入所有匹配的類路徑Resource。
Spring提供ResourcePatternResolver介面來載入多個Resource,該介面繼承了ResourceLoader並添加了“Resource[] getResources(String locationPattern)”用來載入多個Resource:
java程式碼:- publicinterface ResourcePatternResolver extends ResourceLoader {
- String CLASSPATH_ALL_URL_PREFIX = "classpath*:";
- Resource[] getResources(String locationPattern) throws
- }
Spring提供了一個ResourcePatternResolver實現PathMatchingResourcePatternResolver,它是基於模式匹配的,預設使用AntPathMatcher進行路徑匹配,它除了支援ResourceLoader支援的字首外,還額外支援“classpath*:”用於載入所有匹配的類路徑Resource,ResourceLoader不支援字首“classpath*:”:
首先做下準備工作,在專案的“resources”建立“META-INF”目錄,然後在其下建立一個“INDEX.LIST”檔案。同時在“org.springframework.beans-3.0.5.RELEASE.jar”和“org.springframework.context-3.0.5.RELEASE.jar”兩個jar包裡也存在相同目錄和檔案。然後建立一個“LICENSE”檔案,該檔案存在於“com.springsource.cn.sf.cglib-2.2.0.jar”裡。
一、“classpath”: 用於載入類路徑(包括jar包)中的一個且僅一個資源;對於多個匹配的也只返回一個,所以如果需要多個匹配的請考慮“classpath*:”字首;
java程式碼:- @Test
- publicvoid testClasspathPrefix() throws IOException {
- ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
- //只加載一個絕對匹配Resource,且通過ResourceLoader.getResource進行載入
- Resource[] resources=resolver.getResources("classpath:META-INF/INDEX.LIST");
- Assert.assertEquals(1, resources.length);
- //只加載一個匹配的Resource,且通過ResourceLoader.getResource進行載入
- resources = resolver.getResources("classpath:META-INF/*.LIST");
- Assert.assertTrue(resources.length == 1);
- }
二、“classpath*”: 用於載入類路徑(包括jar包)中的所有匹配的資源。帶萬用字元的classpath使用“ClassLoader”的“Enumeration<URL> getResources(String name)”方法來查詢萬用字元之前的資源,然後通過模式匹配來獲取匹配的資源。如“classpath:META-INF/*.LIST”將首先載入萬用字元之前的目錄“META-INF”,然後再遍歷路徑進行子路徑匹配從而獲取匹配的資源。
java程式碼:- @Test
- publicvoid testClasspathAsteriskPrefix () throws IOException {
- ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
- //將載入多個絕對匹配的所有Resource
- //將首先通過ClassLoader.getResources("META-INF")載入非模式路徑部分
- //然後進行遍歷模式匹配
- Resource[] resources=resolver.getResources("classpath*:META-INF/INDEX.LIST");
- Assert.assertTrue(resources.length > 1);
- //將載入多個模式匹配的Resource
- resources = resolver.getResources("classpath*:META-INF/*.LIST");
- Assert.assertTrue(resources.length > 1);
- }
注意“resources.length >1”說明返回多個Resource。不管模式匹配還是非模式匹配只要匹配的都將返回。
在“com.springsource.cn.sf.cglib-2.2.0.jar”裡包含“asm-license.txt”檔案,對於使用“classpath*: asm-*.txt”進行萬用字元方式載入資源將什麼也載入不了“asm-license.txt”檔案,注意一定是模式路徑匹配才會遇到這種問題。這是由於“ClassLoader”的“getResources(String name)”方法的限制,對於name為“”的情況將只返回檔案系統的類路徑,不會包換jar包根路徑。
java程式碼:- @Test
- publicvoid testClasspathAsteriskPrefixLimit() throws IOException {
- ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver(); //將首先通過ClassLoader.getResources("")載入目錄,
- //將只返回檔案系統的類路徑不返回jar的跟路徑
- //然後進行遍歷模式匹配
- Resource[] resources = resolver.getResources("classpath*:asm-*.txt");
- Assert.assertTrue(resources.length == 0);
- //將通過ClassLoader.getResources("asm-license.txt")載入
- //asm-license.txt存在於com.springsource.net.sf.cglib-2.2.0.jar
- resources = resolver.getResources("classpath*:asm-license.txt");
- Assert.assertTrue(resources.length > 0);
- //將只加載檔案系統類路徑匹配的Resource
- resources = resolver.getResources("classpath*:LICENS*");
- Assert.assertTrue(resources.length == 1);
- }
對於“resolver.getResources("classpath*:asm-*.txt");”,由於在專案“resources”目錄下沒有所以應該返回0個資源;“resolver.getResources("classpath*:asm-license.txt");”將返回jar包裡的Resource;“resolver.getResources("classpath*:LICENS*");”,因為將只返回檔案系統類路徑資源,所以返回1個資源。
因此在通過字首“classpath*”載入萬用字元路徑時,必須包含一個根目錄才能保證載入的資源是所有的,而不是部分。
三、“file”:載入一個或多個檔案系統中的Resource。如“file:D:/*.txt”將返回D盤下的所有txt檔案;
四、無字首:通過ResourceLoader實現載入一個資源。
AppliacationContext提供的getResources方法將獲取資源委託給ResourcePatternResolver實現,預設使用PathMatchingResourcePatternResolver。所有在此就無需介紹其使用方法了。
4.4.2 注入Resource陣列
Spring還支援注入Resource陣列,直接看配置如下:
java程式碼:- <bean id="resourceBean1"class="cn.javass.spring.chapter4.bean.ResourceBean4">
- <property name="resources">
- <array>
- <value>cn/javass/spring/chapter4/test1.properties</value>
- <value>log4j.xml</value>
- </array>
- </property>
- </bean>
- <bean id="resourceBean2"class="cn.javass.spring.chapter4.bean.ResourceBean4">
- <property name="resources" value="classpath*:META-INF/INDEX.LIST"/>
- </bean>
- <bean id="resourceBean3"class="cn.javass.spring.chapter4.bean.ResourceBean4">
- <property name="resources">
- <array>
- <value>cn/javass/spring/chapter4/test1.properties</value>
- <value>classpath*:META-INF/INDEX.LIST</value>
- </array>
- </property>
- </bean>
“resourceBean1”就不用多介紹了,傳統實現方式;對於“resourceBean2”則使用字首“classpath*”,看到這大家應該懂的,載入匹配多個資源;“resourceBean3”是混合使用的;測試程式碼在“cn.javass.spring.chapter4.ResourceInjectTest.testResourceArrayInject”。
Spring通過ResourceArrayPropertyEditor來進行型別轉換的,而它又預設使用“PathMatchingResourcePatternResolver”來進行把路徑解析為Resource物件。所有大家只要會使用“PathMatchingResourcePatternResolver”,其它一些實現都是委託給它的,比如AppliacationContext的“getResources”方法等。
4.4.3 AppliacationContext實現對各種Resource的支援
一、ClassPathXmlApplicationContext:預設將通過classpath進行載入返回ClassPathResource,提供兩類構造器方法:
java程式碼:- publicclass ClassPathXmlApplicationContext {
- //1)通過ResourcePatternResolver實現根據configLocation獲取資源
- public ClassPathXmlApplicationContext(String configLocation);
- public ClassPathXmlApplicationContext(String... configLocations);
- public ClassPathXmlApplicationContext(String[] configLocations, ……);
- //2)通過直接根據path直接返回ClasspathResource
- public ClassPathXmlApplicationContext(String path, Class clazz);
- public ClassPathXmlApplicationContext(String[] paths, Class clazz);
- public ClassPathXmlApplicationContext(String[] paths, Class clazz, ……);
- }
第一類構造器是根據提供的配置檔案路徑使用“ResourcePatternResolver ”的“getResources()”介面通過匹配獲取資源;即如“classpath:config.xml”
第二類構造器則是根據提供的路徑和clazz來構造ClassResource資源。即採用“public ClassPathResource(String path, Class<?> clazz)”構造器獲取資源。
二、FileSystemXmlApplicationContext:將載入相對於當前工作目錄的“configLocation”位置的資源,注意在linux系統上不管“configLocation”是否帶“/”,都作為相對路徑;而在window系統上如“D:/resourceInject.xml”是絕對路徑。因此在除非很必要的情況下,不建議使用該ApplicationContext。
java程式碼:- publicclass FileSystemXmlApplicationContext{
- public FileSystemXmlApplicationContext(String configLocation);
- public FileSystemXmlApplicationContext(String... configLocations,……);
- }
- //linux系統,以下全是相對於當前vm路徑進行載入
- new FileSystemXmlApplicationContext("chapter4/config.xml");
- new FileSystemXmlApplicationContext("/chapter4/confg.xml");
- //windows系統,第一個將相對於當前vm路徑進行載入;
- //第二個則是絕對路徑方式載入
- new FileSystemXmlApplicationContext("chapter4/config.xml");
- new FileSystemXmlApplicationContext("d:/chapter4/confg.xml");
此處還需要注意:在linux系統上,構造器使用的是相對路徑,而ctx.getResource()方法如果以“/”開頭則表示獲取絕對路徑資源,而不帶前導“/”將返回相對路徑資源。如下:
java程式碼:- //linux系統,第一個將相對於當前vm路徑進行載入;
- //第二個則是絕對路徑方式載入
- ctx.getResource ("chapter4/config.xml");
- ctx.getResource ("/root/confg.xml");
- //windows系統,第一個將相對於當前vm路徑進行載入;
- //第二個則是絕對路徑方式載入
- ctx.getResource ("chapter4/config.xml");
- ctx.getResource ("d:/chapter4/confg.xml");
因此如果需要載入絕對路徑資源最好選擇字首“file”方式,將全部根據絕對路徑載入。如在linux系統“ctx.getResource ("file:/root/confg.xml");”