详解Spring Cloud Config采用Git存储时两种常用的配置策略

下面开始详细讲解"详解Spring Cloud Config采用Git存储时两种常用的配置策略"。

什么是Spring Cloud Config

Spring Cloud Config 是一个分布式系统中的外部配置管理工具，它支持客户端和服务器端的各种对象（例如称为“资源”的文本文件、Java属性文件或XML文件）的外部化存储，可以实现应用程序的配置和部署的隔离，这样我们就可以避免在每个环境中部署相同应用程序的多个实例时需要进行大量的重复劳动。

Git存储的优势

使用Git存储配置有许多的益处，比如：

• 版本控制和管理实际的配置文件；
• 可以跨团队和机器获取配置；
• 配置更改被完全记录下来；
• 使用Git等版本控制工具可以轻松管理多个不同环境下的配置。

Git存储时两种常用的配置策略

策略1：分支策略

在一个Git仓库下，我们可以创建不同的分支，每个分支代表着一个环境，例如开发环境、测试环境和生产环境等等。

我们可以将开发环境的配置文件存储在 dev 分支上，并将测试环境的配置文件存储在 test 分支上，然后将生产环境的配置文件存储在 prod 分支上。

当应用程序通过Spring Cloud Config从Git存储库中获取配置时，我们只需告诉它使用哪个分支即可。

下面是一个简单的示例：

spring:
  application:
    name: myapp
  cloud:
    config:
      uri: http://localhost:8888
      label: prod   # 表示从prod分支获取配置

策略2：目录策略

在Git存储库中，我们可以使用目录结构来将配置文件进行组织，例如：

myapp/
  dev.yml
  test.yml
  prod.yml

在这种情况下，当应用程序访问Spring Cloud Config时，我们需要指定在Git存储库中查找配置文件的路径。

下面是一个示例：

spring:
  application:
    name: myapp
  cloud:
    config:
      uri: http://localhost:8888
      name: myapp
      profile: prod   # 表示使用prod.yml配置文件
      label: master   # 分支名称

示例说明

我们现在展示两个示例来说明这两种策略是如何工作的。

示例1：分支策略

1. 在本地计算机上创建一个Git存储库。

2. 在Git存储库中创建3个分支：dev、test和prod。

3. 在每个分支上创建一个配置文件（例如config.yml），为每个文件设置不同的属性。

4. 配置Spring Cloud Config服务器，以便它可以从上述Git存储库中读取配置文件。

server:
port: 8888
spring:
cloud:
config:
server:
git:
uri: file:///path/to/repo # 填入Git存储库的本地文件路径
search-paths: '{profile}'
repos:
dev:
pattern: config-{profile}.yml
uri: ${spring.cloud.config.server.git.uri}
name: myapp
profile: dev
test:
pattern: config-{profile}.yml
uri: ${spring.cloud.config.server.git.uri}
name: myapp
profile: test
prod:
pattern: config-{profile}.yml
uri: ${spring.cloud.config.server.git.uri}
name: myapp
profile: prod
default-label: main

可以注意到，search-paths: '{profile}' 表示将会根据访问的环境自动获取对应的路径。

1. 构建一个使用Spring Cloud Config的Spring Boot应用程序，并在应用程序中指定要使用的配置文件和分支。

spring:
application:
name: myapp
cloud:
config:
uri: http://localhost:8888
label: dev

上述应用程序将使用dev分支上的配置文件来运行，并且 application.yml 中的属性将会被优先级更高的覆盖。

示例2：目录策略

1. 在本地计算机上创建一个Git存储库，并在存储库中创建一个名为 myapp 的目录。

2. 在上述目录中创建三个配置文件：dev.yml、test.yml和prod.yml。

3. 在每个文件中分别设置不同的属性。

4. 配置Spring Cloud Config服务器，使其能够从上述Git存储库中读取配置文件。

server:
port: 8888
spring:
cloud:
config:
server:
git:
uri: file:///path/to/repo # 填入Git存储库的本地文件路径
search-paths: '{profile}/**'
repos:
default:
pattern: '{application}/{profile}'
uri: ${spring.cloud.config.server.git.uri}
search-paths: '{profile}'
default-label: main

在上述配置文件中，search-paths: '{profile}/**' 将会自动匹配子目录中的文件，pattern: '{application}/{profile}' 中 {application} 代表应用程序名，{profile} 代表环境名。

1. 构建一个使用Spring Cloud Config的Spring Boot应用程序，并在应用程序中指定要使用的配置文件路径和分支：

spring:
application:
name: myapp
cloud:
config:
uri: http://localhost:8888
name: myapp
profile: prod
label: main

上述示例将使用prod.yml配置文件来运行，并在应用程序中指定 name: myapp，表示在Git存储库中查找 myapp 目录。

总结

上述两种配置策略都很实用，具体使用哪一种将取决于您自己的需求。无论哪种策略，都需要在Git存储库中创建和管理配置文件，并配置Spring Cloud Config服务器以从Git存储库中读取配置。最终，Spring Boot应用程序需要通过Spring Cloud Config来从配置服务器中获取它所需的配置。