Spring 常用的兩種PropertyPlaceholderConfigurer

在做項(xiàng)目中涩哟,我們經(jīng)常會(huì)把項(xiàng)目使用到的常量放到一個(gè)或者多個(gè)Properties文件中番甩;項(xiàng)目啟動(dòng)加載Properties文件侵贵,程序會(huì)動(dòng)態(tài)的注入到相應(yīng)的屬性上或者動(dòng)態(tài)從Properties中獲取value。

如果使用Spring框架搭建的項(xiàng)目缘薛,Spring是如何處理Properties的窍育?

通過(guò)學(xué)習(xí)Spring和翻閱Spring源碼我了解到Spring對(duì)Properties的處理方式;接下來(lái)我會(huì)把學(xué)習(xí)的和從源碼看到的詳細(xì)介紹一下宴胧。

Configurer Properties


  • PropertyPlaceholderConfigurer

  • PropertySourcesPlaceholderConfigurer

Spring 對(duì)于Properties的操作都是分別基于上面兩個(gè)類漱抓,而且兩個(gè)類的實(shí)現(xiàn)方式是不一樣的。

PropertyPlaceholderConfigurer

這個(gè)類型是我在接觸Spring框架的時(shí)候就使用的類恕齐;但是當(dāng)時(shí)在用的時(shí)候沒(méi)有過(guò)多關(guān)注該類的實(shí)現(xiàn)方式乞娄,只停留在使用上;之后由于項(xiàng)目的功能需要我了解它的實(shí)現(xiàn)方式檐迟,并且寫了一篇文章專門介紹了該類补胚。

有興趣的可以先看看這篇文章:Spring Properties Loader

總結(jié)一下該類:

加載
  • 指定的properties文件
  • 合并指定的properties (參考:PropertiesLoaderSupport.localProperties)
解析
  • props (上面兩種加載后的合并properties)
  • System.getProperty()
  • System.getenv()

具體如何查找值,請(qǐng)參考源碼追迟;
org.springframework.beans.factory.config.PropertyPlaceholderConfigurer#resolvePlaceholder(String, Properties, int)


PropertySourcesPlaceholderConfigurer

首先看看類結(jié)構(gòu):

PropertySourcesPlaceholderConfigurer

通過(guò)對(duì)比兩個(gè)類的結(jié)構(gòu)發(fā)現(xiàn)溶其,除了類名的區(qū)別,還有就是PropertySourcesPlaceholderConfigurer類實(shí)現(xiàn)EnvironmentAware接口敦间,那么證明該類會(huì)有Environment的操作瓶逃;

了解Spring的知道,如果是非web環(huán)境廓块,接口Environment的實(shí)例類是StandardEnvironment厢绝;web環(huán)境,接口Environment的實(shí)例類是StandardServletEnvironment带猴;而且實(shí)現(xiàn)類會(huì)初始化系統(tǒng)屬性System.getProperties和環(huán)境變量System.getenv到PropertySources中昔汉。

StandardEnvironment

getSystemProperties()getSystemEnvironment()兩個(gè)方法的內(nèi)容我就不粘出來(lái)了,自行去參考源碼拴清;

不同


兩個(gè)類加載的屬性有什么不同呢靶病?

  • PropertyPlaceholderConfigurer

這個(gè)類是把所有的屬性集中放到Properties中;

  • PropertySourcesPlaceholderConfigurer

該類有一個(gè)PropertySources的集合口予,集合中放的是PropertySource娄周,它是一個(gè)抽象類,getProperty方法交由子類實(shí)現(xiàn)沪停;每一個(gè)PropertySource可以是一個(gè)Properties煤辨,而且PropertySource可以是任何東西裳涛;例如:System.getProperteisSystem.getenv

而該類直接重寫了postProcessBeanFactory方法众辨,如果PropertySources集合為空端三,此類會(huì)把EnvironmentProperties文件泻轰、localProperties放到集合中技肩;

