在现代微服务架构中，配置管理是一个至关重要的环节。随着服务数量的增加，手动管理每个服务的配置变得复杂且容易出错。Spring Cloud Config 提供了一种集中化的配置管理解决方案，使得开发者能够轻松地管理和分发配置信息。本文将详细介绍 Spring Cloud Config 服务端的配置方法，帮助读者理解如何在实际项目中应用这一技术。
Spring Cloud Config 是 Spring Cloud 生态系统中的一个组件，用于集中化管理微服务应用的配置。它提供了一个服务端和客户端模型，服务端负责存储和分发配置信息，客户端则从服务端获取配置并应用到应用中。
Spring Cloud Config 的架构主要包括两个部分：
配置服务端是 Spring Cloud Config 的核心组件，它负责存储和分发配置信息。配置服务端可以从多种存储后端获取配置，如 Git、文件系统、Vault 等。本文将重点介绍基于 Git 的配置服务端配置方法。
首先，我们需要创建一个 Spring Boot 项目作为 Config Server。可以使用 Spring Initializr 快速生成项目。
Spring Cloud Config Server。生成的项目结构如下：
config-server/
├── src/
│ ├── main/
│ │ ├── java/
│ │ │ └── com/
│ │ │ └── example/
│ │ │ └── configserver/
│ │ │ └── ConfigServerApplication.java
│ │ └── resources/
│ │ ├── application.properties
│ │ └── bootstrap.properties
│ └── test/
│ └── java/
│ └── com/
│ └── example/
│ └── configserver/
│ └── ConfigServerApplicationTests.java
└── pom.xml
在 application.properties 或 application.yml 中配置 Config Server 的相关属性。
# application.properties
server.port=8888
spring.application.name=config-server
spring.cloud.config.server.git.uri=https://github.com/your-repo/config-repo.git
spring.cloud.config.server.git.search-paths=config
server.port：指定 Config Server 的端口号，默认为 8888。spring.application.name：指定应用名称。spring.cloud.config.server.git.uri：指定 Git 仓库的 URI，Config Server 将从该仓库获取配置。spring.cloud.config.server.git.search-paths：指定 Git 仓库中配置文件的搜索路径。# application.properties
spring.cloud.config.server.git.username=your-username
spring.cloud.config.server.git.password=your-password
spring.cloud.config.server.git.clone-on-start=true
spring.cloud.config.server.git.force-pull=true
spring.cloud.config.server.git.username 和 spring.cloud.config.server.git.password：如果 Git 仓库需要认证，可以配置用户名和密码。spring.cloud.config.server.git.clone-on-start：指定是否在启动时克隆 Git 仓库，默认为 false。spring.cloud.config.server.git.force-pull：指定是否强制拉取 Git 仓库，默认为 false。在 ConfigServerApplication.java 中，添加 @EnableConfigServer 注解以启用 Config Server。
package com.example.configserver;
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);
}
}
启动应用后，Config Server 将在指定的端口（如 8888）上运行，并可以从配置的 Git 仓库中获取配置信息。
Config Server 从 Git 仓库中获取配置时，遵循一定的命名规则。配置文件的命名格式为：
{application}-{profile}.{extension}
{application}：应用名称，对应 spring.application.name。{profile}：环境名称，如 dev、test、prod 等。{extension}：文件扩展名，如 properties、yml 等。例如，对于一个名为 myapp 的应用，在 dev 环境下的配置文件可以命名为 myapp-dev.properties 或 myapp-dev.yml。
在 Git 仓库中，配置文件的存储结构可以根据需要进行组织。常见的结构如下：
config-repo/
├── myapp/
│ ├── myapp-dev.properties
│ ├── myapp-test.properties
│ └── myapp-prod.properties
└── anotherapp/
├── anotherapp-dev.properties
└── anotherapp-prod.properties
在 spring.cloud.config.server.git.search-paths 中指定 config 路径后，Config Server 将在 config-repo/config 目录下查找配置文件。
配置客户端是 Spring Cloud Config 的另一个重要组件，它从 Config Server 获取配置并应用到应用中。配置客户端的配置方法与 Config Server 类似，但需要指定 Config Server 的地址。
同样，我们可以使用 Spring Initializr 快速生成一个 Config Client 项目。
Spring Cloud Config Client。生成的项目结构如下：
config-client/
├── src/
│ ├── main/
│ │ ├── java/
│ │ │ └── com/
│ │ │ └── example/
│ │ │ └── configclient/
│ │ │ └── ConfigClientApplication.java
│ │ └── resources/
│ │ ├── application.properties
│ │ └── bootstrap.properties
│ └── test/
│ └── java/
│ └── com/
│ └── example/
│ └── configclient/
│ └── ConfigClientApplicationTests.java
└── pom.xml
在 bootstrap.properties 或 bootstrap.yml 中配置 Config Client 的相关属性。
# bootstrap.properties
spring.application.name=myapp
spring.cloud.config.uri=http://localhost:8888
spring.profiles.active=dev
spring.application.name：指定应用名称，Config Server 将根据该名称查找对应的配置文件。spring.cloud.config.uri：指定 Config Server 的地址。spring.profiles.active：指定当前激活的环境，Config Server 将根据该环境查找对应的配置文件。# bootstrap.properties
spring.cloud.config.fail-fast=true
spring.cloud.config.retry.initial-interval=1000
spring.cloud.config.retry.max-interval=2000
spring.cloud.config.retry.max-attempts=6
spring.cloud.config.fail-fast：指定是否在 Config Server 不可用时快速失败，默认为 false。spring.cloud.config.retry.initial-interval：指定重试的初始间隔时间，单位为毫秒。spring.cloud.config.retry.max-interval：指定重试的最大间隔时间，单位为毫秒。spring.cloud.config.retry.max-attempts：指定最大重试次数。在 ConfigClientApplication.java 中，添加 @SpringBootApplication 注解以启动 Config Client。
package com.example.configclient;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class ConfigClientApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientApplication.class, args);
}
}
启动应用后，Config Client 将从 Config Server 获取配置并应用到应用中。
Spring Cloud Config 支持在不重启服务的情况下动态刷新配置。要实现这一功能，需要在 Config Client 中添加 @RefreshScope 注解。
package com.example.configclient;
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 ConfigController {
@Value("${my.config.property}")
private String configProperty;
@GetMapping("/config")
public String getConfigProperty() {
return configProperty;
}
}
在配置更新后，可以通过发送 POST 请求到 /actuator/refresh 端点来刷新配置。
curl -X POST http://localhost:8080/actuator/refresh
Spring Cloud Config 提供了一种集中化的配置管理解决方案，使得开发者能够轻松地管理和分发配置信息。通过配置服务端和客户端，开发者可以实现配置的集中化管理、环境隔离、动态刷新等功能。本文详细介绍了 Spring Cloud Config 服务端的配置方法，包括创建 Config Server 项目、配置 Config Server、启动 Config Server 等步骤。同时，还介绍了 Config Client 的配置方法，帮助读者理解如何在实际项目中应用 Spring Cloud Config。
通过本文的学习，读者应该能够掌握 Spring Cloud Config 的基本使用方法，并能够在实际项目中应用这一技术来管理微服务应用的配置。
免责声明：本站发布的内容（图片、视频和文字）以原创、转载和分享为主，文章观点不代表本网站立场，如果涉及侵权请联系站长邮箱：is@yisu.com进行举报，并提供相关证据，一经查实，将立刻删除涉嫌侵权内容。
