Matarialize中文社区-Spring Cloud Config

Spring Cloud Config

~~情~非~ 2024-07-30 16:59:18

248 Spring Cloud Config 专栏

Spring Cloud Config 是 Spring Cloud 生态系统中的一个核心组件，用于集中化和动态管理分布式系统的配置。它允许开发者将应用程序的配置存储在远程配置服务器上，并支持多种存储后端，如 Git、SVN、本地文件系统、数据库等。通过使用 Spring Cloud Config，开发者可以实现配置的集中管理、版本控制和动态更新，而无需重启应用程序。

以下是 Spring Cloud Config 的主要功能及其详细使用说明，包括示例代码：

Spring Cloud Config 的主要功能

集中化配置管理：所有服务的配置都存储在一个中央配置服务器中，方便管理和维护。
配置版本控制：配置存储在支持版本控制的存储库（如 Git）中，能够轻松回滚到之前的版本。
环境隔离：支持不同环境（如开发、测试、生产）的配置隔离。
动态配置刷新：借助 Spring Cloud Bus 和 Actuator，可以在不重启应用的情况下动态刷新配置。
加密和解密：支持对敏感信息进行加密存储和解密使用。

Spring Cloud Config 使用示例

Spring Cloud Config 由两个部分组成：配置服务器和配置客户端。下面我们详细介绍如何创建和使用这两个组件。

1. 配置服务器

配置服务器负责从远程存储库获取配置信息，并通过 REST API 向客户端提供这些配置。

创建配置服务器

创建 Spring Boot 项目

使用 Spring Initializr 创建一个新的 Spring Boot 项目，选择以下依赖：
- Spring Web
- Spring Cloud Config Server

配置服务器代码

在项目中，添加一个主类，并使用 @EnableConfigServer 注解来启用配置服务器功能。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {

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

配置文件 application.yml

配置文件中定义配置服务器的端口和远程存储库的位置。

server:
  port: 8888

spring:
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-repo/config-repo  # Git 仓库地址
          # clone-on-start: true   # 可选：启动时克隆仓库
          # search-paths: /config  # 可选：指定配置文件目录

在这里，我们假设配置文件存储在 Git 仓库中。你需要将 your-repo 替换为实际的 Git 仓库地址。

配置文件结构

Git 仓库中配置文件的组织结构如下：

config-repo/
  ├── application.yml
  ├── application-dev.yml
  ├── application-prod.yml
  ├── my-service.yml
  └── my-service-dev.yml

application.yml：默认配置文件，适用于所有应用和环境。
application-{profile}.yml：环境特定的配置文件，如开发（dev）、生产（prod）。
{service-name}.yml：特定服务的默认配置文件。
{service-name}-{profile}.yml：特定服务的环境配置文件。

2. 配置客户端

配置客户端从配置服务器获取配置信息，并应用于 Spring Boot 应用程序。

创建配置客户端

创建 Spring Boot 项目

使用 Spring Initializr 创建一个新的 Spring Boot 项目，选择以下依赖：
- Spring Web
- Spring Boot Actuator
- Spring Cloud Config Client

配置客户端代码

在项目中，添加一个简单的控制器，用于显示配置信息。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RefreshScope
public class MessageRestController {

    @Value("${message:Default message}")
    private String message;

    @GetMapping("/message")
    public String getMessage() {
        return this.message;
    }
}

@RefreshScope 注解用于支持动态刷新配置。当配置更新时，标注此注解的 Bean 会自动更新。

配置文件 bootstrap.yml

配置客户端的 bootstrap.yml 用于指定配置服务器的地址和应用名称。
```
spring:
  application:
    name: my-service
  cloud:
    config:
      uri: http://localhost:8888
      label: master  # 可选：指定 Git 分支
      profile: dev   # 可选：指定环境
```
- spring.application.name：应用名称，用于从配置服务器获取对应的配置文件。
- spring.cloud.config.uri：配置服务器的地址。
- spring.cloud.config.label：可选，指定 Git 分支。
- spring.cloud.config.profile：可选，指定环境配置。

动态刷新配置

使用 Spring Cloud Bus 和 Actuator，可以实现配置的动态刷新。

添加依赖

在客户端的 pom.xml 中，添加 Spring Cloud Bus 依赖。

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>

或者使用 Kafka 作为消息总线：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-kafka</artifactId>
</dependency>

配置消息总线

在 bootstrap.yml 中，配置消息总线的属性：

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

management:
  endpoints:
    web:
      exposure:
        include: refresh, bus-refresh  # 公开 refresh 和 bus-refresh 端点

或者使用 Kafka ：

spring:
  kafka:
    bootstrap-servers: localhost:9092

management:
  endpoints:
    web:
      exposure:
        include: refresh, bus-refresh

刷新配置

使用 POST 请求触发配置刷新：
```
curl -X POST http://localhost:8080/actuator/refresh
```
或使用消息总线刷新所有服务：
```
curl -X POST http://localhost:8080/actuator/bus-refresh
```
这将触发消息总线，通过消息代理（如 RabbitMQ 或 Kafka）通知所有服务刷新其配置。