Springcloud Config配置中心怎么使用

发布时间：2022-09-15 10:25:28 作者：iii
来源：亿速云阅读：214

Spring Cloud Config配置中心怎么使用

1. 引言

在现代微服务架构中，配置管理是一个至关重要的环节。随着服务数量的增加，手动管理每个服务的配置文件变得非常繁琐且容易出错。Spring Cloud Config 提供了一种集中化的配置管理解决方案，使得我们能够在一个中心化的位置管理所有微服务的配置，并且能够动态地更新这些配置。

本文将详细介绍 Spring Cloud Config 的使用方法，包括如何搭建配置中心、如何将微服务与配置中心集成、以及如何实现配置的动态刷新。

2. Spring Cloud Config 概述

Spring Cloud Config 是 Spring Cloud 生态系统中的一个组件，用于集中化管理微服务的配置。它支持将配置文件存储在 Git、SVN、本地文件系统等不同的存储后端中，并且提供了 RESTful API 供微服务获取配置。

Spring Cloud Config 主要由两个部分组成：

Config Server：配置中心服务器，负责管理配置文件的存储和提供配置信息的访问接口。
Config Client：配置客户端，微服务通过 Config Client 从 Config Server 获取配置信息。

3. 搭建 Config Server

3.1 创建 Spring Boot 项目

首先，我们需要创建一个 Spring Boot 项目作为 Config Server。可以使用 Spring Initializr 快速生成项目。

打开 Spring Initializr。
选择 Maven 项目，语言选择 Java，Spring Boot 版本选择最新的稳定版本。
添加 Config Server 依赖。
点击生成并下载项目。

3.2 配置 Config Server

在生成的 Spring Boot 项目中，找到 application.properties 或 application.yml 文件，添加以下配置：

server:
  port: 8888

spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-repo/config-repo.git
          search-paths: '{application}'

server.port：指定 Config Server 的端口号，默认是 8888。
spring.application.name：指定应用名称。
spring.cloud.config.server.git.uri：指定 Git 仓库的地址，Config Server 将从该仓库中读取配置文件。
spring.cloud.config.server.git.search-paths：指定 Git 仓库中配置文件的搜索路径，{application} 表示根据应用名称查找对应的配置文件。

3.3 启用 Config Server

在 Spring Boot 项目的启动类上添加 @EnableConfigServer 注解，以启用 Config Server 功能。

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);
    }
}

3.4 启动 Config Server

运行 ConfigServerApplication，Config Server 将会启动并监听 8888 端口。

4. 配置文件的存储

Config Server 支持多种存储后端，最常用的是 Git。我们可以将配置文件存储在 Git 仓库中，Config Server 会从该仓库中读取配置。

4.1 创建 Git 仓库

在 GitHub 或其他 Git 托管平台上创建一个新的仓库，用于存储配置文件。

4.2 添加配置文件

在 Git 仓库中创建配置文件，文件名的格式为 {application}-{profile}.yml 或 {application}-{profile}.properties。例如：

application-dev.yml
application-prod.yml
myapp-dev.yml
myapp-prod.yml

其中，{application} 是应用名称，{profile} 是环境名称（如 dev、prod 等）。

4.3 提交配置文件

将配置文件提交到 Git 仓库中。

5. 配置微服务作为 Config Client

5.1 创建 Spring Boot 项目

同样地，我们需要创建一个 Spring Boot 项目作为 Config Client。可以使用 Spring Initializr 快速生成项目。

打开 Spring Initializr。
选择 Maven 项目，语言选择 Java，Spring Boot 版本选择最新的稳定版本。
添加 Config Client 依赖。
点击生成并下载项目。

5.2 配置 Config Client

在生成的 Spring Boot 项目中，找到 application.properties 或 application.yml 文件，添加以下配置：

spring:
  application:
    name: myapp
  cloud:
    config:
      uri: http://localhost:8888
      profile: dev

spring.application.name：指定应用名称，Config Server 会根据该名称查找对应的配置文件。
spring.cloud.config.uri：指定 Config Server 的地址。
spring.cloud.config.profile：指定环境名称，Config Server 会根据该名称查找对应的配置文件。

5.3 启用 Config Client

在 Spring Boot 项目的启动类上添加 @EnableConfigClient 注解，以启用 Config Client 功能。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.client.ConfigClientProperties;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.annotation.Bean;

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

5.4 启动 Config Client

运行 MyAppApplication，Config Client 将会启动并从 Config Server 获取配置。

6. 动态刷新配置

在某些情况下，我们希望在微服务运行时动态更新配置，而不需要重启服务。Spring Cloud Config 提供了 @RefreshScope 注解来实现这一功能。

6.1 添加依赖

在 Config Client 项目中，添加 spring-boot-starter-actuator 依赖，以启用 Actuator 端点。

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

6.2 启用刷新端点

在 application.yml 中添加以下配置，以启用 Actuator 的刷新端点。

management:
  endpoints:
    web:
      exposure:
        include: refresh

6.3 使用 `@RefreshScope` 注解

在需要动态刷新的 Bean 上添加 @RefreshScope 注解。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Component;

@Component
@RefreshScope
public class MyConfig {
    @Value("${my.property}")
    private String myProperty;

    public String getMyProperty() {
        return myProperty;
    }
}

6.4 触发刷新

当配置发生变化时，可以通过发送 POST 请求到 /actuator/refresh 端点来触发配置的刷新。

curl -X POST http://localhost:8080/actuator/refresh

7. 高级配置

7.1 多环境配置

在实际开发中，我们通常会有多个环境（如 dev、test、prod 等）。Spring Cloud Config 支持根据不同的环境加载不同的配置文件。

在 Config Server 的配置中，可以通过 spring.cloud.config.server.git.search-paths 指定不同环境的配置文件路径。

spring:
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-repo/config-repo.git
          search-paths: '{application}/{profile}'

在 Config Client 的配置中，可以通过 spring.cloud.config.profile 指定当前环境。

spring:
  cloud:
    config:
      profile: dev

7.2 加密配置

Spring Cloud Config 支持对配置文件中的敏感信息进行加密。可以使用对称加密或非对称加密。

7.2.1 对称加密

在 Config Server 的配置中，添加对称加密的密钥。

encrypt:
  key: my-secret-key

在配置文件中，使用 {cipher} 前缀标记加密的值。

my:
  secret: '{cipher}encrypted-value'

7.2.2 非对称加密

生成 RSA 密钥对，并将公钥和私钥分别配置在 Config Server 中。

encrypt:
  key-store:
    location: classpath:/keystore.jks
    password: keystore-password
    alias: my-key
    secret: key-password