Spring中加载配置文件的方式

Spring加载XML配置文件的方式,好像有3种, XML是最常见的Spring 应用系统配置源。Spring中的几种容器都支持使用XML装配bean,包括:
XMLBeanFactory ,
ClassPathXMLApplicationContext ,
FileSystemXMLApplicationContext ,
XMLWebApplicationContext

一:XMLBeanFactory 引用资源
Resource resource = new ClassPathResource("appcontext.XML");
BeanFactory factory = new XMLBeanFactory(resource);

二:ClassPathXMLApplicationContext 编译路径
ApplicationContext factory=new ClassPathXMLApplicationContext("classpath:appcontext.XML");
ApplicationContext factory=new ClassPathXMLApplicationContext("appcontext.XML"); // src目录下的
ApplicationContext factory=new ClassPathXMLApplicationContext("conf/appcontext.XML"); // src/conf 目录下的
ApplicationContext factory=new ClassPathXMLApplicationContext("file:G:/Test/src/appcontext.XML");

三 : 用文件系统的路径
ApplicationContext factory=new FileSystemXMLApplicationContext("src/appcontext.XML");
//使用了 classpath: 前缀,作为标志, 这样,FileSystemXMLApplicationContext 也能够读入classpath下的相对路径
ApplicationContext factory=new FileSystemXMLApplicationContext("classpath:appcontext.XML");
ApplicationContext factory=new FileSystemXMLApplicationContext("file:G:/Test/src/appcontext.XML");
ApplicationContext factory=new FileSystemXMLApplicationContext("G:/Test/src/appcontext.XML");

四: XMLWebApplicationContext 是专为Web工程定制的。
ServletContext servletContext = request.getSession().getServletContext();
ApplicationContext ctx = WebApplicationContextUtils.getWebApplicationContext(servletContext );

Spring中加载ApplicationContext.xml文件的方式

1.利用ClassPathXmlApplicationContext

可以从classpath中读取XML文件
(1)
ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); UserDao userDao = (UserDao)context.getBean("userDao");

(2)
ClassPathXmlApplicationContext resource = new ClassPathXmlApplicationContext(new String[]{"applicationContext-ibatis-oracle.xml","applicationContext.xml","applicationContext-data-oracle.xml"}); BeanFactory factory = resource; UserDao userDao = (UserDao) factory.getBean("userDao");


2. 利用ClassPathResource

可以从classpath中读取XML文件
Resource cr = new ClassPathResource("applicationContext.xml"); BeanFactory bf=new XmlBeanFactory(cr); UserDao userDao = (UserDao)bf.getBean("userDao");

加载一个xml文件org.springframework.beans.factory.config.PropertyPlaceholderConfigurer不起作用


3.利用XmlWebApplicationContext读取

XmlWebApplicationContext ctx = new XmlWebApplicationContext(); ctx.setConfigLocations(new String[] {"/WEB-INF/ applicationContext.xml"); ctx.setServletContext(pageContext.getServletContext()); ctx.refresh(); UserDao userDao = (UserDao ) ctx.getBean("userDao ");


4.利用FileSystemResource读取

Resource rs = new FileSystemResource("D:/tomcat/webapps/test/WEB-INF/classes/ applicationContext.xml"); BeanFactory factory = new XmlBeanFactory(rs); UserDao userDao = (UserDao )factory.getBean("userDao");

值得注意的是:利用FileSystemResource,则配置文件必须放在project直接目录下,或者写明绝对路径,否则就会抛出找不到文件的异常。


5.利用FileSystemXmlApplicationContext读取

可以指定XML定义文件的相对路径或者绝对路径来读取定义文件。

方法一:
String[] path={"WebRoot/WEB-INF/applicationContext.xml","WebRoot/WEB-INF/applicationContext_task.xml"}; ApplicationContext context = new FileSystemXmlApplicationContext(path);

方法二:

String path="WebRoot/WEB-INF/applicationContext*.xml"; ApplicationContext context = new FileSystemXmlApplicationContext(path);

方法三:
ApplicationContext ctx = new FileSystemXmlApplicationContext("classpath:地址");
没有classpath的话就是从当前的工作目录

Spring

3 Spring

有了spring,我们就不用再写工厂方法,不用发愁怎么把写出来的各个代码装配在一起,不过我们选择Spring的原因也不光是为了IOC,而是考虑到现在JavaEE中很多开源项目都提供了Spring整合使用的方法,可以为我们节省相当多的精力和时间。

3.1. 在项目中使用Spring

3.1.1. 直接构造ApplicationContext

如果我们可以applicationContext.xml放到classpath下,我们可以使用ClasspathXmlApplicationContext。这里传入参数的路径是相对于classpath的配置的,对于web项目就是WEB-INF/classes这个目录,或者WEB-INF/lib下任意一个jar文件下了。

ApplicationContext ctx = new ClasspathXmlApplicationContext("applicationContext.xml");

3.1.2. 使用ContextLoaderListener

从ServletContext取得web.xml中初始化的ApplicationContext

首先在web.xml中配置listener。

<context-param> <param-name>contextConfigLocation</param-name> <param-value>classpath*:spring*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:myworkspacespring-studybinconfadminadmin-application-context.xml] 
 Loading XML bean definitions from file  
 [D:myworkspacespring-studybinconfapplication-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:myworkspacespring-studybinconfadminadmin-application-context.xml]