@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    if (this.propertySources == null) {
        this.propertySources = new MutablePropertySources();
        if (this.environment != null) {
            this.propertySources.addLast(
                new PropertySource<Environment>(ENVIRONMENT_PROPERTIES_PROPERTY_SOURCE_NAME, this.environment) {
                    @Override
                    public String getProperty(String key) {
                        return this.source.getProperty(key);
                    }
                }
            );
        }
        try {
            PropertySource<?> localPropertySource =
                    new PropertiesPropertySource(LOCAL_PROPERTIES_PROPERTY_SOURCE_NAME, mergeProperties());
            if (this.localOverride) {
                this.propertySources.addFirst(localPropertySource);
            }
            else {
                this.propertySources.addLast(localPropertySource);
            }
        }
        catch (IOException ex) {
            throw new BeanInitializationException("Could not load properties", ex);
        }
    }

    processProperties(beanFactory, new PropertySourcesPropertyResolver(this.propertySources));
    this.appliedPropertySources = this.propertySources;
}

取值


  • PropertyPlaceholderConfigurer

Properteis、System.getenv浮声、System.getProperties

  • PropertySourcesPlaceholderConfigurer

因?yàn)榇祟愔袇R聚了Environment虚婿、多個(gè)PropertySource;因?yàn)镋nvironment中加載了System.getProperteisSystem.getenv泳挥,而且它們分別代表了一個(gè)PropertySource然痊;每個(gè)PropertySource會(huì)放到一個(gè)PropertySources集合中,每次取值時(shí)屉符,會(huì)根據(jù)位置順序剧浸,從每一個(gè)PropertySource中獲取屬性值;參考:StandardEnvironment#customPropertySources()

上面源碼中矗钟,我們看到此類把Environment作為一個(gè)PropertySource唆香,放到PropertySources集合中;而Environment中也有一個(gè)PropertySources集合吨艇,此集合中默認(rèn)初始化的是System.getProperteisSystem.getenv躬它;

private final MutablePropertySources propertySources = new MutablePropertySources(this.logger);

private final ConfigurablePropertyResolver propertyResolver = new PropertySourcesPropertyResolver(this.propertySources);

@Override
public String getProperty(String key) {
    return this.propertyResolver.getProperty(key);
}

@Override
public String getProperty(String key, String defaultValue) {
    return this.propertyResolver.getProperty(key, defaultValue);
}

@Override
public <T> T getProperty(String key, Class<T> targetType) {
    return this.propertyResolver.getProperty(key, targetType);
}

@Override
public <T> T getProperty(String key, Class<T> targetType, T defaultValue) {
    return this.propertyResolver.getProperty(key, targetType, defaultValue);
}

@Override
@Deprecated
public <T> Class<T> getPropertyAsClass(String key, Class<T> targetType) {
    return this.propertyResolver.getPropertyAsClass(key, targetType);
}

@Override
public String getRequiredProperty(String key) throws IllegalStateException {
    return this.propertyResolver.getRequiredProperty(key);
}

@Override
public <T> T getRequiredProperty(String key, Class<T> targetType) throws IllegalStateException {
    return this.propertyResolver.getRequiredProperty(key, targetType);
}

@Override
public String resolvePlaceholders(String text) {
    return this.propertyResolver.resolvePlaceholders(text);
}

@Override
public String resolveRequiredPlaceholders(String text) throws IllegalArgumentException {
    return this.propertyResolver.resolveRequiredPlaceholders(text);
}

