Custom Environment Repositories

Spring Cloud Config 支持通过允许你创建和集成自定义 EnvironmentRepository 实现来增强其配置管理。这使得能够向你的应用程序添加唯一的配置源。实现 Ordered 接口并指定 getOrder 方法还允许你在复合配置设置中设置自定义存储库的优先级。如果没有这样做，则默认情况下自定义存储库的优先级最低。

Spring Cloud Config supports enhancing its configuration management by allowing you to create and integrate custom EnvironmentRepository implementations. This enables the addition of unique configuration sources to your application. Implementing the Ordered interface and specifying the getOrder method also lets you set the priority of your custom repository within a composite configuration setup. Without this, custom repositories are considered with the lowest priority by default.

以下是创建和配置自定义 EnvironmentRepository 的示例：

Below is an example of how to create and configure a custom EnvironmentRepository:

public class CustomConfigurationRepository implements EnvironmentRepository, Ordered {

    @Override
    public Environment findOne(String application, String profile, String label) {
        // Simulate fetching configuration from a custom source
        final Map<String, String> properties = Map.of(
            "key1", "value1",
            "key2", "value2",
            "key3", "value3"
        );
        Environment environment = new Environment(application, profile);
        environment.add(new PropertySource("customPropertySource", properties));
        return environment;
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

@Configuration
@Profile("custom")
public class AppConfig {
    @Bean
    public CustomConfigurationRepository customConfigurationRepository() {
        return new CustomConfigurationRepository();
    }
}

使用此设置，如果你在 Spring 应用程序的配置中激活 custom 配置文件，则自定义环境存储库将集成到配置服务器中。例如，在 application.properties 或 application.yml 中指定 custom 配置文件，如下所示：

With this setup, if you activate the custom profile within your Spring application’s configuration, your custom environment repository will be integrated into the configuration server. For instance, specifying the custom profile in your application.properties or application.yml as follows:

spring:
  application:
    name: configserver
  profiles:
    active: custom

现在，访问配置服务器：

Now, accessing the configuration server at:

http://localhost:8080/any-client/dev/latest

将返回来自自定义存储库的默认值，如下所示：

will return default values from the custom repository, as shown below:

{
  "name": "any-client",
  "profiles": ["dev"],
  "label": "latest",
  "propertySources": [
    {
      "name": "customPropertySource",
      "source": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      }
    }
  ]
}