Spring使用EnvironmentPostProcessor自定义启动配置项

EnvironmentPostProcessor

使用该接口可以在项目启动时,修改或者添加一些自定义的环境配置;

Environment

spring中对环境的抽象(包含环境变量,系统信息以及用户信息),可以使用ApplicationContext.getEnvironment();获取到。使用Environment.getProperty(“key”),获取环境变量。
但一般情况下很少直接使用Environment,在日常的SpringBoot编程中会使用到@Value("${}")来获取到环境变量里的值;
还可以通过Environment.getActiveProfiles()获取当前的环境Profile

PropertySource

spring中对属性的抽象,可以使用该接口的实现自定义一些环境属性变量,通过 Environment.getPropertySources().addFirst(PropertySource);或者 Environment.getPropertySources().addLast(PropertySource);当使用addBefore()时添加的环境属性优先级高,当和已经有的环境变量重复时,会覆盖已经有的环境变量。相反,会被已经有的环境变量覆盖;
另外还有addBefore(String relativePropertySourceName,PropertySource<?> propertySource); addAfter(String relativePropertySourceName,PropertySource<?> propertySource);

PropertySourceLoader

当要添加的属性变量在配置文件中时,可以使用PropertySourceLoader.load(String name,Resource resource);获取List(PropertySource<?>);
实现类有:
YamlPropertySourceLoader;
PropertiesPropertySourceLoader;

Resource

spring 对资源的抽象;实现类有:

  • ClassPathResource (常用)
  • ServletContextResource
  • UrlResource

示例代码:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import java.io.IOException;

public class CustomEnvironmentConfig implements EnvironmentPostProcessor {
    
    private static Logger log = LoggerFactory.getLogger(CustomEnvironmentConfig.class);
    private final YamlPropertySourceLoader loader = new YamlPropertySourceLoader();
    private static final String YML_FILE_NAME = "routerAdapter";
    private static final String YML_FILE_TYPE = "yml";
    private static final String YML_FILE_PATH = "config/";

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        String sourcePath = YML_FILE_PATH + YML_FILE_NAME + "." + YML_FILE_TYPE;
        log.info(sourcePath);
        String sourceName = YML_FILE_NAME;
        Resource resource = new ClassPathResource(sourcePath);
        PropertySource<?> propertySource = null;
        if(resource.exists()) {
            try {
                propertySource = this.loader.load(sourceName,resource).get(0);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        environment.getPropertySources().addLast(propertySource);
        
        String[] activeProfiles = environment.getActiveProfiles();
        String active = activeProfiles[0];
        String activeSourcePath = YML_FILE_PATH + YML_FILE_NAME + "-" + active + "." + YML_FILE_TYPE;
        String activeSourceName = YML_FILE_NAME + "-" + active;
        Resource activeResource = new ClassPathResource(activeSourcePath);
        PropertySource<?> activePropertySource = null;
        if(resource.exists()) {
            try {
                activePropertySource = this.loader.load(activeSourceName,activeResource).get(0);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        environment.getPropertySources().addBefore(propertySource.getName(),activePropertySource);
    }
}

进行配置

写完配置类后并不能直接生效,需要进行下一步的配置:
在META-INF的spring.factories中添加

org.springframework.boot.env.EnvironmentPostProcessor=\
com.cheng.boot.config.CustomEnvironmentConfig
  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Spring Boot中,可以使用EnvironmentPostProcessor来修改应用程序的环境。要使用EnvironmentPostProcessor,需要遵循以下步骤: 1. 创建一个类并实现EnvironmentPostProcessor接口。 2. 在META-INF/spring.factories文件中注册EnvironmentPostProcessor实现类。 3. 在实现类中重写postProcessEnvironment方法,并在其中修改环境。 下面是一个简单的示例,演示如何在Spring Boot中使用EnvironmentPostProcessor: ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.env.EnvironmentPostProcessor; import org.springframework.core.env.ConfigurableEnvironment; public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor { @Override public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { // 在这里修改环境 environment.getPropertySources().addLast(new MyPropertySource()); } } ``` 在上面的示例中,我们创建了一个名为MyEnvironmentPostProcessor的类,并实现了EnvironmentPostProcessor接口。在postProcessEnvironment方法中,我们可以修改环境。在这个例子中,我们添加了一个自定义的属性源。 要注册EnvironmentPostProcessor实现类,需要在META-INF/spring.factories文件中添加以下内容: ``` org.springframework.boot.env.EnvironmentPostProcessor=com.example.MyEnvironmentPostProcessor ``` 这将告诉Spring Boot在启动时加载MyEnvironmentPostProcessor类,并调用postProcessEnvironment方法。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值