Spring加载resource的写法

java资料

我们会讨论两种加载资源的方法： classpth: 和file:

在使用spring时，经常会看到类似 classpth:、classpath*: 这样的前缀，不管是加载spring xml配置文件还是其配置文件中加载资源文件都会看到这两种前缀配置，其实这两种前缀是有区别的，下面将举例详细解释。

[一]、测试项目准备

我们以spring中加载properties资源文件为例讲解，目录结构大致如下：
src
├─main
│  ├─filters
│  │
│  ├─java
│  │  └─com
│  │      └─micmiu
│  │          ├─demoweb
│  │          │  │ ....
│  │          │  │
│  │          │  └─utils
│  │          │
│  │          └─modules
│  │
│  ├─resources
│  │  │  application.properties
│  │  │  applicationContext-shiro.xml
│  │  │  applicationContext.xml
│  │  │  hibernate.cfg.xml
│  │  │  log4j.properties
│  │  │  spring-mvc.xml
│  │  │  spring-view.xml
│  │
│  └─webapp
│      │
│      └─WEB-INF
│
└─test
├─java
│  └─com
│      └─micmiu
│          ├─demoweb
│          │      TestOther.java
│
└─resources
application.properties

src
├─main
│  ├─filters
│  │
│  ├─java
│  │  └─com
│  │      └─micmiu
│  │          ├─demoweb
│  │          │  │ ....
│  │          │  │
│  │          │  └─utils
│  │          │
│  │          └─modules
│  │
│  ├─resources
│  │  │  application.properties
│  │  │  applicationContext-shiro.xml
│  │  │  applicationContext.xml
│  │  │  hibernate.cfg.xml
│  │  │  log4j.properties
│  │  │  spring-mvc.xml
│  │  │  spring-view.xml
│  │
│  └─webapp
│      │
│      └─WEB-INF
│
└─test
├─java
│  └─com
│      └─micmiu
│          ├─demoweb
│          │      TestOther.java
│
└─resources
application.properties

同时 在该项目的lib中添加一个测试的micmiu-test.jar包，jar包中的文件结构如下：
micmiu-test.jar
│  application.properties
│
├─com
│  └─micmiu
│      └─test
│              application.properties
│              RunApp.class
│
└─META-INF
MANIFEST.MF

micmiu-test.jar
│  application.properties
│
├─com
│  └─micmiu
│      └─test
│              application.properties
│              RunApp.class
│
└─META-INF
MANIFEST.MF

从准备的测试环境中我们可以看到在不同目录下的四个同名的application.properties资源文件。

[二]、测试代码：TestClassPath.java
package com.micmiu.demoweb;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
*
* @author <a href="http://www.micmiu.com">Michael Sun</a>
*/
public class TestClassPath {

/**
* @param args
*/
public static void main(String[] args) {
ApplicationContext ctx = new ClassPathXmlApplicationContext(
"classpath:/applicationContext.xml");
System.out.println(ctx.getClassLoader().getResource("").getPath());

}
}

package com.micmiu.demoweb;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
*
* @author <a href="http://www.micmiu.com">Michael Sun</a>
*/
public class TestClassPath {

/**
* @param args
*/
public static void main(String[] args) {
ApplicationContext ctx = new ClassPathXmlApplicationContext(
"classpath:/applicationContext.xml");
System.out.println(ctx.getClassLoader().getResource("").getPath());

}
}

[三]、测试结果

spring配置文件：applicationContext.xml 中两种不同的properties文件加载配置：

第一种：classpath:
<context:property-placeholder ignore-unresolvable="true"
location="classpath:/application.properties" />

这种配置下运行测试代码，日志信息中有关加载properties资源文件只有一条 如下：
Loading properties file from class path resource [application.properties]

第二种: classpath*:
<context:property-placeholder ignore-unresolvable="true"
location="classpath*:/application.properties" />

这种配置下运行测试代码，日志信息中有关加载properties资源文件会有三条如下：
Loading properties file from URL [file:/D:/workspace_sun/framework-dev/micmiu-demoweb/target/test-classes/application.properties]
Loading properties file from URL [file:/D:/workspace_sun/framework-dev/micmiu-demoweb/target/classes/application.properties]
Loading properties file from URL [jar:file:/D:/micmiu-test.jar!/application.properties]

由此日志信息可知：

同名资源存在时，classpath: 只从第一个符合条件的classpath中加载资源，而classpath*: 会从所有的classpath中加载符合条件的资源
classpath*:需要遍历所有的classpath，效率肯定比不上classpath，因此在项目设计的初期就尽量规划好资源文件所在的路径，避免使用classpath*来加载

 

Spring可以通过指定classpath*:与classpath:前缀加路径的方式从classpath加载文件,如bean的定义文件.classpath*:的出现是为了从多个jar文件中加载相同的文件.classpath:只能加载找到的第一个文件.

