Spring boot读取外部化配置的方法

目录

• 1. Properties / YAML
• 1.1 Environment
• 1.2 Value注解
• 2. 自定义Properties文件
• 3. 其他命令参数
• 总结

这篇文章我们主要讨论 Spring Boot 的外部化配置功能，该功能主要是通过外部的配置资源实现与代码的相互配合，来避免硬编码，提供应用数据或行为变化的灵活性。本文主要记录读取外部化配置的几种常见的操作方式，相关原理不在此记录。

1. Properties / YAML

我们一般会将相关配置信息写在Properties / YAML文件中，然后在通过某种方式来进行数据的获取。

比如下图我就定义了三个参数：

1.1 Environment

首先我们可以通过Environment来进行外部配置信息的加载（Spring Boot中的所有外部化配置都会加载到Environment中）。

首先我们直接通过Autowired注入Environment：

@Autowired
Environment environment;

然后直接获取数据信息即可。

@RestController
public class ConfigController {

    @Autowired
    Environment environment;

    @GetMapping("/env")
    public String env() {
        return environment.getProperty("name") + "\n";
    }
}

1.2 Value注解

第二种方式就是我们比较常用的注解方式，直接通过注解写入相应的KEY，获取对应的value。如果没有KEY值则启动的时候会报错。

@Value("${name}")
private String name;

2. 自定义Properties文件

有的时候可能我们的外部化配置不是写在application.properties中，而是写在一些自定义Properties中，那这个时候我们如何通过value注解获取其中的数据呢？

在上面说environment的时候，我们知道Spring Boot中的所有外部化配置都会加载到Environment中，我们可以在Spring boot构建environment之前对其进行相关的修改。

我们可以通过实现EnvironmentPostProcessor接口并重写postProcessEnvironment方法来对environment进行修改。

整体流程如下：

实现接口，重写方法

定义Properties，以及我们需要获取数据文件的名字。

解析文件将数据添加至environment中

public class CustomEnvironmentPostProcessor implements EnvironmentPostProcessor {

    private final Properties properties = new Properties();

    private String propertiesFile = "custom.properties";

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        Resource resource = new ClassPathResource(propertiesFile);
        environment.getPropertySources().addLast(loadProperties(resource));
    }

    private PropertySource<?> loadProperties(Resource resource) {
        if (!resource.exists()) {
            throw new RuntimeException("file not exist");
        }
        try {
            //custom.properties
            properties.load(resource.getInputStream());
            return new PropertiesPropertySource(resource.getFilename(), properties);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}

这个时候代码写好之后，我们可以通过value注解获取数据了吗？我们运行试试。（记得将application.properties中的数据清空）

这个时候我们会发现运行失败，没有找到对应key。这是为什么呢？这是由于以上都是我们对Spring boot功能的拓展，做这种功能拓展的时候，我们需要使用到我们的SPI机制，按照拓展规则去定义我们的拓展实现。这样才能使我们的拓展点生效。

这里和JAVA做SPI机制的实现不一样，之前做SPI都是创建的全类名文件，然后写对应的实现类，这边文件名需要定义为spring.factories。

org.springframework.boot.env.EnvironmentPostProcessor=\
  com.example.springbootzookeeper.CustomEnvironmentPostProcessor

这个时候我们重新运行项目，可以发现成功运行。

3. 其他命令参数

Spring boot 中我们是有很多种外部化配置的方式，比如环境变量、系统变量、命令行参数等。我们在下方演示一种类型的外部化配置：我们可以通过这种-D形式进行外部化配置。value注解后面的key对应-D后面的key。

@Value("${test}")
private String command;

总结

到此这篇关于Spring boot读取外部化配置的方法的文章就介绍到这了,更多相关Spring boot外部化配置内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！