Spring Cloud Config 统一管理微服务配置（Config Server、Config Client搭建、Config Server Git仓库配置详解）

最新推荐文章于 2024-06-24 18:31:23 发布
最新推荐文章于 2024-06-24 18:31:23 发布
阅读量1k 收藏 6
点赞数 1
CC 4.0 BY-SA版权
分类专栏： spring cloud 微服务实战 文章标签： spring cloud spring cloud config config server
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_32352777/article/details/96182010
本文介绍Spring Cloud Config在微服务架构中的应用，包括统一配置管理的重要性、ConfigServer与ConfigClient的搭建步骤及Git仓库配置详解。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

一、为什么要统一管理微服务配置

二、Spring Cloud Config介绍

三、编写Config Server

四、Config Server的端点

五、编写Config Client

六、Config Server的Git仓库配置详解

1、占位符支持

2、模式匹配

3、搜索目录

4、启动时加载配置文件

一、为什么要统一管理微服务配置

对于传统的单体应用而言，常使用配置文件来管理所有配置，比如SpringBoot的application.yml文件，但是在微服务架构中全部手动修改的话很麻烦而且不易维护。
微服务的配置管理一般有以下需求：

  • 集中配置管理，一个微服务架构中可能有成百上千个微服务，所以集中配置管理是很重要的。
  • 不同环境不同配置，比如数据源配置在不同环境（开发，生产，测试）中是不同的。
  • 运行期间可动态调整。
  • 配置修改后可自动更新。

二、Spring Cloud Config介绍

Spring Cloud Config主要是为了分布式系统的外部配置提供了服务器端和客户端的支持，只要体现为Config Server和Config Client两部分。由于Config Server和Config Client都实现了对Spring Environment和PropertySource抽象的映射，因此Spring Cloud Config很适合Spring应用程序。

Config Server是一个可横向扩展的，集中式的配置服务器，它用于集中管理应用程序各个环境下配置，默认使用Git存储配置内容。

Config Client是一个Config Server的客户端，用于操作存储在Config Server上的配置属性，所有微服务都指向Config Server,启动的时候会请求它获取所需要的配置属性，然后缓存这些属性以提高性能。

三、编写Config Server

1、在远程Git仓库中新建一个配置文件

application-dev.properties

application.properties

 application-dev.properties内容如下：

profile=dev-1.0

 application.properties内容如下：

profile=default-1.0

2、创建项目config-server

pom.xml如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.springclouddemo</groupId>
    <artifactId>config-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>config-server</name>
    <description>Config Server</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.SR2</spring-cloud.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3、在启动类添加@EnableConfigServer注解

package com.springclouddemo.configserver;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

/**
 * @author 何昌杰
 */
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {

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

}

4、编写application配置文件

server.port=7400
spring.application.name=config-server
spring.cloud.config.server.git.uri=https://gitee.com/jie_harris/config-server
#spring.cloud.config.server.git.username=
#spring.cloud.config.server.git.password=

这样，一个Config Server就完成了。

 

测试：

  1. 运行项目config-server
  2. 访问http://localhost:7400/application-dev.yml，得到如下响应：
  3. 访问http://localhost:7400/application/dev,得到如下响应：

四、Config Server的端点

我们可以使用Config Server的端点获取配置内容。端点与配置文件的映射规则如下：

/{application}/{profile}[/{label}]

/{application}-{profile}.yml

/{label}/{application}-{profile}.yml

/{application}-{profile}.properties

/{label}/{application}-{profile}.properties

  • application: 表示微服务的虚拟主机名，即配置的spring.application.name

  • profile: 表示当前的环境，dev,test or production?

  • label: 表示git仓库分支，master or relase or others repository name?默认是master

  • 如果没有找到，就会找默认的

例如：

http://localhost:7400/application/dev

http://localhost:7400/application-dev.properties

http://localhost:7400/application-dev.yml

五、编写Config Client

我们已经知道如何使用Config Server端点获取配置内容，这一节我们讨论微服务如何获取配置信息。

