Spring Properties Loader

        最近在做Spring项目时,使用到了@Value注解,可以动态注入到注解了@Value的属性上;一般我们会把用到的属性(key/value值)统一放到一个或者多个properties文件中,Spring启动时加载properties把属性读到Spring Property组件中,后续的注入交由组件完成。

        我们一贯的做法是在application.xml 中,加载PropertiesLoaderSupport组件;

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:p="http://www.springframework.org/schema/p"
       xmlns:content="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/p http://www.springframework.org/schema/p/spring-p.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">

    <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location" value="classpath*:config.properties" />
    </bean>
</beans>

结构


        由于PropertyPlaceholderConfigurer实现了BeanFactoryPostProcessor接口;BeanFactory在加载的时候会调用该接口;

那我们看看加载过程;

首先来看看类结构:

PropertyPlaceholderConfigurer
package org.springframework.beans.factory.config;

import org.springframework.beans.BeansException;

public interface BeanFactoryPostProcessor {
    void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException;

}

看看postProcessBeanFactory 在BeanFactory初始化时在哪里调用的,我会先从哪个地方调用了这个方法,一步一步找到,最初加载调用的地方;

使用IDEA的同学可以按住ctrl 键,鼠标点击该方法

除了第二行,其它显示的都是注释;鼠标点击第二行进入;最终会跳到:

PostProcessorRegistrationDelegate

这个是一个静态的私用方法,在找(由于代码太长我就不粘出来了;大家可以去找找看)

PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors 方法调用了本类中的静态方法 PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors

那我们就找哪里调用了PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors方法;

AbstractApplicationContext

发现跳到AbstractApplicationContext类中;而AbstractApplicationContext是所有实现ApplicationContext子类的抽象父类;

我们在看看那个地方调用了AbstractApplicationContext.invokeBeanFactoryPostProcessors;

AbstractApplicationContext.refresh

最终找到了加载properties的源头,refresh()方法我就过多介绍了;

如何加载Properties


上面我们知道类的加载过程,接下来看看properties如何加载的。

回到PlaceholderConfigurerSupport.postProcessBeanFactory()

@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    try {
        Properties mergedProps = mergeProperties();

        // Convert the merged properties, if necessary.
        convertProperties(mergedProps);

        // Let the subclass process the properties.
        processProperties(beanFactory, mergedProps);
    }
    catch (IOException ex) {
        throw new BeanInitializationException("Could not load properties", ex);
    }
}
  • mergeProperties ()

    改方法主要做了两件事

    • 加载properties文件 loadProperties()
    • 合并指定的Property (参考原码)
  • convertProperties()

    该方法没有做什么处理,但是有兴趣的同学可以看看源码,去了解一下;

  • processProperties()

    这是个抽象方法,交由子类实现;

    子类就是文件开头介绍的PropertyPlaceholderConfigurer,看看该类实现了什么功能。

    @Override
    protected void processProperties(ConfigurableListableBeanFactory beanFactoryToProcess, Properties props)
            throws BeansException {
    
        StringValueResolver valueResolver = new PlaceholderResolvingStringValueResolver(props);
    
        this.doProcessProperties(beanFactoryToProcess, valueResolver);
    }
    

    Spring 最终把处理${} 或者 @Value的方式交由StringValueResolver来完成;

源码介绍的不够全面,需要你进入源码中,一步一步去理解。

如何解析Properties


通过看源码发现最终属性解析是在PropertyPlaceholderConfigurer.resolvePlaceholder方法中。

protected String resolvePlaceholder(String placeholder, Properties props, int systemPropertiesMode) {
        String propVal = null;
        if (systemPropertiesMode == SYSTEM_PROPERTIES_MODE_OVERRIDE) {
            propVal = resolveSystemProperty(placeholder);
        }
        if (propVal == null) {
            propVal = resolvePlaceholder(placeholder, props);
        }
        if (propVal == null && systemPropertiesMode == SYSTEM_PROPERTIES_MODE_FALLBACK) {
            propVal = resolveSystemProperty(placeholder);
        }
        return propVal;
    }
参数介绍
  • placeholder

    要解析的属性key

  • props

    PlaceholderConfigurerSupport.postProcessBeanFactory()方法中解析的properties

  • systemPropertiesMode

    有三个值

    • SYSTEM_PROPERTIES_MODE_NEVER

      不从System.getProperty()中获取placeholder对应的值。

    • SYSTEM_PROPERTIES_MODE_FALLBACK

      如果props中找不到placeholder对应的值,就从System.getProperty()或者System.getenv()中找。

    • SYSTEM_PROPERTIES_MODE_OVERRIDE

      优先从System.getProperty()或者System.getenv()中找placeholder对应的值,如果找不到,才会从props中找

      • System.getProperty()

        如果systemPropertiesMode的值为 SYSTEM_PROPERTIES_MODE_FALLBACKSYSTEM_PROPERTIES_MODE_OVERRIDE时,默认是从System.getProperty()中查找的;

      • System.getenv()

        如果System.getProperty()中没有有效的值,才会到System.getenv()中查找;但是要从System.getenv()中查找是受PropertyPlaceholderConfigurer.searchSystemEnvironment限制。

写到最后我们总结一下PropertyPlaceholderConfigurer

加载
  • properties 文件
  • localProperties

    这个要指定合并的Properties

解析
  • props
  • System.getProperty()
  • System.getenv()

Spring 版本 4+
具体实现参考源码。

  • PropertyPlaceholderConfigurer
  • BeanFactoryPostProcessor
  • AbstractApplicationContext
  • PostProcessorRegistrationDelegate
  • PlaceholderResolvingStringValueResolver
  • PropertyPlaceholderConfigurerResolver
  • SpringProperties
  • spring.properties

最后可以看看 PropertySourcesPlaceholderConfigurerPropertyPlaceholderConfigurer的实现方式有什么不一样?

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

推荐阅读更多精彩内容