自定义属性源 - 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接口
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容