Loading XML bean definitions from file

[D:myworkspacespring-studybinconfapplication-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目录下的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:myworkspacespring-studybinconfadminadmin-application-context.xml]

Loading XML bean definitions from file

[D:myworkspacespring-studybinconfapplication-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*:**applicationContext.xml file:C:/some/pathapplicationContext.xml

解析器会进行一个预先定义的复杂的过程去试图解析通配符。它根据路径中最后一个非通配符片断产生一个Resource并从中获得一个URL。 如果这个URL不是一个"jar:" URL或特定容器的变量(例如WebLogic中的 "zip:",WebSphere中的"wsjar"等等), 那么可以从中获得一个java.io.File, 并用它从文件系统中解析通配符。如果是一个jar URL,解析器可以从中取得一个 java.net.JarURLConnection,或者手工解析该jar URL,随后遍历jar文件以解析通配符。

潜在的可移植性

如果给定的路径已经是一个文件URL(可以是显式的或者是隐式的),由于基本的ResourceLoader是针对文件系统的,那么通配符一定能够移植。

如果给定的路径是一个classpath的位置,那么解析器必须通过一个 Classloader.getResource() 调用获得最后一个非通配符路径片断的URL。因为这仅仅是一个路径的节点(不是最终的文件), 所以它并未确切定义(在 ClassLoader Javadocs里) 此处究竟会返回什么类型的URL。一般情况下,当classpath资源解析为一个文件系统位置时, 返回一个代表目录的 java.io.File;当解析为jar位置时, 返回某类jar URL。当然,这个操作涉及到可移植性。

如果从最后一个非通配符片断中获得一个jar URL,那么解析器一定能从中取得一个 java.net.JarURLConnection,或者手动解析jar URL以遍历jar文件,从而解析通配符。这一操作在大多数环境中能正常工作,不过也有例外,因此我们强烈建议特定环境中的jar资源通配符解析应在正式使用前要经过彻底测试。

classpath*: 前缀

当构造基于XML的application context时,路径字符串可能使用特殊的 classpath*: 前缀:

ApplicationContext ctx = new ClassPathXmlApplicationContext("classpath*:conf/appContext.xml");

此前缀表示所有与给定名称匹配的classpath资源都应该被获取(其中,这经常会在调用 ClassLoader.getResources(...)) 时发生),并接着将那些资源全并成最终的application context定义。

Classpath*: 的可移植性

带通配符的classpath依赖于底层classloader的 getResources() 方法。现在大多数的应用服务器提供自己的classloader实现,它们在处理jar文件时的行为也许会有所不同。 要测试 classpath*: 是否有效,可以简单地用classloader从classpath中的jar文件里加载一个文件: getClass().getClassLoader().getResources("<someFileInsideTheJar>")。针对两个不同位置但有相同名字的文件来运行测试。如果结果不对,那么就查看一下应用服务器的文档,特别是那些可能影响classloader行为的设置。

"classpath*:"前缀也能在位置路径的其他部分结合PathMatcher pattern一起使用,例如"classpath*:META-INFservice-context.xml

解析器会排除getResource("com/mycompany");返回的(第一个)URL。如果这个基础包节点存在于多个classloader位置,最终要找的资源未必会被发现。因此在这种情况中最好在这个Ant风格的pattern中使用"classpath*:", 这样就会搜索包含根包在内所有类路径。

FileSystemResource 说明

一个并没有与 FileSystemApplicationContext 绑定的 FileSystemResource(也就是说FileSystemApplicationContext 并不是真正的ResourceLoader),会象你期望的那样分辨绝对和相对路径。相对路径是相对于当前的工作目录,而绝对路径是相对与文件系统的根目录。

为了向前兼容的目的,当 FileSystemApplicationContext 是个 ResourceLoader 时它会发生变化。FileSystemApplicationContext 会简单地让所有绑定的 FileSystemResource 实例把绝对路径都当成相对路径,而不管它们是否以反斜杠开头。也就是说,下面的含义是相同的:

ApplicationContext ctx = new FileSystemXmlApplicationContext("conf/context.xml");
ApplicationContext ctx = new FileSystemXmlApplicationContext("/conf/context.xml");

下面的也一样:(虽然把它们区分开来也很有意义,但其中的一个是相对路径而另一个则是绝对路径)。

FileSystemXmlApplicationContext ctx = ...; ctx.getResource("some/resource/path/myTemplate.txt");
FileSystemXmlApplicationContext ctx = ...; ctx.getResource("/some/resource/path/myTemplate.txt");

实际上如果的确需要使用绝对路径,那你最好就不要使用 FileSystemResourceFileSystemXmlApplicationContext来确定绝对路径。我们可以通过使用 file: URL前缀来强制使用UrlResource

// actual context type doesn't matter, the Resource will always be UrlResource ctx.getResource("file:/some/resource/path/myTemplate.txt");
// force this FileSystemXmlApplicationContext to load it's definition via a UrlResource ApplicationContext ctx = new FileSystemXmlApplicationContext("file:/conf/context.xml");
Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