现在的位置: 首页 > 综合 > 正文

Spring中使用classpath加载配置文件浅析

2013年09月16日 ⁄ 综合 ⁄ 共 5959字 ⁄ 字号 评论关闭

在应用Spring的工程中,使用class
path
的方式加载配置文件应该是最常用的做法,然而对大部分人来说,刚开始使用Spring时,几乎都碰到过加载配置文件失败的情况,除了配置上的错误外,很多时候是因为配置文件的路径和程序中指定的加载路径不一致,从而导致配置文件找不到,或是加载了错误地方的配置文件。本文将就Spring如何从class
path
中加载配置文件做一些简要的分析。

       

 

情形一:使用classpath加载且不含通配符

这是最简单的情形,Spring默认会使用当前线程的ClassLoadergetResource方法获取资源的URL,如果无法获得当前线程的ClassLoaderSpring将使用加载类org.springframework.util.ClassUtilsClassLoader

    

 

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

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目录下的confjar包里的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.xmlbin/admin/admin-application-context.xml

jar包中的配置文件并不会被加载。这是因为Spring使用class
path
加载配置文件时需要借助JDKClassLoader.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包中的路径,因此

抱歉!评论已关闭.