自定义属性源 - EnvironmentPostProcessor

Environment准备好之后,会发布EnvironmentPrepared事件,
ConfigFileApplicationListener接收到该事件并处理,将属性源加载到Environment.
经历如下步骤

  • File------------>Resource------------>PropertySource--------------->Environment
  • ResourceLoader ----> PropertySourceLoader ----->ConfigFileApplicationListener中的loader:挂载到Environment

自定义属性源有两种比较简单的方式:

  1. 实现EnvironmentPostProcessor接口
  2. 实现PropertySourceLoader接口
    然后在META-INF/spring.factories添加相应配置

1、实现EnvironmentPostProcessor接口

该接口中仅含有一个方法:
void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application)

属性从哪里加载,怎么加载,可以自己实现,几乎没有任何限制,只要经过处理,最后能变成Key:Value形式的都可以,如redis、http、数据库、json,xml等。

利用这种方式配合@RefreshScope可以实现动态刷新配置
  • 只需要实现该接口时,定义一个线程去轮询配置源文件,获取配置修改并将其写入到PropertySource中的Properties中;再通过@RefreshScope声明Bean作用域,每次获取Bean时重新创建Bean

  • 关键点: 新线程轮询处理+ PropertySource中的Properties(Properties要被该线程使用以修改key-value),实现Environment不变但是其中的k-v动态的发生了变化***

以Properties类型文件为例,如下所示:

public class HelloEnvironmentPostProcessor implements EnvironmentPostProcessor {

    /**
     * 属性文件路径
     */
    public static final String EXTENSION_FILE_PATH = "C:\\Users\\Administrator\\Desktop\\hello.properties";

    /**
     * 可以加载任意来源的属性
     * @param environment
     * @param application
     */
    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        try {
            Properties properties = new Properties();
            properties.load(new FileInputStream(EXTENSION_FILE_PATH));
            //环境名称随意取,但尽量不能和其他环境名称相同,避免不生效
            PropertiesPropertySource propertySource = new   PropertiesPropertySource("environmentPostProcessor", properties);
            environment.getPropertySources().addLast(propertySource);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在resources下新建META-INF文件夹,再创建spring.factories(文件名不能修改)文件。

org.springframework.boot.env.EnvironmentPostProcessor=com.wit.sb.studysb.web.config.HelloEnvironmentPostProcessor

其中HelloEnvironmentPostProcessor为实现了EnvironmentPostProcessor接口的全类名。
配置文件内容如下图所示:
在这里插入图片描述

2、实现PropertySourceLoader接口

  • 该方式是在ConfigFileApplicationListener内部处理的

  • 该接口中含有两个方法:

  1. String[] getFileExtensions()
  2. List<PropertySource<?>> load(String name, Resource resource) throws IOException
  • 该种方法的有些许限制:
    1、文件必须放在classpath下
    2、文件名必须为application,但文件后缀没有限制
    3、getFileExtensions接口返回的文件后缀不能带有.(扩展名不含.)

  • 注意:可以利用spring.config.location或者spring.config.additional-location配置其他位置或者网络路径加载Resource,再利用PropertySourceLoader加载PropertySource

该方式限制较多,可能使用比较不方便,不建议使用。

总结:

1、第二种方式在第一种方式前执行
2、第二种方式限制较多,可以优先考虑第一种方式。
3、这两方式加载的时候,日志系统还未完成初始化。由下图可以看出,故只能通过System.out.print打印执行顺序。

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

推荐阅读更多精彩内容