1、创建项目config-client

pom.xml如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.springclouddemo</groupId>
    <artifactId>config-client</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>config-client</name>
    <description>Config Client</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.SR2</spring-cloud.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2、编写application配置文件

server.port=7401

3、编写bootstrap.properties配置文件

spring.application.name=application
spring.cloud.config.uri=http://localhost:7400/
spring.cloud.config.profile=dev
spring.cloud.config.label=master
  • spring.application.name:对应Config Server所获取的配置文件中的{application}
  • spring.cloud.config.uri:指定Config Server的地址，默认http://localhost:8888
  • spring.cloud.config.profile：对应Config Server所获取的配置文件的{profile}
  • Spring.cloud.config.label:对应Git仓库的分支，对应Config Server所获取配置文件的{label}
  • 特别注意这里是bootstrap配置文件

第三步属性配置应在bootstrap上，而不是application中。如果在applicaton中该部分配置将不能正常工作。

Spring Cloud有一个“引导上下文”的概念，这里是主应用程序的父上下文。引导上下文负责从配置服务器加载配置属性，以及解密外部配置文件中的属性。和主应用程序加载的application.*中的属性不同，引导上下文加载bootstrap.*中的属性。配置在bootstrap.*中的属性有更高的优先级，因此默认情况下他们不能被本地覆盖。

4、编写controller

编写controller/DemoController.java

package com.springclouddemo.configclient.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author 何昌杰
 */
@RestController
public class DemoController {
    @Value("${profile}")
    private String profile;

    @GetMapping("/demo")
    public String demo(){
        return this.profile;
    }
}
  • @Value注解绑定Git仓库配置文件中的profile属性

项目结构：

 

测试：

  1. 启动项目config-server、config-client
  2. 访问http://localhost:7401/demo，得到响应如下：

六、Config Server的Git仓库配置详解

前文中，使用spring.cloud.config.server.git.uri指定一个Git仓库，事实上，该属性非常灵活

1、占位符支持

Config Server的占位符支持{application}、{profile}、{label}

例如：

server.port=7400
spring.application.name=config-server
spring.cloud.config.server.git.uri=https://gitee.com/jie_harris/{application}

使用这种方式，即可轻松支持一个应用对应一个Git仓库。同理，也可支持一个profile对应一个Git仓库

2、模式匹配

模式匹配指的是带有通配符的{application}/{profile}名称的列表。如果{application}/{profile}不匹配任何模式，将使用这个配置项spring.cloud.config.server.git.url定义的URL。

spring.cloud.config.server.git.uri=https://gitee.com/jie_harris/config-server
spring.cloud.config.server.git.repos.simple=https://gitee.com/simpler/config-server
spring.cloud.config.server.git.repos.special.pattern=special*/dev,*special*/dev*
spring.cloud.config.server.git.repos.special.uri=https://gitee.com/simpler/config-server

对simple仓库，它匹配所以配置文件。对special仓库，它只匹配所以配置文件中名为special的配置文件。

3、搜索目录

很多场景下，可能吧配置文件放在Git仓库的子目录下，此时可以使用search-path指导，search-path同样支持占位符

spring.cloud.config.server.git.uri=https://gitee.com/jie_harris/config-server
spring.cloud.config.server.git.search-paths=app,bar*

这样Config Server就会在Git仓库跟目录，app目录，以及所有bar开头的子目录查找配置文件

4、启动时加载配置文件

默认情况下，在配置被首次请求时，Config Server才会clone Git仓库，也可以让Config Server在启动时就clone Git仓库。

spring.cloud.config.server.git.uri=https://gitee.com/jie_harris/config-server
spring.cloud.config.server.git.repos.simple.uri=https://gitee.com/simpler/config-server
spring.cloud.config.server.git.repos.simple.pattern=application-*
spring.cloud.config.server.git.repos.simple.clone-on-start=true
这样就可以在Config Server启动时clone指定Git仓库了，当然也可以使用spring.cloud.config.server.git.repos.clone-on-start=true进行全局配置。

 

