Spring Cloud Config 使用教程

项目介绍

Spring Cloud Config 是 Spring Cloud 家族中最早的配置中心，适用于 Spring Cloud 项目。它通过简单的配置即可实现功能，支持将配置文件存储在多种存储系统中，如 Git、SVN、数据库等。Spring Cloud Config 提供了一种集中式管理配置文件的方式，使得配置的修改和更新更加方便和高效。

项目快速启动

以下是快速启动 Spring Cloud Config 的步骤，假设我们使用 GitHub 作为配置存储。

1. 创建 GitHub 仓库

在 GitHub 上创建一个新的仓库，用于存储配置文件。例如，创建一个名为 config-repo 的仓库。

2. 添加配置文件

在 config-repo 仓库中添加配置文件，例如 application.yml。

# application.yml
spring:
  profiles: dev
data:
  env: dev
  user:
    username: dev-user
    password: dev-password

3. 创建 Spring Boot 项目

创建一个新的 Spring Boot 项目，并添加以下依赖：

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

4. 配置 Spring Cloud Config Server

在 application.yml 中配置 Spring Cloud Config Server：

spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-username/config-repo.git
          username: your-github-username
          password: your-github-password
server:
  port: 8888

5. 启用 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);
    }
}

6. 启动服务

启动 Spring Boot 应用，访问 http://localhost:8888/application/default，应该能看到配置文件的内容。

应用案例和最佳实践

案例一：多环境配置管理

在实际开发中，通常需要为不同的环境（如开发、测试、生产）维护不同的配置。Spring Cloud Config 可以轻松实现这一点。

配置文件示例

在 config-repo 仓库中添加多个配置文件：

# application-dev.yml
data:
  env: dev
  user:
    username: dev-user
    password: dev-password

# application-prod.yml
data:
  env: prod
  user:
    username: prod-user
    password: prod-password

客户端配置

在客户端应用中，通过设置 spring.profiles.active 来选择不同的配置文件：

spring:
  profiles:
    active: dev
  cloud:
    config:
      uri: http://localhost:8888

案例二：动态刷新配置

Spring Cloud Config 支持动态刷新配置，无需重启应用即可使配置生效。

添加 Actuator 依赖

在客户端应用中添加 Actuator 依赖：

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

暴露刷新端点

在 application.yml 中暴露刷新端点：

management:
  endpoints:
    web:
      exposure:
        include: "refresh"

刷新配置

通过 POST 请求 http://localhost:8080/actuator/refresh 来刷新配置。

典型生态项目

Spring Cloud Config 通常与其他 Spring Cloud 组件一起使用，构建完整的微服务架构。