Spring中使用classpath加載配置文件淺析
在應用Spring的工程中,使用class path的方式加載配置文件應該是最常用的做法,然而對大部分人來說,剛開始使用Spring時,幾乎都碰到過加載配置文件失敗的情況,除了配置上的錯誤外,很多時候是因爲配置文件的路徑和程序中指定的加載路徑不一致,從而導致配置文件找不到,或是加載了錯誤地方的配置文件。本文將就Spring如何從class path中加載配置文件做一些簡要的分析。
情形一:使用classpath加載且不含通配符
這是最簡單的情形,Spring默認會使用當前線程的ClassLoader的getResource方法獲取資源的URL,如果無法獲得當前線程的ClassLoader,Spring將使用加載類org.springframework.util.ClassUtils的ClassLoader。
1.當工程目錄結構如圖所示:
即配置文件放在bin目錄中的conf文件夾裏,這時使用
ApplicationContext context = new ClassPathXmlApplicationContext("conf/application-context.xml");
來創建ApplicationContext對象的話,Spring將加載bin/conf目錄下的application-context.xml文件。Spring啓動時的輸出顯示爲:
Loading XML bean definitions from
class path resource [conf/application-context.xml]
2.當工程目錄結構如圖所示:
即bin目錄下只有.class文件,沒有配置文件,同時在工程屬性的Java Build Path->Libraries裏導入conf.jar文件,jar文件結構如圖所示:
這時使用
ApplicationContext context = new ClassPathXmlApplicationContext("conf/application-context.xml");
來創建ApplicationContext對象的話,Spring將加載conf.jar文件中conf目錄下的application-context.xml文件。Spring啓動時的輸出顯示爲:
Loading XML bean definitions from
class path resource [conf/application-context.xml]
3. 當工程目錄結構如圖所示:
即配置文件放在bin目錄中的conf文件夾裏,同時在工程屬性的Java Build Path->Libraries裏導入conf.jar文件,jar文件結構如圖所示:
這時使用
ApplicationContext context = new ClassPathXmlApplicationContext("conf/application-context.xml");
來創建ApplicationContext對象的話,由於沒有使用classpath*前綴,Spring只會加載一個application-context.xml文件。在eclipse中將會加載bin/conf目錄下的application-context.xml文件,而jar包中的conf/application-context.xml並不會被加載,Spring啓動時的輸出顯示爲:
Loading XML bean definitions from
class path resource [conf/application-context.xml]
情形二:使用classpath加載,包含通配符
碰到通配符的情況時,Spring會通過使用路徑中的非通配符部分先確定資源的大致位置,然後根據這個位置在確定具體的資源位置,結合下面給出的幾種情況可以更好地理解Spring的這種工作方式
1. 當工程目錄結構如圖所示:
即配置文件放在bin目錄中的conf文件夾裏,這時使用
ApplicationContext context = new ClassPathXmlApplicationContext("conf/**/*application-context.xml");
來創建ApplicationContext對象的話,Spring首先會通過路徑中的非通配符部分即conf,先確定conf的路徑,即bin/conf目錄,然後從該目錄下加載配置文件,由於使用了/**/的方式,表明要加載conf目錄下包括各級子目錄中的所有配置文件,因此bin/conf/application-context.xml文件和
bin/conf/admin/admin-application-context.xml都會被加載,Spring啓動時的輸出顯示爲:
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.當工程目錄結構如圖所示:
即bin目錄下只有.class文件,沒有配置文件,同時在工程屬性的Java Build Path->Libraries裏導入conf.jar文件,jar文件結構如圖所示:
這時使用
ApplicationContext context = new ClassPathXmlApplicationContext("conf/**/*application-context.xml");
來創建ApplicationContext對象的話,Spring首先會通過路徑中的非通配符部分即conf,先確定conf的路徑,即conf.jar中的conf目錄,然後從該目錄下加載配置文件,由於使用了/**/的方式,表明要加載conf目錄下包括各級子目錄中的所有配置文件,因此conf/application-context.xml文件和
conf/admin/admin-application-context.xml都會被加載,Spring啓動時的輸出顯示爲:
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.當工程目錄結構如圖所示:
即配置文件放在bin目錄中的conf文件夾裏,同時在工程屬性的Java Build Path->Libraries裏導入conf.jar文件,jar文件結構如圖所示:
這時使用
ApplicationContext context = new ClassPathXmlApplicationContext("conf/**/*application-context.xml");
來創建ApplicationContext對象的話,Spring首先會通過路徑中的非通配符部分即conf,先確定conf的路徑,在eclipse中是bin/conf目錄,然後從該目錄下加載配置文件,由於使用了/**/的方式,表明要加載conf目錄下包括各級子目錄中的所有配置文件,因此bin/conf/application-context.xml文件和
bin/conf/admin/admin-application-context.xml都會被加載,但conf.jar文件中的配置文件並不會被加載,Spring啓動時的輸出顯示爲:
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資源,從而避免出現兩個不同位置有相同名字的文件,Spring只加載其中一個的情況。
當工程目錄結構如圖所示:
即配置文件放在bin目錄中的conf文件夾裏,同時在工程屬性的Java Build Path->Libraries裏導入conf.jar文件,jar文件結構如圖所示:
這時使用
ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:conf/application-context.xml");
來創建ApplicationContext對象的話, Spring將會加載bin目錄下的application-context.xml文件和jar包裏的application-context.xml文件,Spring啓動時的輸出顯示爲:
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]
情形四:使用classpath*前綴,包含通配符
當工程目錄結構如圖所示:
即配置文件放在bin目錄中的conf文件夾裏,同時在工程屬性的Java Build Path->Libraries裏導入conf.jar文件,jar文件結構如圖所示:
這時使用
ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:conf/**/*application-context.xml");
來創建ApplicationContext對象的話,Spring首先會通過路徑中的非通配符部分即conf,先確定conf的路徑,由於使用了classpaht*前綴,因此bin目錄下的conf和jar包裏的conf都會被加載,同時由於使用了/**/的方式,表明要加載conf目錄下包括各級子目錄中的所有配置文件,因此bin/conf/application-context.xml和
bin/conf/admin/admin-application-context.xml以及jar包中的
conf/application-context.xml和
conf/admin/admin-application-context.xml都會被加載,Spring啓動時的輸出顯示爲:
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目錄中,同時在工程屬性的Java Build Path->Libraries裏導入conf.jar文件,jar文件結構如圖所示:
這時使用
ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:**/*application-context.xml");
來創建ApplicationContext對象的話,Spring只會加載
bin/application-context.xml和bin/admin/admin-application-context.xml,
而jar包中的配置文件並不會被加載。這是因爲Spring使用class path加載配置文件時需要藉助JDK的ClassLoader.getResources(String name)方法,而該方法有一個侷限:當傳入的參數爲空字符串時,即我們本意是想從根目錄獲取文件,這時JDK只會返回存在於文件系統中的資源,而在jar包中的資源並不會被返回。
我們在eclipse中寫個簡單的測試類就能很容易看到這點:
ClassLoader loader = Thread.currentThread().getContextClassLoader();
Enumeration resources = loader.getResources("");
while (resources.hasMoreElements()) {
URL url = (URL)resources.nextElement();
System.out.println(url);
}
運行測試類後,輸出結果爲:
file:/D:/myworkspace/spring-study/bin/
file:/D:/ProgramFiles/eclipse3.2/configuration/org.eclipse.osgi/bundles/47/1/.cp/
可以看到,獲得的資源路徑中並不包含jar包中的路徑,因此jar包中的配置文件自然不能被Spring加載了。