使用 Consul 进行分布式配置

Consul 提供了一个 Key/Value Store 来存储配置和其他元数据。Spring Cloud Consul Config 是 Config Server 和 Client 的替代方案。在特殊的 “bootstrap” 阶段，将 Configuration 加载到 Spring Environment 中。默认情况下，Configuration 存储在文件夹中。根据应用程序的名称和模拟 Spring Cloud Config 解析属性顺序的活动配置文件创建多个实例。例如，名称为“testApp”且配置文件为“dev”的应用程序将创建以下属性源：/configPropertySourcespring-doc.cn

config/testApp,dev/
config/testApp/
config/application,dev/
config/application/

最具体的属性源位于顶部，最不具体的属性源位于底部。文件夹中的属性适用于使用 consul 进行配置的所有应用程序。文件夹中的属性仅适用于名为 “testApp” 的服务实例。config/applicationconfig/testAppspring-doc.cn

当前在应用程序启动时读取配置。发送 HTTP POST 将导致重新加载配置。Config Watch 还会自动检测更改并重新加载应用程序上下文。/refreshspring-doc.cn

如何激活

要开始使用 Consul 配置，请使用具有 group 和 artifact id 的 starter 。有关使用当前 Spring Cloud Release Train 设置构建系统的详细信息，请参阅 Spring Cloud 项目页面。org.springframework.cloudspring-cloud-starter-consul-configspring-doc.cn

Spring Boot Config 数据导入

Spring Boot 2.4 引入了一种通过属性导入配置数据的新方法。这是现在从 Consul 获取配置的默认方式。spring.config.importspring-doc.cn

要选择性地连接到 Consul，请在 application.properties 中设置以下内容：spring-doc.cn

application.properties
spring.config.import=optional:consul:

这将连接到默认位置“http://localhost:8500”的 Consul 代理。如果删除前缀，如果 Consul Config 无法连接到 Consul，将导致 Consul Config 失败。要更改 Consul Config 的连接属性，请将主机/端口对 set 和 or 添加到语句中，例如 .import 属性中的位置优先于 host 和 port 属性。optional:spring.cloud.consul.hostspring.cloud.consul.portspring.config.importspring.config.import=optional:consul:myhost:8500spring-doc.cn

Consul Config 将尝试根据 （默认为属性的值） 和 （默认为 ） 从四个自动上下文中加载值。如果要指定上下文而不是使用计算的上下文，则可以将该信息添加到语句中。spring.cloud.consul.config.namespring.application.namespring.cloud.consul.config.default-contextapplicationspring.config.importspring-doc.cn

application.properties
spring.config.import=optional:consul:myhost:8500/contextone;/context/two

这将选择性地仅从 和 加载配置。/contextone/context/twospring-doc.cn

通过 .bootstrapspring.config.import

定制

Consul Config 可以使用以下属性进行自定义：spring-doc.cn

spring:
  cloud:
    consul:
      config:
        enabled: true
        prefix: configuration
        defaultContext: apps
        profileSeparator: '::'
如果您已设置 或 、 或 included ，则需要将上述值放在 中，而不是 中。spring.cloud.bootstrap.enabled=truespring.config.use-legacy-processing=truespring-cloud-starter-bootstrapbootstrap.ymlapplication.yml

  • enabled将此值设置为 “false” 将禁用 Consul 配置spring-doc.cn

  • prefix设置配置值的基文件夹spring-doc.cn

  • defaultContext设置所有应用程序使用的文件夹名称spring-doc.cn

  • profileSeparator设置用于分隔属性源中配置文件名称的分隔符的值 files filesspring-doc.cn

Config 监视

Consul Config Watch 利用 consul 监视键前缀的能力。Config Watch 会进行阻止 Consul HTTP API 调用，以确定当前应用程序的任何相关配置数据是否已更改。如果有新的配置数据，则会发布 Refresh Event。这相当于调用 actuator 端点。/refreshspring-doc.cn

要更改调用 Config Watch 的频率，请更改 。默认值为 1000，以毫秒为单位。延迟是上一个调用结束和下一个调用开始之后的时间量。spring.cloud.consul.config.watch.delayspring-doc.cn

要禁用 Config Watch 集 。spring.cloud.consul.config.watch.enabled=falsespring-doc.cn

手表使用 Spring 来安排对 consul 的调用。默认情况下，它是 a 为 1 的 a。要更改 ，请创建一个以 constant 命名的 Bean。TaskSchedulerThreadPoolTaskSchedulerpoolSizeTaskSchedulerTaskSchedulerConsulConfigAutoConfiguration.CONFIG_WATCH_TASK_SCHEDULER_NAMEspring-doc.cn

YAML 或具有 Config 的属性

以 YAML 或 Properties 格式存储 blob 属性可能比单个键/值对存储更方便。将属性设置为 或 。例如，要使用 YAML：spring.cloud.consul.config.formatYAMLPROPERTIESspring-doc.cn

spring:
  cloud:
    consul:
      config:
        format: YAML
如果您已设置 或 、 或 included ，则需要将上述值放在 中，而不是 中。spring.cloud.bootstrap.enabled=truespring.config.use-legacy-processing=truespring-cloud-starter-bootstrapbootstrap.ymlapplication.yml

YAML 必须在 consul 中的相应 key 中设置。使用键上方的默认值将如下所示：dataspring-doc.cn

config/testApp,dev/data
config/testApp/data
config/application,dev/data
config/application/data

您可以将 YAML 文档存储在上面列出的任何键中。spring-doc.cn

您可以使用 更改数据键。spring.cloud.consul.config.data-keyspring-doc.cn

git2consul 和 Config

git2consul 是一个 Consul 社区项目，用于将文件从 git 存储库加载到 Consul 中的各个密钥。默认情况下，键的名称是文件的名称。YAML 和 Properties 文件分别支持文件扩展名 和 。将属性设置为 。例如：.yml.propertiesspring.cloud.consul.config.formatFILESspring-doc.cn

bootstrap.yml
spring:
  cloud:
    consul:
      config:
        format: FILES

给定 中的以下键，配置文件和应用程序名称 ：/configdevelopmentfoospring-doc.cn

.gitignore
application.yml
bar.properties
foo-development.properties
foo-production.yml
foo.properties
master.ref

将创建以下属性源：spring-doc.cn

config/foo-development.properties
config/foo.properties
config/application.yml

每个键的值都需要是格式正确的 YAML 或 Properties 文件。spring-doc.cn

快速失败

在某些情况下（如本地开发或某些测试场景），如果 consul 不可用于配置，则不会失败可能很方便。设置将导致 configuration module 记录警告而不是抛出异常。这将允许应用程序继续正常启动。spring.cloud.consul.config.fail-fast=falsespring-doc.cn

如果您已设置 或 、 或 included ，则需要将上述值放在 中，而不是 中。spring.cloud.bootstrap.enabled=truespring.config.use-legacy-processing=truespring-cloud-starter-bootstrapbootstrap.ymlapplication.yml