在應(yīng)用Spring的工程中,使用class path的方式加載配置文件應(yīng)該是最常用的做法,然而對(duì)大部分人來(lái)說(shuō),剛開始使用Spring時(shí),幾乎都碰到過(guò)加載配置文件失敗的情況,除了配置上的錯(cuò)誤外,很多時(shí)候是因?yàn)榕渲梦募穆窂胶统绦蛑兄付ǖ募虞d路徑不一致,從而導(dǎo)致配置文件找不到,或是加載了錯(cuò)誤地方的配置文件。本文將就Spring如何從class path中加載配置文件做一些簡(jiǎn)要的分析。
情形一:使用classpath加載且不含通配符 這是最簡(jiǎn)單的情形,Spring默認(rèn)會(huì)使用當(dāng)前線程的ClassLoader的
1.當(dāng)工程目錄結(jié)構(gòu)如圖所示: ![]() 即配置文件放在bin目錄中的conf文件夾里,這時(shí)使用 ApplicationContext context = new ClassPathXmlApplicationContext("conf/application-context.xml");來(lái)創(chuàng)建ApplicationContext對(duì)象的話,Spring將加載bin/conf目錄下的application-context.xml文件。Spring啟動(dòng)時(shí)的輸出顯示為: Loading XML bean definitions from class path resource [conf/application-context.xml]
2.當(dāng)工程目錄結(jié)構(gòu)如圖所示: ![]() 即bin目錄下只有.class文件,沒(méi)有配置文件,同時(shí)在工程屬性的Java Build Path->Libraries里導(dǎo)入conf.jar文件,jar文件結(jié)構(gòu)如圖所示: ![]() 這時(shí)使用 ApplicationContext context = new ClassPathXmlApplicationContext("conf/application-context.xml");來(lái)創(chuàng)建ApplicationContext對(duì)象的話,Spring將加載conf.jar文件中conf目錄下的application-context.xml文件。Spring啟動(dòng)時(shí)的輸出顯示為: Loading XML bean definitions from class path resource [conf/application-context.xml]
3. 當(dāng)工程目錄結(jié)構(gòu)如圖所示: ![]() 即配置文件放在bin目錄中的conf文件夾里,同時(shí)在工程屬性的Java Build Path->Libraries里導(dǎo)入conf.jar文件,jar文件結(jié)構(gòu)如圖所示: ![]() 這時(shí)使用 ApplicationContext context = new ClassPathXmlApplicationContext("conf/application-context.xml");來(lái)創(chuàng)建ApplicationContext對(duì)象的話,由于沒(méi)有使用classpath*前綴,Spring只會(huì)加載一個(gè)application-context.xml文件。在eclipse中將會(huì)加載bin/conf目錄下的application-context.xml文件,而jar包中的conf/application-context.xml并不會(huì)被加載,Spring啟動(dòng)時(shí)的輸出顯示為: Loading XML bean definitions from class path resource [conf/application-context.xml] 情形二:使用classpath加載,包含通配符 碰到通配符的情況時(shí),Spring會(huì)通過(guò)使用路徑中的非通配符部分先確定資源的大致位置,然后根據(jù)這個(gè)位置在確定具體的資源位置,結(jié)合下面給出的幾種情況可以更好地理解Spring的這種工作方式
1. 當(dāng)工程目錄結(jié)構(gòu)如圖所示: ![]() 即配置文件放在bin目錄中的conf文件夾里,這時(shí)使用 ApplicationContext context = new ClassPathXmlApplicationContext("conf/**/*application-context.xml"); 來(lái)創(chuàng)建ApplicationContext對(duì)象的話,Spring首先會(huì)通過(guò)路徑中的非通配符部分即conf,先確定conf的路徑,即bin/conf目錄,然后從該目錄下加載配置文件,由于使用了/**/的方式,表明要加載conf目錄下包括各級(jí)子目錄中的所有配置文件,因此bin/conf/application-context.xml文件和 bin/conf/admin/admin-application-context.xml都會(huì)被加載,Spring啟動(dòng)時(shí)的輸出顯示為: Loading XML bean definitions from file [D:\myworkspace\spring-study\bin\conf\admin\admin-application-context.xml] Loading XML bean definitions from file [D:\myworkspace\spring-study\bin\conf\application-context.xml]
2.當(dāng)工程目錄結(jié)構(gòu)如圖所示: ![]() 即bin目錄下只有.class文件,沒(méi)有配置文件,同時(shí)在工程屬性的Java Build Path->Libraries里導(dǎo)入conf.jar文件,jar文件結(jié)構(gòu)如圖所示: ![]() 這時(shí)使用 ApplicationContext context = new ClassPathXmlApplicationContext("conf/**/*application-context.xml");來(lái)創(chuàng)建ApplicationContext對(duì)象的話,Spring首先會(huì)通過(guò)路徑中的非通配符部分即conf,先確定conf的路徑,即conf.jar中的conf目錄,然后從該目錄下加載配置文件,由于使用了/**/的方式,表明要加載conf目錄下包括各級(jí)子目錄中的所有配置文件,因此conf/application-context.xml文件和 conf/admin/admin-application-context.xml都會(huì)被加載,Spring啟動(dòng)時(shí)的輸出顯示為: Loading XML bean definitions from class path resource [conf/admin/admin-application-context.xml] Loading XML bean definitions from class path resource [conf/application-context.xml]
3.當(dāng)工程目錄結(jié)構(gòu)如圖所示: ![]() 即配置文件放在bin目錄中的conf文件夾里,同時(shí)在工程屬性的Java Build Path->Libraries里導(dǎo)入conf.jar文件,jar文件結(jié)構(gòu)如圖所示: ![]() 這時(shí)使用 ApplicationContext context = new ClassPathXmlApplicationContext("conf/**/*application-context.xml");來(lái)創(chuàng)建ApplicationContext對(duì)象的話,Spring首先會(huì)通過(guò)路徑中的非通配符部分即conf,先確定conf的路徑,在eclipse中是bin/conf目錄,然后從該目錄下加載配置文件,由于使用了/**/的方式,表明要加載conf目錄下包括各級(jí)子目錄中的所有配置文件,因此bin/conf/application-context.xml文件和 bin/conf/admin/admin-application-context.xml都會(huì)被加載,但conf.jar文件中的配置文件并不會(huì)被加載,Spring啟動(dòng)時(shí)的輸出顯示為: Loading XML bean definitions from file [D:\myworkspace\spring-study\bin\conf\admin\admin-application-context.xml] Loading XML bean definitions from file [D:\myworkspace\spring-study\bin\conf\application-context.xml] 情形三:使用classpath*前綴且不包含通配符 使用classpath*前綴可以獲取所有與給定路徑匹配的classpath資源,從而避免出現(xiàn)兩個(gè)不同位置有相同名字的文件,Spring只加載其中一個(gè)的情況。 當(dāng)工程目錄結(jié)構(gòu)如圖所示: ![]() 即配置文件放在bin目錄中的conf文件夾里,同時(shí)在工程屬性的Java Build Path->Libraries里導(dǎo)入conf.jar文件,jar文件結(jié)構(gòu)如圖所示: ![]() 這時(shí)使用 ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:conf/application-context.xml");來(lái)創(chuàng)建ApplicationContext對(duì)象的話, Spring將會(huì)加載bin目錄下的application-context.xml文件和jar包里的application-context.xml文件,Spring啟動(dòng)時(shí)的輸出顯示為: Loading XML bean definitions from URL [file:/D:/myworkspace/spring-study/bin/conf/application-context.xml] Loading XML bean definitions from URL [jar:file:/D:/myworkspace/conf1.jar!/conf/application-context.xml]
Spring中使用classpath加載配置文件淺析(續(xù)) 情形四:使用classpath*前綴,包含通配符 當(dāng)工程目錄結(jié)構(gòu)如圖所示: ![]() 即配置文件放在bin目錄中的conf文件夾里,同時(shí)在工程屬性的Java Build Path->Libraries里導(dǎo)入conf.jar文件,jar文件結(jié)構(gòu)如圖所示: ![]() 這時(shí)使用 ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:conf/**/*application-context.xml");來(lái)創(chuàng)建ApplicationContext對(duì)象的話,Spring首先會(huì)通過(guò)路徑中的非通配符部分即conf,先確定conf的路徑,由于使用了classpaht*前綴,因此bin目錄下的conf和jar包里的conf都會(huì)被加載,同時(shí)由于使用了/**/的方式,表明要加載conf目錄下包括各級(jí)子目錄中的所有配置文件,因此bin/conf/application-context.xml和 bin/conf/admin/admin-application-context.xml以及jar包中的 conf/application-context.xml和 conf/admin/admin-application-context.xml都會(huì)被加載,Spring啟動(dòng)時(shí)的輸出顯示為: Loading XML bean definitions from file [D:\myworkspace\spring-study\bin\conf\admin\admin-application-context.xml] Loading XML bean definitions from file [D:\myworkspace\spring-study\bin\conf\application-context.xml] Loading XML bean definitions from URL [jar:file:/D:/myworkspace/conf1.jar!/conf/admin/admin-application-context.xml] Loading XML bean definitions from URL [jar:file:/D:/myworkspace/conf1.jar!/conf/application-context.xml]
特別注意: 如果工程目錄如圖所示: ![]() 即配置文件直接放在bin目錄中,同時(shí)在工程屬性的Java Build Path->Libraries里導(dǎo)入conf.jar文件,jar文件結(jié)構(gòu)如圖所示: ![]() 這時(shí)使用 ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:**/*application-context.xml");來(lái)創(chuàng)建ApplicationContext對(duì)象的話,Spring只會(huì)加載 bin/application-context.xml和bin/admin/admin-application-context.xml, 而jar包中的配置文件并不會(huì)被加載。這是因?yàn)?/span>Spring使用class path加載配置文件時(shí)需要借助JDK的ClassLoader.getResources(String name)方法,而該方法有一個(gè)局限:當(dāng)傳入的參數(shù)為空字符串時(shí),即我們本意是想從根目錄獲取文件,這時(shí)JDK只會(huì)返回存在于文件系統(tǒng)中的資源,而在jar包中的資源并不會(huì)被返回。
我們?cè)?/span>eclipse中寫個(gè)簡(jiǎn)單的測(cè)試類就能很容易看到這點(diǎn): ClassLoader loader = Thread.currentThread().getContextClassLoader(); Enumeration resources = loader.getResources(""); while (resources.hasMoreElements()) { URL url = (URL)resources.nextElement(); System.out.println(url); } 運(yùn)行測(cè)試類后,輸出結(jié)果為: file:/D:/myworkspace/spring-study/bin/ file:/D:/ProgramFiles/eclipse3.2/configuration/org.eclipse.osgi/bundles/47/1/.cp/ 可以看到,獲得的資源路徑中并不包含jar包中的路徑,因此jar包中的配置文件自然不能被Spring加載了。 參考資料: Spring Framework開發(fā)參考手冊(cè)(中文翻譯版) http://www.redsaga.com/spring_ref/2.0/html/
java.lang.ClassLoader的API文檔 http://java.sun.com/j2se/1.5.0/docs/api/
org.springframework.core.io.support.PathMatchingResourcePatternResolver的API文檔 http://static.springframework.org/spring/docs/2.0.x/api/index.html |
聯(lián)系客服