Spring 常用的两种PropertyPlaceholderConfigurer

在做项目中,我们经常会把项目使用到的常量放到一个或者多个Properties文件中;项目启动加载Properties文件,程序会动态的注入到相应的属性上或者动态从Properties中获取value。

如果使用Spring框架搭建的项目,Spring是如何处理Properties的?

通过学习Spring和翻阅Spring源码我了解到Spring对Properties的处理方式;接下来我会把学习的和从源码看到的详细介绍一下。

Configurer Properties


  • PropertyPlaceholderConfigurer

  • PropertySourcesPlaceholderConfigurer

Spring 对于Properties的操作都是分别基于上面两个类,而且两个类的实现方式是不一样的。

PropertyPlaceholderConfigurer

这个类型是我在接触Spring框架的时候就使用的类;但是当时在用的时候没有过多关注该类的实现方式,只停留在使用上;之后由于项目的功能需要我了解它的实现方式,并且写了一篇文章专门介绍了该类。

有兴趣的可以先看看这篇文章:Spring Properties Loader

总结一下该类:

加载
  • 指定的properties文件
  • 合并指定的properties (参考:PropertiesLoaderSupport.localProperties)
解析
  • props (上面两种加载后的合并properties)
  • System.getProperty()
  • System.getenv()

具体如何查找值,请参考源码;
org.springframework.beans.factory.config.PropertyPlaceholderConfigurer#resolvePlaceholder(String, Properties, int)


PropertySourcesPlaceholderConfigurer

首先看看类结构:

PropertySourcesPlaceholderConfigurer

通过对比两个类的结构发现,除了类名的区别,还有就是PropertySourcesPlaceholderConfigurer类实现EnvironmentAware接口,那么证明该类会有Environment的操作;

了解Spring的知道,如果是非web环境,接口Environment的实例类是StandardEnvironment;web环境,接口Environment的实例类是StandardServletEnvironment;而且实现类会初始化系统属性System.getProperties和环境变量System.getenv到PropertySources中。

StandardEnvironment

getSystemProperties()getSystemEnvironment()两个方法的内容我就不粘出来了,自行去参考源码;

不同


两个类加载的属性有什么不同呢?

  • PropertyPlaceholderConfigurer

这个类是把所有的属性集中放到Properties中;

  • PropertySourcesPlaceholderConfigurer

该类有一个PropertySources的集合,集合中放的是PropertySource,它是一个抽象类,getProperty方法交由子类实现;每一个PropertySource可以是一个Properties,而且PropertySource可以是任何东西;例如:System.getProperteisSystem.getenv

而该类直接重写了postProcessBeanFactory方法,如果PropertySources集合为空,此类会把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

因为此类中汇聚了Environment、多个PropertySource;因为Environment中加载了System.getProperteisSystem.getenv,而且它们分别代表了一个PropertySource;每个PropertySource会放到一个PropertySources集合中,每次取值时,会根据位置顺序,从每一个PropertySource中获取属性值;参考:StandardEnvironment#customPropertySources()

上面源码中,我们看到此类把Environment作为一个PropertySource,放到PropertySources集合中;而Environment中也有一个PropertySources集合,此集合中默认初始化的是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;

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,561评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,712评论 6 342
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,531评论 18 399
  • 文章作者:Tyan博客:noahsnail.com | CSDN | 简书 24. Externalized Co...
    SnailTyan阅读 2,021评论 1 2
  • 身边有个美女同学,才华横溢得让我垂涎三尺,结果就是我一时冲动报名加入30天写作训练营,幻想有朝一日自己哪怕能...
    邋遢睡神阅读 232评论 0 2