introduction
Java标准的java.net.URL和标准的处理类无法满足所有的底层资源访问,例如,没有一个标准的URL实现可以用来访问需要从 classpatch (或者 ServletContext) 下面获取的资源.虽然可以为一个指定的URL前缀指定一个新的处理类(类似对http:前缀的处理类),但是通常都比较复杂,并且URL接口还缺乏一些令人满意的方法.例如判断一个资源是否存在的方法.
Resource 接口
spring的Resource接口是想定义一个对访问底层资源更加合适的接口
public interface Resource extends InputStreamSource {
boolean exists();
boolean isOpen();
URL getURL() throws IOException;
File getFile() throws IOException;
Resource createRelative(String relativePath) throws IOException;
String getFilename();
String getDescription();
}
public interface InputStreamSource {
InputStream getInputStream() throws IOException;
}
Resource接口的一些主要方法
getInputStream(): 定位并打开资源,返回一个读取这个资源的输入流.每一次执行都返回一个新的输入流.由调用者来关闭这些流.exists(): 返回 boolean 表示资源是否真实存在.isOpen(): 返回这个资源是否有操作流被打开. true 表示输入流(InputStram)不能被多次读,并且需要读一次就关闭操作流,避免资源泄露. 其他所有的资源实现都应该返回false.getDescription(): 返回资源的描述.用于做资源处理时的错误输出.通常这个返回的是资源的全路径名或者实际的URL
还有其他的一些方法,可以用来获取一个代表这个资源的URL或者File对象.
Resource抽象在spring中广泛的使用.在大量方法需要资源时,在方法产生中都声明了Resurce参数类型.其他的一些方法,例如ApplicationContext的实现,通过接收一个String来创建一个Resource.
虽然Resource接口在spring中使用的非常多,但是即使你的代码不适用spring的其他部分,它也可以作为一个通用访问资源的工具类.虽然它会使代码和spring耦合,但是也只有工具类这一小部分,并且它提供了比URL更加优秀的服务.
Resource抽象不会替换功能,它会尽量将其包装起来,例如 UrlRsource用来包装Url为一个Resource
内建的Resource实现.
UrlResource:java.net.URL的包装类(http:,file:,ftp:等前缀)．ClassPathResource: 这个类表示的资源应该是包含在classpath目录下的.通过当前线程的类加载器,或者指定的加载器,又会在指定的类的来加载资源FileSystemResource:这个实现用来处理java.io.File的处理.ServletContextResource: 处理ServleteContext资源.处理web应用根目录相关的资源InputStreamResource: 处理InputStream, 它的isOpen()返回true,所以需要保存资源描述符或者需要使用多个读取流的时候,不要使用此类.ByteArrayResource:处理ByteArrayInputStream.通常用来在一个任意给定的字节数组中获取文本内容.
ResourceLoader
表明类可以返回一个Resource实例引用.
public interface ResourceLoader {
Resource getResource(String location);
}
所有的ApplicationContext子类都实现了ResourceLoader接口.每一个对应的不同的ApplicationContext,都返回器所对应的Resource,例如 ClassPathXmlApplicationContext返回ClassPathResource,FileSystemXmlApplicationContext返回FileSystemResource,WebApplicationContext返回ServletContextResource
由于所有的Resource都支持java.net.URL的使用方式,所以可以像下面一样使用:
Resource template = ctx.getResource("classpath:some/resource/path/myTemplate.txt");
Resource template = ctx.getResource("file:///some/resource/path/myTemplate.txt");
Resource template = ctx.getResource("http://myhost.com/resource/path/myTemplate.txt");
ResourceLoaderAware接口
标记型接口,实现了此类的接口,可以获取到ResourceLoad, 又或者通过@Autowired等方式来获取.
资源依赖
在bean配置中可使用以下简单配置使用Resource :
<bean id="myBean" class="...">
<property name="template" value="some/resource/path/myTemplate.txt"/>
</bean>
其中属性template的类型为Resource, value值没有指定前缀,则具体使用的Resource实现,根据当前上下文类型来决定使用哪个(ClassPathResource,ServletContextResource等), 也可通过下面这种前缀的方式指定Resource的实现.
<property name="template" value="classpath:some/resource/path/myTemplate.txt">
<property name="template" value="file:///some/resource/path/myTemplate.txt"/>
通配符
资源地址支持 ant-style 风格的模式
/WEB-INF/*-context.xml
com/mycompany/**/applicationContext.xml
file:C:/some/path/*-context.xml
classpath:com/mycompany/**/applicationContext.xml
参考
http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#resources