比如 resource1.jar中的package 'com.test.rs' 有一个 'jarAppcontext.xml' 文件,内容如下:

<bean name="ProcessorImplA" class="com.test.spring.di.ProcessorImplA" />

resource2.jar中的package 'com.test.rs' 也有一个 'jarAppcontext.xml' 文件,内容如下:

<bean id="ProcessorImplB" class="com.test.spring.di.ProcessorImplB" />

通过使用下面的代码则可以将两个jar包中的文件都加载进来

ApplicationContext ctx = new ClassPathXmlApplicationContext( "classpath*:com/test/rs/jarAppcontext.xml");

而如果写成下面的代码,就只能找到其中的一个xml文件(顺序取决于jar包的加载顺序)

ApplicationContext ctx = new ClassPathXmlApplicationContext( "classpath:com/test/rs/jarAppcontext.xml");

classpath*:的使用是为了多个component(最终发布成不同的jar包)并行开发,各自的bean定义文件按照一定的规则:package+filename,而使用这些component的调用者可以把这些文件都加载进来.

classpath*:的加载使用了classloader的 getResources() 方法,如果是在不同的J2EE服务器上运行,由于应用服务器提供自己的classloader实现，它们在处理jar文件时的行为也许会有所不同。 要测试classpath*: 是否有效，可以用classloader从classpath中的jar文件里加载文件来进行测试：getClass().getClassLoader().getResources("<someFileInsideTheJar>")。(上面的例子是在sun的jre中运行的状态)

从Spring的源码,在PathMatchingResourcePatternResolver类中,我们可以更清楚的了解其对的处理:如果是以classpath*开头,它会遍历classpath.

[java] view plain copy

  1. protected Resource[] findAllClassPathResources(String location) throws IOException {
  2.     String path = location;
  3.     if (path.startsWith("/")) {
  4.         path = path.substring(1);
  5.     }
  6.     Enumeration resourceUrls = getClassLoader().getResources(path);
  7.     Set<Resource> result = new LinkedHashSet<Resource>(16);
  8.     while (resourceUrls.hasMoreElements()) {
  9.         URL url = (URL) resourceUrls.nextElement();
  10.         result.add(convertClassLoaderURL(url));
  11.     }
  12.     return result.toArray(new Resource[result.size()]);
  13. }

http://blog.csdn.net/kkdelta/article/details/5560210,简介了在JAVA里遍历classpath中读取找到的所有符合名称的文件.另外在加载resource的时候,其他前缀的意义如下表所示:注意classpath*只能用与指定配置文件的路径,不能用在用于 getResource的参数.如 appContext.getResource("classpath*:conf/bfactoryCtx.xml")会异常的.

前缀例子说明
classpath:classpath:com/myapp/config.xml从classpath中加载。
file:file:/data/config.xml作为 URL 从文件系统中加载。
http:http://myserver/logo.png作为 URL 加载。
(none)/data/config.xml根据 ApplicationContext 进行判断。

从Spring的源码可以看出原因:如果是classpath:开头,从classpath加载,否则尝试URL,如果失败,调用

getResourceByPath

public Resource getResource(String location) {
Assert.notNull(location, "Location must not be null");
if (location.startsWith(CLASSPATH_URL_PREFIX)) {
return new ClassPathResource(location.substring(CLASSPATH_URL_PREFIX.length()), getClassLoader());
}
else {
try {
// Try to parse the location as a URL...
URL url = new URL(location);
return new UrlResource(url);
}
catch (MalformedURLException ex) {
// No URL -> resolve as resource path.
return getResourceByPath(location);
}
}
}

getResourceByPath会被不同ApplicationContext 实现覆盖.

如 GenericWebApplicationContext覆盖为如下:

protected Resource getResourceByPath(String path) {
return new ServletContextResource(this.servletContext, path);
}

如 FileSystemXmlApplicationContext覆盖为如下:

protected Resource getResourceByPath(String path) {
if (path != null && path.startsWith("/")) {
path = path.substring(1);
}
return new FileSystemResource(path);
}

最终从文件加载的时候仍然是JAVA中常见的读取文件的方法:

如ClassPathResource得到inputstream的方法是利用class loader.

public InputStream getInputStream() throws IOException {
InputStream is;
if (this.clazz != null) {
is = this.clazz.getResourceAsStream(this.path);
}

如FileSystemResource得到inputstream的方法是利用FileInputStream.

public InputStream getInputStream() throws IOException {
return new FileInputStream(this.file);
}

如ServletContextResource得到inputstream的方法是利用servletContext.getResourceAsStream.

public InputStream getInputStream() throws IOException {
InputStream is = this.servletContext.getResourceAsStream(this.path);
if (is == null) {
throw new FileNotFoundException("Could not open " + getDescription());
}
return is;
}

发表评论