綜合我們講的和源碼,我們可以知道东涡;此類匯聚了各種不用的PropertySource冯吓;

  • props

    把properties文件、localProperties封裝成PropertySource疮跑;

  • Environment

    有自己的PropertySources组贺;

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市祖娘,隨后出現(xiàn)的幾起案子失尖,更是在濱河造成了極大的恐慌,老刑警劉巖渐苏,帶你破解...
    沈念sama閱讀 221,198評(píng)論 6 514
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件掀潮,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡整以,警方通過(guò)查閱死者的電腦和手機(jī)胧辽,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,334評(píng)論 3 398
  • 文/潘曉璐 我一進(jìn)店門峻仇,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)公黑,“玉大人,你說(shuō)我怎么就攤上這事》惭粒” “怎么了人断?”我有些...
    開(kāi)封第一講書(shū)人閱讀 167,643評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)朝蜘。 經(jīng)常有香客問(wèn)我恶迈,道長(zhǎng),這世上最難降的妖魔是什么谱醇? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 59,495評(píng)論 1 296
  • 正文 為了忘掉前任暇仲,我火速辦了婚禮,結(jié)果婚禮上副渴,老公的妹妹穿的比我還像新娘奈附。我一直安慰自己,他們只是感情好煮剧,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,502評(píng)論 6 397
  • 文/花漫 我一把揭開(kāi)白布斥滤。 她就那樣靜靜地躺著,像睡著了一般勉盅。 火紅的嫁衣襯著肌膚如雪佑颇。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 52,156評(píng)論 1 308
  • 那天草娜,我揣著相機(jī)與錄音挑胸,去河邊找鬼。 笑死驱还,一個(gè)胖子當(dāng)著我的面吹牛嗜暴,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播议蟆,決...
    沈念sama閱讀 40,743評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼闷沥,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了咐容?” 一聲冷哼從身側(cè)響起舆逃,我...
    開(kāi)封第一講書(shū)人閱讀 39,659評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎戳粒,沒(méi)想到半個(gè)月后路狮,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,200評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡蔚约,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,282評(píng)論 3 340
  • 正文 我和宋清朗相戀三年奄妨,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片苹祟。...
    茶點(diǎn)故事閱讀 40,424評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡砸抛,死狀恐怖评雌,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情直焙,我是刑警寧澤景东,帶...
    沈念sama閱讀 36,107評(píng)論 5 349
  • 正文 年R本政府宣布,位于F島的核電站奔誓,受9級(jí)特大地震影響斤吐,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜厨喂,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,789評(píng)論 3 333
  • 文/蒙蒙 一和措、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧蜕煌,春花似錦臼婆、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,264評(píng)論 0 23
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至傀广,卻和暖如春颁独,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背伪冰。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,390評(píng)論 1 271
  • 我被黑心中介騙來(lái)泰國(guó)打工誓酒, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人贮聂。 一個(gè)月前我還...
    沈念sama閱讀 48,798評(píng)論 3 376
  • 正文 我出身青樓靠柑,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親吓懈。 傳聞我的和親對(duì)象是個(gè)殘疾皇子歼冰,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,435評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)耻警,斷路器隔嫡,智...
    卡卡羅2017閱讀 134,693評(píng)論 18 139
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,838評(píng)論 6 342
  • 1. Java基礎(chǔ)部分 基礎(chǔ)部分的順序:基本語(yǔ)法,類相關(guān)的語(yǔ)法甘穿,內(nèi)部類的語(yǔ)法腮恩,繼承相關(guān)的語(yǔ)法,異常的語(yǔ)法温兼,線程的語(yǔ)...
    子非魚(yú)_t_閱讀 31,657評(píng)論 18 399
  • 文章作者:Tyan博客:noahsnail.com | CSDN | 簡(jiǎn)書(shū) 24. Externalized Co...
    SnailTyan閱讀 2,039評(píng)論 1 2
  • 身邊有個(gè)美女同學(xué)秸滴,才華橫溢得讓我垂涎三尺,結(jié)果就是我一時(shí)沖動(dòng)報(bào)名加入30天寫作訓(xùn)練營(yíng)募判,幻想有朝一日自己哪怕能...
    邋遢睡神閱讀 241評(píng)論 0 2