Resource
在spring中定义了新的Resource类
public interface Resource extends InputStreamSource {
boolean exists();
default boolean isReadable() {
return exists();
}
default boolean isOpen() {
return false;
}
default boolean isFile() {
return false;
}
URL getURL() throws IOException;
URI getURI() throws IOException;
File getFile() throws IOException;
default ReadableByteChannel readableChannel() throws IOException {
return Channels.newChannel(getInputStream());
}
long contentLength() throws IOException;
long lastModified() throws IOException;
Resource createRelative(String relativePath) throws IOException;
@Nullable
String getFilename();
String getDescription();
}
显然继承了InputStreamSource
public interface InputStreamSource {
InputStream getInputStream() throws IOException;
}
需要注意的是:getInputStream定位并打开资源,返回资源对应的输入流。每次调用都会返回新的输入流,调用者在使用完毕后必须关闭该资源。
在spring内部内置了许多Resource 实现
ByteArrayResource
InputStreamResource
FileSystemResource
UrlResource
ClassPathResource
ServletContextResource
VfsResource
ResourceLoader
而Spring框架为了更方便的获取资源,尽量弱化程序员对各个Resource接口实现类的感知与分辨,降低学习与使用成本,定义了另一个接口,就是:ResourceLoader接口。
- 此接口有一个特别重要的方法:Resource getResource(String location)。返回的对象,就是Spring容器中Resource接口的实例
- Spring内所有的ApplicationContext实例(包括Spring自启动容器或者用户手动创建的其他容器),都实现了这个方法
因此程序员在使用Spring容器时,可以:不用过于计较Spring内底层Resource的实现方式,也不需要自己创建Resource实现类,而是直接使用applicationContext.getResource()语句,即可获取到applicationContext容器本身自有的Resource实例,进而用此Resource实例,去获取相关的资源数据。
示例如下:
@Autowired
ApplicationContext applicationContext ;
@GetMapping("testResourceLoader")
public Object testResourceLoader() throws IOException {
Resource resource = applicationContext.getResource("classpath:application.yml");
System.out.println(resource.contentLength());
return resource;
}
但是,Spring框架定义了很多Resource的实现类,那么通过applicationContext.getResource()获得到的Resource对象,到底是哪一种Resource接口的实现类对象呢?这个问题对开发者很重要,因为只有知道是哪个Resource的实现类,才能更方便的使用此实例获取资源。
我们需要知道:
Spring的原则是:applicationContext.getResource()会采用和ApplicationContext相同的策略来访问资源。就是与ApplicationContext容器创建时采用的资源获取方式(即Spring启动时,容器本身读取资源----XXX.xml文件的策略),与此策略相同的Resource实现方式。
比如在原生Spring中:
如果用ClassPathXmlApplicationContext启动的Spring容器,则底层Resource是ClassPathResource实例
如果用FileSystemXmlApplicationContext启动的Spring容器,则底层Resource是FileSystemResource实例
如果用XmlWebApplicationContext启动的Spring容器,则底层Resource是ServletContextResource实例
那么如何获取指定Resource呢?
有时候程序员可能更擅长某种Resource实现类,或者当前项目需要大量读取某一种类型资源,使用对应的具体的实现类则更简洁与优雅。而这些实现类又有可能与当前ApplicationContext策略的Resource实现类不同,这时直接获取Spring容器的Resource实现类反而不太好用。
为此,Spring也支持程序员使用路径前缀等方式,来强制指定从Spring容器获取到的Resource实现类,这个实现类可能与当前ApplicationContext策略不相同。
例如前缀"classpath:"是指定使用ClassPathResource;前缀"file:"则指定使用UrlResource访问本地系统资源等。
需要注意的是:
与classpath区别是,classpath会找到路径下所有符合规定的xml文件,进行加载;而classpath只找到第一个xml文件进行加载。并且classpath: 只能用在ApplicationContext中(通过Classloader.getResource()方法实现)。不可直接用在Resource前。所以如果不是Spring容器,而是直接使用Resource,想通过classpath*:前缀去一次性访问多个资源文件是行不通的
在ResourceUtils 中列举了各种前缀
public abstract class ResourceUtils {
/** Pseudo URL prefix for loading from the class path: "classpath:". */
public static final String CLASSPATH_URL_PREFIX = "classpath:";
/** URL prefix for loading from the file system: "file:". */
public static final String FILE_URL_PREFIX = "file:";
/** URL prefix for loading from a jar file: "jar:". */
public static final String JAR_URL_PREFIX = "jar:";
/** URL prefix for loading from a war file on Tomcat: "war:". */
public static final String WAR_URL_PREFIX = "war:";
/** URL protocol for a file in the file system: "file". */
public static final String URL_PROTOCOL_FILE = "file";
/** URL protocol for an entry from a jar file: "jar". */
public static final String URL_PROTOCOL_JAR = "jar";
/** URL protocol for an entry from a war file: "war". */
public static final String URL_PROTOCOL_WAR = "war";
/** URL protocol for an entry from a zip file: "zip". */
public static final String URL_PROTOCOL_ZIP = "zip";
/** URL protocol for an entry from a WebSphere jar file: "wsjar". */
public static final String URL_PROTOCOL_WSJAR = "wsjar";
/** URL protocol for an entry from a JBoss jar file: "vfszip". */
public static final String URL_PROTOCOL_VFSZIP = "vfszip";
/** URL protocol for a JBoss file system resource: "vfsfile". */
public static final String URL_PROTOCOL_VFSFILE = "vfsfile";
/** URL protocol for a general JBoss VFS resource: "vfs". */
public static final String URL_PROTOCOL_VFS = "vfs";
/** File extension for a regular jar file: ".jar". */
public static final String JAR_FILE_EXTENSION = ".jar";
/** Separator between JAR URL and file path within the JAR: "!/". */
public static final String JAR_URL_SEPARATOR = "!/";
/** Special separator between WAR URL and jar part on Tomcat. */
public static final String WAR_URL_SEPARATOR = "*/";
}
需要指出的是,这种指定前缀指定方法,仅对当次获取资源有效,后面的还会恢复默认的applicationContext的Resource实例。
ResourceLoaderAware
与BeanNameAware、ApplicationContextAware这些接口类似,Spring会自动调用:implements了ResourceLoaderAware接口类的实现方法:setResourceLoader(),将ApplicationContext的ResourceLoader注入进去。 之后对它getResource(),就可以获取到系统的Resource了
public class ResourceBean implements ResourceLoaderAware {
private ResourceLoader resourceLoader;
public ResourceLoader getResourceLoader() {
return resourceLoader;
}
@Override
public void setResourceLoader(ResourceLoader resourceLoader) {
this.resourceLoader = resourceLoader;
}
}
ResourcePatternResolver
public interface ResourcePatternResolver extends ResourceLoader {
String CLASSPATH_ALL_URL_PREFIX = "classpath*:";
/**
* 返回指定路径下所有的资源对象。
* 返回的对象集合应该有Set的语义,也就是说,对于同一个资源,只应该返回一个资源对象
*/
Resource[] getResources(String locationPattern) throws IOException;
}
据注释:
- 这个是用于解析资源文件的策略接口,是ResourceLoader接口的拓展接口,其特殊的地方在于,它提供带有*号这种通配符的资源路径。
- 支持所有类似于
/WEB-INF/*-context.xml 的路径输入;输入模式必须与策略实现匹配。这个接口只指定了转换方法,而不是特定的模式格式。
- 提倡使用classpath*作为前缀以查找该路径下所有匹配的资源,并且前缀之后使用无占位符的资源定位,如/beans.xml。
- PathMatchingResourcePatternResolver是一个独立的实现,可以在ApplicationContext之外使用,如ResourceArrayPropertyEditor中
PathMatchingResourcePatternResolver
是一个Ant模式通配符的Resource查找器,可以用来查找类路径下或者文件系统中的资源。
ResourceUtils
获取文件的工具类