spring cloud config server git uri git@
henu_xiaohei的博客
01-07 1357
解决git@xxx.xxx.xxx.xxx:/home/gitrepo/xxxxx.git/链接spring cloud config server git uri服务无法加载问题。 异常信息： java.lang.IllegalStateException: Could not locate PropertySource and the fail fast property is set, fa...
深入解析Spring Cloud Config：多样配置中心的实现与高可用策略
热门推荐
张彦峰的博客
02-14 167万+
这篇文章探讨了配置中心的重要性及其在分布式系统中的应用，特别关注Spring Cloud Config。文章首先介绍了配置中心的由来、功能及选择标准，然后详细阐述了Spring Cloud Config的基本实现方法，包括结合Git、关系型数据库（MySQL）和非关系型数据库（MongoDB）的方案。此外，还讨论了配置中心的高可用性、客户端自动刷新机制及安全认证等扩展功能。最后，文章对比了Spring Cloud Config与Apollo的特性，强调Apollo在企业级应用中的优势。
Spring Cloud Config-Git后端
weixin_34419326的博客
06-01 97
2019独角兽企业重金招聘Python工程师标准>>> ...
Spring Cloud Config 配置中心使用说明(2) -- 服务器+git库
xgw的专栏
08-30 1732
spring cloud config 服务器提供了基于HTTP 的外部配置（名称值对或等效的YAML内容）资源API 。服务器可以使用@EnableConfigServer注释轻松嵌入到Spring Boot应用程序中。所以下面这个应用程序是一个配置服务器： ConfigServer.java @SpringBootApplication @EnableConfigServer public class ConfigServer { public static void main(String[] a
微服务轮子项目（44） -GitLab代码仓库
阿甘兄
02-08 614
文章目录1. 安装部署1.1下载镜像1.2 运行GitLab容器1.3 拷贝配置文件1.4 修改gitlab配置1.5 创建启动文件2. 免密访问2.1 获取本地客户端机器的公钥2.2 添加ssh key3. webhook配置3.1 配置触发3.2 webhook报错 Requests to the local network are not allowed 1. 安装部署 1.1下载镜像 docker pull gitlab/gitlab-ce 1.2 运行GitLab容器 docker run --
（七）spring-cloud入门学习：配置中心config server（git）
guangcaiwudong的博客
07-23 6931
随着线上项目变的日益庞大，每个项目都有各种配置文件，如果采用分布式的开发模式，需要的配置文件随着服务增加而不断增多。某一个基础服务信息变更，都会引起一系列的更新和重启，运维成本高也容易出错。配置中心便是用来解决此类问题的。 一个配置中心提供的核心功能应该有什么： 提供服务端和客户端支持 集中管理各环境的配置文件 配置文件修改之后，可以快速的生效 可以进行版本管理 支持大的并发查询 支持各种语言 ...
Spring Cloud Config Server：服务端配置管理详解
SpringCloud Config是Spring Cloud的一个子项目，旨在为分布式系统提供一个集中化的外部配置支持，使得应用能够更加灵活地管理和部署。在微服务架构中，服务配置的集中化管理是必要的，它可以使得我们能够统一管理...
spring cloud学习教程之config修改配置详解
08-29
首先，配置中心（Config Server）会从Git仓库拉取配置文件，并为各个客户端应用提供配置信息。当我们在Git端修改了配置文件后，我们需要通知客户端应用更新配置。有以下两种方法： 1. **访问接口刷新配置**： - ...
详解spring cloud config整合gitlab搭建分布式的配置中心
08-28
在搭建分布式配置中心时，首先需要理解Spring Cloud Config的主要组成部分：Config Server 和 Config Client。Config Server 是配置中心的服务器端，它负责存储和提供配置信息。Config Client 则是各个微服务应用，...
Spring Cloud 探索 | 分布式配置中心（Config Server）
挖坑埋你
07-17 964
本系列文章的写作环境为：Spring Boot 2.0.3.RELEASE、Spring Cloud Finchley.RELEASE、JDK 8、IDEA 先说一下最近的状态吧：2016年毕的业，7月4号参加的工作，到今天整好2年。也正是职业生涯开始迷茫和遇到瓶颈的时间。平常很喜欢看技术类资料，也关注了很多好的博客和微信公众号。每天都可以看到很多技术文章，好的有烂的也有，也花费了不少精...
Spring cloud Config实战——Git中URI占位符
实践求真知
11-17 603
一代码位置 https://github.com/cakin24/spring-cloud-code/tree/master/ch12-1 二测试 1启动config-server-placeholders 2启动config-client-placeholders 3浏览器输入： http://localhost:9100/getConfigInfo 匹配到的配置如下：...
spring cloud:spring cloud config
zhuchuangang的专栏
04-16 7423
spring cloud config在分布式系统中提供了服务端和客户端支持来提供外部化的配置。配置服务器有一个中心配置仓库，来管理应用程序所有环境的外部配置属性。spring cloud config很适合与Spring应用程序配合使用,可以被用于任何应用程序。随着应用程序通过部署管道从开发到测试到生产管理这些环境之间的配置,确保应用程序拥有他们所需要的一切运行时迁移。服务器的默认实现存储后端使用
Spring Cloud Config
fulong0406的博客
06-13 272
中文文档地址：https://www.springcloud.cc/spring-cloud-config.html 不想读文档，可以跟着我的思路ka
SpringCloud - Spring Cloud 之 Config分布式配置；server，client配置（十五）
MinggeQingchun的博客
07-05 708
在分布式微服务系统中，几乎所有服务的运行都离不开配置文件的支持，这些配置文件通常由各个服务自行管理，以 properties 或 yml 格式保存在各个微服务的类路径下，如 application.properties 或 application.yml 等1、传统配置方式：配置信息分散到系统各个角落方式，配置文件或者在代码中；2、集中式配置中心：将应用系统中对配置信息的管理作为一个新的应用功能模块，进行集中统一管理，并且提供额外功能；3、分布式配置中心：在分布式、微服务架构中，独立的配置中心服务传统配置方
springcloud-config git配置源加载（部署公钥问题）
最新发布
topc2000的博客
06-24 605
gitee 或者github 中有类似于发布密钥的功能，允许通过私钥只读访问指定的仓库，文档中说的是 限制了git的操作为pull 和 clone。然后对应平台的公钥管理中，添加公钥，将对应的.pub文件中的内容复制进去，选择好对应的仓库。私钥内容地址，这里有一个坑，如果使用的是properties格式的配置文件在配置的时候需要保留输出格式。需要注意的一点是使用这种方式生成的privatekey进行配置的时候。出来的内容，在复制到配置文件中的时候需要在每一行的末尾追加。这部分的字符串是没有RSA的。
springcloud系列—Config—第6章-2: Spring Cloud Config 服务端详解、git（svn、本地仓库）配置
weixin_40663800的博客
12-27 906
资料参考：《Spring Cloud 微服务实战》 目录 服务端详解 基本架构 git配置仓库 占位符配置url 配置多个仓库 子目录存储 访问权限 svn配置仓库 本地仓库 本地文件系统 服务端详解 前面一篇《springcloud系列—Zuul—第6章-1: Spring Cloud Config 配置中心》我们实现了一个具备基本结构得配置管理服务端和客户端，同事讲解...
想知道为什么需要配置管理的小伙伴看过来
weixin_34126215的博客
12-02 451
Nacos 是阿里巴巴今年7月份开源的项目，如其名， Naming Configuration Service ，专注于服务发现和配置管理领域。本系列文章，将从 5W1H（What、Where、When、Who、Why、How）全面剖析 Nacos，希望对开发者们在服务发现和配置管理开源方案选型的时候，有所帮助。 本文作为 Nacos 系列文章的开篇，从 “What” 开始。我们开始关注一个开源...
spring cloud的配置中心config server 和config client 的配置使用
weixin_38312502的博客
04-28 1017
1. spring cloud config server 1.1 引入pom <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </depend...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值