Spring Cloud 配置管理 Spring Cloud Config_spring.cloud.config-CSDN博客

本文链接：https://blog.csdn.net/Flying_Fish_roe/article/details/144721793

Spring Cloud 配置管理：使用 Spring Cloud Config 构建动态配置中心

在微服务架构中，应用配置的集中化管理是提升开发效率和运维能力的重要实践。Spring Cloud Config 是 Spring Cloud 提供的一款强大的配置管理工具，支持集中管理应用配置文件，并实现动态刷新。它能够通过远程存储（如 Git）管理配置，并为分布式系统提供统一的配置管理能力。

一、Spring Cloud Config 的基本概念

核心组件
Spring Cloud Config 包含以下两部分：
- Config Server：集中管理配置文件并向客户端提供配置。
- Config Client：从 Config Server 获取配置并加载到应用中。
特点
- 集中化管理：将配置存储于远程仓库（如 Git、数据库）。
- 多环境支持：支持基于环境的配置切换（如开发、测试、生产）。
- 动态刷新：与 Spring Actuator 集成，实现配置的实时刷新。
应用场景
- 微服务架构中，各服务共享统一的配置。
- 不同环境（开发、测试、生产）下的配置分离管理。
- 动态调整运行时参数。

二、Spring Cloud Config 的实现步骤

1. 配置中心服务端（Config Server）

创建 Config Server 项目

添加依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>

启动类：
在主启动类中添加 @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
          default-label: main

uri：指定存储配置文件的 Git 仓库地址。
default-label：设置分支名称（默认 main 或 master）。

仓库结构示例：

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

启动 Config Server：启动后访问 http://localhost:8888/service-user-dev.yml 验证服务是否正常。

2. 配置客户端（Config Client）

创建 Config Client 项目

添加依赖：

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

配置文件（bootstrap.yml）：
在客户端项目中配置连接 Config Server：
```
spring:
  application:
    name: service-user
  cloud:
    config:
      uri: http://localhost:8888
      profile: dev
```
- name：客户端服务名称。
- profile：指定环境（如 dev、prod）。
加载远程配置：
Spring Boot 会在启动时自动加载 Config Server 中的配置，并覆盖本地配置。

使用配置：
配置加载后，可直接通过 @Value 注解或 @ConfigurationProperties 使用：

@RestController
public class ConfigController {
    @Value("${example.property}")
    private String exampleProperty;

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

3. 动态刷新配置

添加 Actuator 依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

开启刷新功能：
在客户端项目中添加 spring.cloud.config.refresh 配置：

management:
  endpoints:
    web:
      exposure:
        include: refresh

刷新接口：
调用 POST /actuator/refresh 触发配置刷新，更新后的配置会立即生效。

三、进阶功能与配置

1. 加密敏感信息

在实际项目中，配置文件可能包含数据库密码、API 密钥等敏感信息。Spring Cloud Config 提供了加密支持。

添加依赖：

<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-rsa</artifactId>
</dependency>

生成密钥对：
使用以下命令生成密钥对：

keytool -genkeypair -alias config-server-key -keyalg RSA -keysize 2048 -dname "CN=ConfigServer,OU=Dev,O=Company,L=City,S=State,C=Country" -keystore config-server.jks -storepass yourpassword

配置加密支持：
在 Config Server 中添加加密密钥配置：

encrypt:
  key-store:
    location: classpath:config-server.jks
    password: yourpassword
    alias: config-server-key

加密敏感信息：
使用 /encrypt 接口加密敏感数据，并替换配置文件中的明文：
```
example.password: "{cipher}encrypted-text"
```
客户端自动解密：
Spring Cloud Config 会在获取配置时自动解密。

2. 本地文件存储

除了 Git 仓库，Config Server 也支持本地文件存储。

配置示例：

spring:
  cloud:
    config:
      server:
        native:
          search-locations: file:///path/to/config

将配置文件放置于指定目录，启动服务后即可提供配置管理。

3. 高可用配置

为避免 Config Server 单点故障，可以通过集群方式实现高可用性。

配置多个 Config Server 实例，并注册到服务发现（如 Eureka）。

在客户端配置中使用服务名连接：

spring:
  cloud:
    config:
      uri: http://config-server/

四、Spring Cloud Config 的最佳实践

分环境管理
- 使用环境后缀（如 -dev、-prod）区分配置文件。
- 避免在生产环境暴露敏感信息。
动态刷新策略
- 对频繁变更的配置启用动态刷新。
- 配置不可频繁变更的参数应避免使用动态刷新。
配置文件规范
- 避免将配置文件过度复杂化，推荐按功能模块划分。
- 公共配置应放置于 application.yml 或 application.properties。
日志与监控
- 开启 Config Server 的访问日志，记录配置请求。
- 定期检查配置文件是否存在潜在问题。
加密与安全
- 敏感信息使用加密方式存储。
- 配置服务器应启用安全认证，限制未经授权的访问。