【微服务】Spring Cloud Config解决的问题和案例

文章目录

- - 强烈推荐
  - 引言
  - 解决问题
  - - [1. 配置管理的集中化](#1. 配置管理的集中化)
    - [2. 配置的版本控制](#2. 配置的版本控制)
    - [3. 环境特定配置](#3. 环境特定配置)
    - [4. 配置的动态刷新](#4. 配置的动态刷新)
    - [5. 安全管理敏感数据](#5. 安全管理敏感数据)
    - [6. 配置的一致性](#6. 配置的一致性)
  - 组件
  - - [1. **配置服务器（Config Server）**](#1. 配置服务器（Config Server）)
    - [2. **配置客户端（Config Client）**](#2. 配置客户端（Config Client）)
  - 配置示例
  - - 配置服务器（application.yml）
    - 配置客户端（bootstrap.yml）
  - 工作原理
  - 示例场景
  - - [场景 1：多个环境配置管理](#场景 1：多个环境配置管理)
    - - 示例
      - [Git 仓库中的配置文件结构：](#Git 仓库中的配置文件结构：)
        
        [application.yml (通用配置)：](#application.yml (通用配置)：)
        
        [application-dev.yml (开发环境配置)：](#application-dev.yml (开发环境配置)：)
        
        [application-test.yml (测试环境配置)：](#application-test.yml (测试环境配置)：)
        
        [application-prod.yml (生产环境配置)：](#application-prod.yml (生产环境配置)：)
        
        配置客户端（bootstrap.yml）：
    - [场景 2：配置变更的自动传播](#场景 2：配置变更的自动传播)
    - - 示例
      - [更新前的 application-prod.yml：](#更新前的 application-prod.yml：)
        
        [更新后的 application-prod.yml：](#更新后的 application-prod.yml：)
        
        触发配置刷新
    - [场景 3：安全管理](#场景 3：安全管理)
    - - 示例
      - [Git 仓库中的配置文件：](#Git 仓库中的配置文件：)
        
        application.yml（使用加密值）：
        
        [配置服务器的 application.yml：](#配置服务器的 application.yml：)
        
        配置客户端（bootstrap.yml）：
        
        应用程序代码示例：
  - 常用的参数说明
  - - [配置服务器（Config Server）](#配置服务器（Config Server）)
    - - [Git 仓库配置](#Git 仓库配置)
      - 本地文件系统配置
    - [配置客户端（Config Client）](#配置客户端（Config Client）)
    - 示例配置文件
    - - 配置服务器（application.yml）
      - 配置客户端（bootstrap.yml）
  - 总结
  - 强烈推荐
  - 专栏集锦
  - 写在最后

强烈推荐

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到网站:人工智能

引言

Spring Cloud Config 是 Spring Cloud 套件中的一个工具，提供了在分布式系统中对外部化配置的服务器端和客户端支持。

解决问题

Spring Cloud Config 主要解决以下几个问题：

1. 配置管理的集中化

在一个分布式系统中，管理多个微服务的配置是一个挑战。Spring Cloud Config 提供了一个集中化的配置管理解决方案，将所有微服务的配置存储在一个中央仓库（例如 Git 仓库）中，从而简化了配置的管理和维护。

2. 配置的版本控制

通过将配置文件存储在 Git 等版本控制系统中，Spring Cloud Config 支持配置的版本控制。每次更改配置都会被记录，允许回滚到以前的版本。这对于追踪配置变更和恢复到稳定状态非常有用。

3. 环境特定配置

不同环境（如开发、测试、生产）可能需要不同的配置。Spring Cloud Config 支持根据环境动态加载配置文件，使得在不同环境中部署和运行应用程序更加方便和可靠。

4. 配置的动态刷新

Spring Cloud Config 支持在运行时动态刷新配置，而无需重新启动应用程序。这意味着当配置发生变化时，应用程序可以立即使用新的配置，从而减少停机时间和提高系统的灵活性。

5. 安全管理敏感数据

在配置文件中存储敏感数据（如密码、API 密钥）是一个安全风险。Spring Cloud Config 提供了加密和解密功能，确保敏感数据在传输和存储过程中是安全的。

6. 配置的一致性

在分布式系统中，确保所有服务使用相同的配置是一个挑战。Spring Cloud Config 提供了一个中央服务器来提供配置，确保所有服务从同一来源获取配置，从而保持配置的一致性。

组件

1. 配置服务器（Config Server）

配置服务器是一个集中管理所有环境中应用程序外部属性的地方。它从各种来源（最常见的是 Git 仓库）提供配置。

配置：

spring.cloud.config.server.git.uri 指定 Git 仓库的位置。
spring.cloud.config.server.git.clone-on-start 在服务器启动时克隆仓库。

2. 配置客户端（Config Client）

需要从配置服务器获取配置的应用程序充当配置客户端。它们通常是从配置服务器提取配置属性的 Spring Boot 应用程序。

配置：

spring.cloud.config.uri 指定配置服务器的位置。
spring.application.name 和 spring.profiles.active 帮助客户端获取适当的配置文件。

配置示例

配置服务器（application.yml）

server:
  port: 8888

spring:
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-repo/config-repo
          searchPaths: application, profile-specific
          clone-on-start: true

配置客户端（bootstrap.yml）

spring:
  cloud:
    config:
      uri: http://localhost:8888
  application:
    name: my-app
  profiles:
    active: development

工作原理

启动：
- 配置服务器克隆指定的 Git 仓库并提供配置文件。
- 配置客户端在启动时联系配置服务器以检索其配置属性。
配置检索 ：
- 配置客户端使用唯一的应用程序名称和配置文件（环境）进行标识。
- 配置服务器响应适用于该应用程序和配置文件的配置文件。
动态刷新 ：
- 使用 Spring Cloud Bus，客户端可以在不重启的情况下刷新其配置。通常通过向总线发送刷新事件来实现，这些事件会传播到所有客户端。

示例场景

场景 1：多个环境配置管理

在一个企业中，开发、测试、和生产环境需要不同的配置。通过 Spring Cloud Config，可以将这些配置存储在 Git 仓库中，并根据当前运行的环境动态加载相应的配置文件。

示例

假设有一个名为 my-app 的应用程序需要在开发、测试和生产环境中运行，每个环境都有不同的数据库连接配置。

Git 仓库中的配置文件结构：

config-repo/
  my-app/
    application.yml
    application-dev.yml
    application-test.yml
    application-prod.yml

application.yml (通用配置)：

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver

application-dev.yml (开发环境配置)：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/devdb
    username: devuser
    password: devpass

application-test.yml (测试环境配置)：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/testdb
    username: testuser
    password: testpass

application-prod.yml (生产环境配置)：

spring:
  datasource:
    url: jdbc:mysql://prod-db-server:3306/proddb
    username: produser
    password: prodpass

配置客户端（bootstrap.yml）：

spring:
  application:
    name: my-app
  profiles:
    active: dev  # 可根据环境修改为 dev, test, 或 prod
spring:
  cloud:
    config:
      uri: http://localhost:8888

当 my-app 在不同环境中启动时，它会根据 spring.profiles.active 动态加载相应的配置文件。

场景 2：配置变更的自动传播

假设在生产环境中需要更新某个服务的数据库连接字符串。使用 Spring Cloud Config，可以在 Git 仓库中更新配置文件，然后通知所有相关服务刷新配置，这样就可以在不中断服务的情况下应用新的配置。

示例

假设在生产环境中需要更新数据库连接字符串。

更新前的 application-prod.yml：

spring:
  datasource:
    url: jdbc:mysql://prod-db-server:3306/proddb
    username: produser
    password: prodpass

更新后的 application-prod.yml：

yaml复制代码spring:
  datasource:
    url: jdbc:mysql://new-prod-db-server:3306/proddb
    username: produser
    password: newprodpass

触发配置刷新

更新 Git 仓库中的配置文件。

发送 POST 请求到 Spring Cloud Bus 以刷新配置：

shell
复制代码
curl -X POST http://localhost:8080/actuator/bus-refresh

应用程序将自动获取新的配置，无需重启。

场景 3：安全管理

一个服务需要访问第三方 API，并且需要使用 API 密钥。将 API 密钥加密后存储在配置文件中，并使用 Spring Cloud Config 提供的解密功能来读取密钥，从而提高安全性。

示例

假设有一个名为 my-secure-app 的应用程序需要访问第三方 API，并且需要使用 API 密钥。

Git 仓库中的配置文件：

config-repo/
  my-secure-app/
    application.yml

application.yml（使用加密值）：

api:
  key: {cipher}AQBvcVzJzpI...

配置服务器的 application.yml：

encrypt:
  key: my-symmetric-key  # 对称密钥

配置客户端（bootstrap.yml）：

yaml复制代码spring:
  application:
    name: my-secure-app
spring:
  cloud:
    config:
      uri: http://localhost:8888

应用程序代码示例：

@RestController
public class ApiController {

    @Value("${api.key}")
    private String apiKey;

    @GetMapping("/api-key")
    public String getApiKey() {
        return apiKey;
    }
}

在这个示例中，API 密钥在 Git 仓库中是加密的，并且通过配置服务器和客户端的集成，在运行时自动解密并注入到应用程序中。

常用的参数说明

在使用 Spring Cloud Config 时，有一些常用的参数需要了解和配置。这些参数帮助你控制 Config Server 和 Config Client 的行为。以下是一些常用的参数及其说明：

配置服务器（Config Server）

Git 仓库配置

spring.cloud.config.server.git.uri:
- 说明: 指定 Git 仓库的 URI。
- 示例 : spring.cloud.config.server.git.uri=https://github.com/your-repo/config-repo
spring.cloud.config.server.git.clone-on-start:
- 说明: 在服务器启动时克隆 Git 仓库。
- 示例 : spring.cloud.config.server.git.clone-on-start=true
spring.cloud.config.server.git.searchPaths:
- 说明: 配置文件的搜索路径，可以指定多个路径。
- 示例 : spring.cloud.config.server.git.searchPaths=application,profile-specific
spring.cloud.config.server.git.username 和 spring.cloud.config.server.git.password:
- 说明: 用于访问受保护的 Git 仓库的凭证。
- 示例:
```
spring:
  cloud:
    config:
      server:
        git:
          username: your-username
          password: your-password
```
spring.cloud.config.server.git.default-label:
- 说明: 指定要使用的默认 Git 分支或标签。
- 示例 : spring.cloud.config.server.git.default-label=main

本地文件系统配置

spring.cloud.config.server.native.searchLocations:
- 说明: 指定本地文件系统中配置文件的位置。
- 示例 : spring.cloud.config.server.native.searchLocations=file:///path/to/config

配置客户端（Config Client）

spring.cloud.config.uri:
- 说明: 指定 Config Server 的 URI。
- 示例 : spring.cloud.config.uri=http://localhost:8888
spring.application.name:
- 说明: 配置客户端的应用程序名称，用于在 Config Server 中查找对应的配置文件。
- 示例 : spring.application.name=my-app
spring.profiles.active:
- 说明: 指定当前激活的配置文件，用于加载对应环境的配置。
- 示例 : spring.profiles.active=development
spring.cloud.config.label:
- 说明: 指定要使用的 Git 分支或标签。
- 示例 : spring.cloud.config.label=main
spring.cloud.config.username 和 spring.cloud.config.password:
- 说明: 用于访问受保护的 Config Server 的凭证。
- 示例
  
  :
```
spring:
  cloud:
    config:
      username: your-username
      password: your-password
```
spring.cloud.config.retry.enabled:
- 说明: 启用或禁用客户端重试配置服务器连接的功能。
- 示例 : spring.cloud.config.retry.enabled=true
spring.cloud.config.fail-fast:
- 说明: 配置客户端在启动时如果无法连接到配置服务器是否立即失败。
- 示例 : spring.cloud.config.fail-fast=true
spring.cloud.config.overrideNone:
- 说明: 指定如果本地配置文件存在，不覆盖它们。
- 示例 : spring.cloud.config.overrideNone=true
spring.cloud.config.overrideSystemProperties:
- 说明: 指定是否覆盖系统属性。
- 示例 : spring.cloud.config.overrideSystemProperties=false

示例配置文件

配置服务器（application.yml）

server:
  port: 8888

spring:
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-repo/config-repo
          searchPaths: application,profile-specific
          clone-on-start: true
          default-label: main
          username: your-username
          password: your-password

配置客户端（bootstrap.yml）

spring:
  application:
    name: my-app
  profiles:
    active: development
  cloud:
    config:
      uri: http://localhost:8888
      label: main
      username: your-username
      password: your-password
      retry:
        enabled: true
      fail-fast: true