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文件,其中定义若干个<bean/>元素;

  2. 然后在java代码中用如下的几种写法,去加载其中的bean元素,生成对应的实例并注入ApplicationContext容器内:

    • new ClassPathXmlApplicationContext("xxx.xml")
    • new FileSystemXmlApplicationContext("xxx.xml")
    • 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实例。

三. ResourceLoaderAware接口

  与BeanNameAware、ApplicationContextAware这些接口类似,Spring会自动调用实现了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文件路径

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 226,197评论 6 524
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 97,254评论 3 410
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 173,718评论 0 370
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 61,801评论 1 305
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 70,732评论 6 404
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 54,200评论 1 318
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 42,389评论 3 433
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 41,484评论 0 282
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 48,024评论 1 328
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 40,013评论 3 352
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 42,125评论 1 359
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,698评论 5 353
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 43,407评论 3 342
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,795评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,996评论 1 278
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 50,724评论 3 384
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 47,150评论 2 368

推荐阅读更多精彩内容