二十四. ConfigurableEnvironment接口解析

说明: 大多数环境类型实现的配置接口。提供用于设置活动和默认配置文件以及操作基础属性资源的工具。允许客户端通过ConfigurablePropertyResolver超级接口设置和验证所需的属性、定制转换服务等。

操作属性资源

属性源可以被删除、重新排序或替换;可以使用getPropertySources()返回的MutablePropertySources实例添加其他属性源。下面的例子是针对ConfigurableEnvironment的StandardEnvironment实现的,但通常适用于任何实现,尽管特定的默认属性源可能不同。

示例:添加一个具有最高搜索优先级的新属性源

ConfigurableEnvironment environment = new StandardEnvironment();

  MutablePropertySources propertySources = environment.getPropertySources();

  Map<String, String> myMap = new HashMap<>();

  myMap.put("xyz", "myValue");

  propertySources.addFirst(new MapPropertySource("MY_MAP", myMap));

示例:删除系统默认属性资源

MutablePropertySources propertySources = environment.getPropertySources();

  propertySources.remove(StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME);

示例:模拟系统环境以进行测试

MutablePropertySources propertySources = environment.getPropertySources();

  MockPropertySource mockEnvVars = new MockPropertySource().withProperty("xyz", "myValue");

  propertySources.replace(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, mockEnvVars);

当ApplicationContext正在使用环境时,在调用上下文的refresh()方法之前执行任何此类PropertySource操作是很重要的。这确保了所有属性源在容器引导过程中都是可用的,包括属性占位符配置器使用。

该接口继承了Environment和ConfigurablePropertyResolver接口,定义了以下方法:

// 指定此环境活动的配置文件集。配置文件在容器引导期间进行评估,以确定是否应该将bean定义注册到容器中。

任何现有的活动配置文件将被替换为给定的参数;调用时不带任何参数,以清除当前活动配置文件集。使用addActiveProfile可在保留现有集的同时添加配置文件。

void setActiveProfiles(String... profiles);

// 向当前活动配置文件集添加一个配置文件。

void addActiveProfile(String profile);

// 如果没有其他配置文件通过setActiveProfiles显式激活,则指定在默认情况下激活的配置文件集。

void setDefaultProfiles(String... profiles);

// 以可变的形式返回这个环境的PropertySources,允许操作PropertySource对象集,在解析这个环境对象的属性时应该搜索这些对象集。各种MutablePropertySources方法,如addFirst、addLast、addBefore和addAfter,允许对属性源排序进行细粒度控制。这很有用,例如,可以确保某些用户定义的属性源比默认属性源(如系统属性集或系统环境变量集)具有搜索优先级。

MutablePropertySources getPropertySources();

// 如果当前SecurityManager允许,则返回System.getProperties()的值,否则返回一个映射实现,该实现将尝试使用对System.getProperty(String)的调用访问各个键。

注意,大多数环境实现都将包含这个系统属性映射作为要搜索的默认PropertySource。因此,建议不要直接使用这种方法,除非有明确的意图绕过其他属性来源。

在返回的Map上调用Map.get(Object)永远不会抛出IllegalAccessException;在SecurityManager禁止访问属性的情况下,将返回null,并发出一个info级别的日志消息,指出异常。

Map<String, Object> getSystemProperties();

// 如果当前SecurityManager允许,则返回System.getenv()的值,否则返回一个映射实现,该实现将尝试使用对System.getenv(String)的调用访问各个键。

注意,大多数环境实现都将包含这个系统环境映射,作为要搜索的默认PropertySource。因此,建议不要直接使用这种方法,除非有明确的意图绕过其他属性来源。

在返回的Map上调用Map.get(Object)永远不会抛出IllegalAccessException;在SecurityManager禁止访问属性的情况下,将返回null,并发出一个info级别的日志消息,指出异常。

Map<String, Object> getSystemEnvironment();

// 将给定父环境的活动配置文件、默认配置文件和属性源附加到这个(子)环境的各自集合中。

对于父类和子类中存在的名称相同的PropertySource实例,子类实例将被保留,父类实例将被丢弃。这样做的效果是允许子程序重写属性源,以及避免通过常见的属性源类型(如系统环境和系统属性)进行冗余搜索。

活动和默认配置文件名称也被过滤重复,以避免混淆和冗余存储。

父环境在任何情况下都不会被修改。请注意,在merge调用之后发生的对父环境的任何更改都不会反映在子环境中。因此,在调用merge之前,应该注意配置父属性源和配置文件信息。

void merge(ConfigurableEnvironment parent);

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

推荐阅读更多精彩内容