Spring Cloud Config 动态刷新

Spring Cloud Config 动态刷新是指在配置发生变化时，客户端应用程序能够自动获取新的配置，而无需重启服务。这种能力对于微服务架构非常重要，因为它允许你在不中断服务的情况下进行配置更新。以下是关于如何使用 Spring Cloud Config 实现动态刷新的详细步骤。

步骤 1: 设置 Config Server

1. 创建 Config Server 项目:

   • 创建一个新的 Spring Boot 项目。
   • 添加 spring-cloud-config-server 依赖。

2. 配置 Config Server:

   • 在 application.yml 或 application.properties 文件中配置 Config Server 以指向一个外部存储系统，通常是 Git 仓库。
   • 下面是一个简单的配置示例：

   spring:
     cloud:
       config:
         server:
           git:
             uri: https://github.com/your-org/your-config-repo.git
             default-label: main
             search-paths: /config-data
   

   这里指定了 Git 仓库的 URI、默认分支（main）和搜索路径（/config-data）。

3. 启动 Config Server:

   • 运行你的 Config Server 应用程序。

步骤 2: 创建配置文件

1. 创建配置文件:

   • 在你的 Git 仓库中创建配置文件。
   • 常见的命名约定是 {application}-{profile}.yml 或 {application}-{profile}.properties。
   • 例如，对于名为 myapp 的应用在开发环境下的配置文件，你可以命名为 myapp-dev.yml。

2. 配置示例:

   • 创建一个简单的配置文件示例：

   # myapp-dev.yml
   spring:
     datasource:
       url: jdbc:mysql://localhost:3306/mydb_dev
       username: user_dev
       password: password_dev
   

步骤 3: 配置 Config Client

1. 添加依赖:

   • 在客户端应用的 pom.xml 或 build.gradle 文件中添加 spring-cloud-starter-config 依赖。

2. 配置客户端应用:

   • 配置客户端应用连接到 Config Server。
   • 通常在 bootstrap.yml 或 bootstrap.properties 文件中进行配置，因为这些文件会在 Spring Boot 应用程序加载之前读取。
   • 下面是一个配置示例：

   spring:
     cloud:
       config:
         uri: http://localhost:8888
         fail-fast: true
         enabled: true
         name: myapp
         profile: dev
         label: main
   

   这里指定了 Config Server 的 URL、应用名称、环境配置文件、Git 分支等。

3. 使用配置:

   • 你可以在你的应用程序代码中直接使用配置属性，Spring 会自动注入这些配置。
   • 例如，你可以使用 @Value 注解或通过 Environment 或 ConfigurableEnvironment 来访问配置属性。

步骤 4: 启用 Spring Cloud Bus

1. 添加 Spring Cloud Bus 依赖:

   • 在客户端应用的 pom.xml 文件中添加 spring-cloud-starter-bus-amqp（如果使用 RabbitMQ）或 spring-cloud-starter-bus-redis（如果使用 Redis）等依赖。

2. 配置 Spring Cloud Bus:

   • 在客户端应用的 bootstrap.yml 文件中激活 Spring Cloud Bus。
   • 下面是一个配置示例：

   spring:
     cloud:
       bus:
         enabled: true
       config:
         uri: http://localhost:8888
         fail-fast: true
         enabled: true
         name: myapp
         profile: dev
         label: main
         server:
           refresh: true
   

   这里激活了 Spring Cloud Bus，并启用了配置刷新功能。

3. 配置消息中间件:

   • 如果使用 RabbitMQ 或 Redis，还需要配置相应的消息中间件。
   • 例如，对于 RabbitMQ，你可以在 application.yml 中配置连接信息：

   spring:
     rabbitmq:
       host: localhost
       port: 5672
       username: guest
       password: guest
   

步骤 5: 动态刷新配置

1. 更改配置文件:

   • 更改 Git 仓库中的配置文件。
   • 例如，你可以更新 myapp-dev.yml 文件中的某个属性。

2. 提交更改:

   • 将更改提交到 Git 仓库。

3. 触发刷新:

   • 一旦更改被提交到 Git 仓库，Config Server 会检测到配置文件的变化，并通过 Spring Cloud Bus 发送一个刷新事件。
   • 客户端应用会监听这个事件，并自动刷新它们的配置。

4. 验证配置:

   • 你可以通过访问客户端应用的 REST API 或使用日志输出来验证配置是否已经成功刷新。

示例代码

Config Server 配置示例（application.yml）:

spring:
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-org/your-config-repo.git
          default-label: main
          search-paths: /config-data

Config Client 配置示例（bootstrap.yml）:

spring:
  cloud:
    bus:
      enabled: true
    config:
      uri: http://localhost:8888
      fail-fast: true
      enabled: true
      name: myapp
      profile: dev
      label: main
      server:
        refresh: true

Config Client 主类示例：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
@RefreshScope // 使控制器能够响应配置刷新
public class ConfigClientApplication {

    private final String message;

    public ConfigClientApplication(org.springframework.beans.factory.annotation.Value("${message}") String message) {
        this.message = message;
    }

    @GetMapping("/config")
    public String getConfig() {
        return message;
    }

    public static void main(String[] args) {
        SpringApplication.run(ConfigClientApplication.class, args);
    }
}

通过以上步骤，你已经设置了一个支持动态刷新配置的 Spring Cloud Config 架构。当你更改 Git 仓库中的配置文件并提交更改时，客户端应用会自动接收到新的配置。如果你有任何具体的问题或需要更深入的指导，请随时告诉我！