Spring Cloud Config

什么是 Spring Cloud Config

Spring Cloud Config 是一个支持分布式系统中的外部配置管理的工具。它提供了服务器端和客户端两个组件，用于集中管理应用程序的配置。Config Server 负责从存储库（如 Git、SVN 等）中获取配置文件，并将其提供给客户端应用程序。客户端则通过访问 Config Server 来获取其所需的配置信息。

为什么使用 Spring Cloud Config

集中化配置管理

在微服务架构中，随着服务数量的增加，管理每个服务的配置变得繁杂和困难。Spring Cloud Config 使得开发者能够将所有服务的配置信息集中在一个地方进行管理。

动态刷新配置

Spring Cloud Config 支持动态刷新配置，这意味着在不重启应用程序的情况下可以更新配置信息。这对于需要频繁更改配置但又不能频繁重启服务的系统来说非常有用。

配置版本控制

通过使用版本控制系统（如 Git）来存储配置，Spring Cloud Config 可以很容易地追踪和回滚任何对配置信息的更改，从而提高了安全性和可追溯性。

环境隔离

它支持根据不同环境（如开发、测试、生产）加载不同的配置信息，从而保证同一套代码可以安全地部署到多个环境中。

如何使用 Spring Cloud Config

准备工作

  1. 创建配置存储库：首先，需要选择并设置一个版本控制系统来存放你的配置信息，如 Git 仓库。
  2. 编写配置文件：在仓库中创建用于定义各个微服务及其环境（如 dev、prod）的具体配置信息文件。

设置 Spring Cloud Config Server

  1. 创建一个新的 Spring Boot 应用：添加依赖 spring-cloud-config-server。

  2. 启用 Config Server：在主类上添加 @EnableConfigServer 注解。

  3. 指定存储库位置：在 application.yml 或 application.properties 中设置仓库 URL 和其他必要信息。

    1
    2
    3
    4
    5
    6
    spring:
      cloud:
        config:
          server:
            git:
              uri: https://github.com/your-repo/config-repo

设置 Spring Cloud Config Client

  1. 为每个需要使用配置信息的微服务引入依赖：spring-cloud-starter-config。

  2. 指定 Config Server 地址：在每个服务的 bootstrap.yml 中定义 config server 的地址。

    1
    2
    3
    4
    5
    6
    spring:
      application:
        name: your-service-name
      cloud:
        config:
          uri: http://localhost:8888

  3. 加载和使用配置：启动客户端后，它将自动连接到指定的服务器并加载与其名称匹配的配置文件。

动态刷新机制

为了实现动态刷新，结合使用 spring-boot-starter-actuator 和 @RefreshScope 注解。在需要动态刷新的 bean 上添加 @RefreshScope 注解，并借助 Actuator 的 /refresh 端点来触发刷新操作。

1
2
3
4
5
6
7
8
9
10
11
@RefreshScope
@RestController
public class MyController {
    @Value("${my.config.value}")
    private String configValue;
    
    @GetMapping("/config")
    public String getConfigValue() {
        return this.configValue;
    }
}

至此，您已成功完成了 Spring Cloud Config 的基础设置，可以开始享受集中化和动态化配置带来的便利与效率提升。