ConfigurableEnvironment接口

这是一个配置接口,将由大多数(不是所有)环境类型的实现。提供用于设置活动配置文件和默认配置文件以及操作基础属性源的工具。允许客户端通过ConfigurablePropertyResolver 这个超级接口设置和验证所需属性、自定义转换服务等。

1. 接口说明

接口定义如下:

public interface ConfigurableEnvironment extends Environment, ConfigurablePropertyResolver {

    void setActiveProfiles(String... profiles);

    void addActiveProfile(String profile);

    void setDefaultProfiles(String... profiles);

    MutablePropertySources getPropertySources();

    Map<String, Object> getSystemProperties();

    Map<String, Object> getSystemEnvironment();

    void merge(ConfigurableEnvironment parent);

}

接口类图如下:


image.png

操作属性源
可以删除、重新排序或替换属性源;可以使用从getPropertySources()返回的MutablePropertySources实例添加其他属性源。以下示例与ConfigurableEnvironment的StandardEnvironment实现相反,但通常适用于任何实现,尽管特定的默认属性源可能不同。
示例1: adding a new property source with highest search priority


   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));

示例2: removing the default system properties property source

   MutablePropertySources propertySources = environment.getPropertySources();
   propertySources.remove(StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME)

示例3: mocking the system environment for testing purposes


   MutablePropertySources propertySources = environment.getPropertySources();
   MockPropertySource mockEnvVars = new MockPropertySource().withProperty("xyz", "myValue");
   propertySources.replace(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, mockEnvVars);

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

2. 方法说明

2.1 setActiveProfiles方法

指定此环境的活动配置文件集。在容器引导过程中评估概要文件,以确定是否应该向容器注册bean定义。
任何现有的活动配置文件都将替换为给定的参数;使用零参数调用以清除当前活动配置文件集。使用addActiveProfile添加配置文件,同时保留现有集。

2.2 addActiveProfile方法

将配置文件添加到当前活动配置文件集。

2.3 setDefaultProfiles方法

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

2.4 getPropertySources方法

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

2.5 getSystemProperties方法

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

请注意,大多数环境实现都将此系统属性映射作为要搜索的默认属性源。因此,除非明确打算绕过其他属性源,否则建议不要直接使用此方法。

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

2.6 getSystemEnvironment方法

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

注意,大多数环境实现将包括此系统环境映射作为要搜索的默认属性源。因此,除非明确打算绕过其他财产来源,否则建议不要直接使用此方法。

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

2.7 merge方法

将给定父环境的活动配置文件、默认配置文件和属性源附加到此(子)环境各自的集合中。
对于父实例和子实例中存在的任何同名PropertySource实例,将保留子实例,并丢弃父实例。这可以允许子级重写属性源,并避免通过常见属性源类型(例如系统环境和系统属性)进行冗余搜索。
活动和默认配置文件名称也会被过滤掉,以避免混淆和冗余存储。
在任何情况下,父环境都保持不变。请注意,在调用合并后对父环境所做的任何更改都不会反映在子环境中。因此,在调用merge之前,应小心配置父属性源和配置文件信息。

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

推荐阅读更多精彩内容

  • 前言 Shiro框架作为Java安全框架,目前是非常火的,目前市面上比较火的Java安全框架就属于Shiro和Sp...
    JTravler阅读 781评论 0 0
  • 第15课: Spring Boot中集成ActiveMQ 1. JMS 和 ActiveMQ 介绍 1.1 JMS...
    wanggs阅读 384评论 0 0
  • 身份验证,即在应用中谁能证明他就是他本人。一般提供如他们的身份ID一些标识信息来表明他就是他本人,如提供身份证,用...
    小孩真笨阅读 533评论 0 0
  • Shiro 会话管理 Apache Shiro 提供了一个非常独特的特性,即完整的企业级会话解决方案,既适用于最简...
    szn0108阅读 686评论 0 1
  • 一 、Shiro入门 1.简介 Apache Shiro 是 Java 的一个安全(权限)框架。 Shiro 可以...
    TiaNa_na阅读 1,095评论 0 8