Spring使用ResourceLoader接口获取资源

前言

        Spring中整合了获取资源的工具，就是使用Resource接口。此接口是Spring为了统一读取诸如本地文件、classpath项目路径下的文件、url互联网上的文件等不同类型渠道的资源，封装隐藏如打开流、关闭流、报错处理等大量重复模板代码，而专程设计提供的接口类。

        有关Resource接口的基础知识，可以参考我的另一篇博客：《Spring Resource接口进行资源访问》。

 

一. ResourceLoader接口

        而Spring框架为了更方便的获取资源，尽量弱化程序员对各个Resource接口实现类的感知与分辨，降低学习与使用成本，定义了另一个接口，就是：ResourceLoader接口。

1.  此接口有一个特别重要的方法：Resource getResource(String location)。返回的对象，就是Spring容器中Resource接口的实例
2. Spring内所有的ApplicationContext实例(包括Spring自启动容器或者用户手动创建的其他容器)，都实现了这个方法

    因此程序员在使用Spring容器时，可以：

• 不去过于计较Spring内底层Resource的实现方式
• 也不需要自己创建Resource实现类
• 而是直接使用applicationContext.getResource()语句，即可获取到applicationContext容器本身自有的Resource实例；
• 进而用此Resource实例，去获取相关的资源数据。

示例如下：

public class ResourceTest implements ApplicationContextAware{
	
	ApplicationContext applicationContext ;
	
	public void getResourceTest() {
		//通过applicationContext，只一步getResource()，就可以获取资源
		Resource resource = applicationContext.getResource("spring-mvc.xml");
		//TODO: 用此resource来获取想要的资源
		//......
	}
	
	@Override
	public void setApplicationContext(ApplicationContext applicationContext)
			throws BeansException {		
		this.applicationContext = applicationContext;		
	}
}

 

二. Spring的Resource策略 

       Spring框架定义了很多Resource的实现类（例如InputStreamResource、ClassPathResource、UrlResource等等等等）。

那么问题来了，我们有时候想知道，通过applicationContext.getResource()获得到的Resource对象，到底是哪一种Resource接口的实现类对象呢？这个问题对开发者很重要，因为只有知道是哪个Resource的实现类，才能更方便的使用此实例获取资源。

       Spring框架的原则是：applicationContext.getResource()会采用和ApplicationContext相同的策略来访问资源。

1. 背景知识：ApplicationContext的创建方式

       学过原生Spring的同学都知道，当我们想开发一个Spring项目，也就是创建ApplicationContext容器、让Spring启动生效时，我们：

1. 首先会写一个xml文件，其中定义若干个元素；
2. 然后在java代码中用如下的几种写法，去加载其中的bean元素，生成对应的实例并注入ApplicationContext容器内：
   1. new ClassPathXmlApplicationContext("xxx.xml")
   2. new FileSystemXmlApplicationContext("xxx.xml")
   3. WebApplicationContextUtils.getWebApplicationContext(servletContext)
3. 在SpringMVC、SpringBoot中，程序员没有直接这样创建applicationContext对象，是因为框架已经使用这些方法封装好了创建方式，在启动时会自动加载。但内部也都存在对应的ApplicationContext容器，会有类似的调用或创建语法

具体使用方法可以参考文章《spring加载ApplicationContext.xml的四种方式》 

2. 什么是与ApplicationContext相同的策略？

       就是与ApplicationContext容器创建时采用的资源获取方式(即Spring启动时，容器本身读取资源----XXX.xml文件的策略)，与此策略相同的Resource实现方式。乍一看比较绕口，具体如下：

• 如果用ClassPathXmlApplicationContext启动的Spring容器，则底层Resource是ClassPathResource实例     
• 如果用FileSystemXmlApplicationContext启动的Spring容器，则底层Resource是FileSystemResource实例 
• 如果用XmlWebApplicationContext启动的Spring容器，则底层Resource是ServletContextResource实例

3. 获取指定的Resource实现类

       有时候程序员可能更擅长某种Resource实现类，或者当前项目需要大量读取某一种类型资源，使用对应的具体的实现类则更简洁与优雅。而这些实现类又有可能与当前ApplicationContext策略的Resource实现类不同，这时直接获取Spring容器的Resource实现类反而不太好用。

为此，Spring也支持程序员使用路径前缀等方式，来强制指定从Spring容器获取到的Resource实现类，这个实现类可能与当前ApplicationContext策略不相同。

例如前缀"classpath:"是指定使用ClassPathResource；前缀"file:"则指定使用UrlResource访问本地系统资源等

//强制使用ClassPathResource
Resource resource = applicationContext.getResource("classpath:spring-mvc.xml");

//强制使用UrlResource
Resource resource = applicationContext.getResource("file:book.xml");

        需要指出的是，这种指定前缀指定方法，仅对当次获取资源有效，后面的还会恢复默认的applicationContext的Resource实例。 

//即使一开始创建用classpath:前缀，ApplicationContext的Resource还是FileSystemResource
applicationContext=new FileSystemXmlApplicationContext("classpath:bean.xml");

//这里还是用的FileSystemResource
applicationContext.getResource("book.xml");

 

三. ResourceLoaderAware接口

        与BeanNameAware、ApplicationContextAware这些接口类似，Spring会自动调用：implements了ResourceLoaderAware接口类的实现方法：serResourceLoader()，将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;  
    }  
}  

 

四. classpath*

    与classpath区别是，classpath*会找到路径下所有符合规定的xml文件，进行加载；而classpath只找到第一个xml文件进行加载。

classpath*:  只能用在ApplicationContext中（通过Classloader.getResource()方法实现）。不可直接用在Resource前。所以如果不是Spring容器，而是直接使用Resource，想通过classpath*:前缀去一次性访问多个资源文件是行不通的。

 

五. 相对路径与绝对路径

     可以参考文档：《Java文件路径》