一、为什么不用nacos

之前项目使用的是nacos作为配置中心，使用过程中，还是有不少问题的：

选用nacos，是同时使用了nacos的服务注册与发现，但是在生产环境，多个项目均出现了脑裂故障，包括1.x和2.x版本
后面弃用了nacos的服务发现能力，只保留了配置中心能力
nacos有自己的管理后台，需要单独维护账号密码，不方便管理
注：好像也支持LDAP，没去研究
只能基于浏览器的富文本框编辑，编辑操作不方便
注：复制出去再复制回来？步骤多，容易出错
提交修改时，对比也是基于浏览器自带方案，还是不方便
历史版本追溯麻烦，检索不方便，无法对比，而且有30天时长限制
增加所有模块的通用配置，需要所有模块对应修改，增加spring.cloud.nacos.config.shared-configs配置

基于上述原因，在新项目决定弃用nacos，改用SpringCloud原生的配置中心，理由：

SpringCloud的配置中心，使用git作为配置数据源
- 支持gitlab、github、gitee等
- 本地文件，编辑方便
- git的版本管理机制，团队管理、提交、对比、分支合并等健全机制
- 支持多个默认的全局配置：
  - application.yml 影响所有环境的所有模块
  - application-test.yml 影响test环境的所有模块
  - xxx.yml 影响所有环境的xxx这个指定模块
  - xxx-test.yml 影响test环境的xxx这个指定模块

当然，nacos有个优点，它集成了配置自动刷新能力；
而SpringCloud的配置中心，需要集成kafka或rabbitmq之类的消息中间件，才能有配置自动刷新能力。
下面介绍一下SpringCloud的配置中心使用。
本文基于：

IDEA2022.1.3
SpringBoot 2.7.9
SpringCloud 2021.0.6
java 1.8

二、搭建配置中心服务端

1、创建git配置存储

可以在git上新建一个项目存储，
也可以在现有的git项目里，新建一个子目录，专用于存储所有配置
我在gitee的一个现有项目里，新建了一个目录，叫 spring-configs，并事先上传了几个配置文件：

注：实际测试中，发现github基本都是连不上网络的状态，所以改用gitee来测试

2、新建项目+Maven依赖

在IDEA里新建项目，配置好名称、语言、组、类型、软件包、JDK版本、java版本等：

添加maven依赖
下一步里，选择Spring Boot版本 2.7.9（因为3.x不支持Java1.8)，并勾选依赖项Config Server

注：建议新建项目里勾选依赖项，自己后面去修改pom.xml会麻烦一些

3、代码和配置修改

打开main函数所在类，添加注解@EnableConfigServer

import org.springframework.cloud.config.server.EnableConfigServer;@SpringBootApplication
@EnableConfigServer
public class MyConfigServerDemoApplication {public static void main(String[] args) {SpringApplication.run(MyConfigServerDemoApplication.class, args);}
}

删除resources目录下的application.properties，并新建文件application.yml
注：我喜欢yml格式，你也可以直接编辑application.properties
打开application.yml，添加git配置：

server:port: 8999  # 配置中心服务端在8999端口监听spring:application:name: my-config-server-demo# 配置完直接启动即可，访问方式：# http://localhost:8999/{spring.application.name}/{spring.profiles.active}/{git分支}# {spring.application.name} 必需，就是具体项目的项目名（yml里配置的），不是config-server的哦# {spring.profiles.active} 必需，就是具体项目的环境（yml里配置的），注：具体项目可以不配置，使用默认值# {git分支} 可空，git配置文件所在的分支，默认使用下面的default-label## 注意：server项目启动后，会把git项目clone到本地，如windows系统会在 C:\Users\xxx\AppData\Local\Temp\config-repo-xxxcloud:config:server:git:uri: https://gitee.com/youbl/my-demo.git # git项目的url地址，支持gitlab、github、gitee等search-paths: spring-configs          # git项目下，存放yml配置文件的子目录username: beinet                      # git账号password: 123456                      # git密码default-label: master   # 默认会获取main分支，不存在就报错： No such label: maintimeout: 6              # 读取git的超时时间，默认5秒#clone-on-start: true                 # 启动时把配置clone到本地，默认false，第一次访问会比较慢#basedir:   c:/abc                      # 本地默认工作目录#refresh-rate: 100                    # 服务从git更新配置的时间间隔，单位秒，默认值0，表示每次请求都去获取最新配置skip-ssl-validation: true             # 忽略git地址的ssl错误： unable to find valid certification path to requested target

OK，启动项目预览下
启动上面的项目，启动完成后，访问地址：http://localhost:8999/config-client-demo/test
可以看到类似如下的json，列出了该项目会访问到的所有yml文件，以及内容：

{"name": "config-client-demo","profiles": ["test"],"label": null,"version": "169ff9974ccc09c594995ceabac26c983cd607bf","state": null,"propertySources": [{"name": "https://gitee.com/youbl/my-demo.git/spring-configs/config-client-demo-test.yml","source": {"beinet.config": "配置中心的front-study-test值","beinet.tttt": "abdefssadfga"}},{"name": "https://gitee.com/youbl/my-demo.git/spring-configs/application-test.yml","source": {"beinet.config": "配置中心的全局-test值","beinet.tttt": "abdefs","beinet.newVal": "2惹2"}},{"name": "https://gitee.com/youbl/my-demo.git/spring-configs/config-client-demo.yml","source": {"beinet.config": "配置中心的front-study默认值","beinet.tttt": "abdefs"}},{"name": "https://gitee.com/youbl/my-demo.git/spring-configs/application.yml","source": {"beinet.config": "配置中心的全局值","beinet.tttt": "abdefs"}}]
}

三、SpringBoot客户端连接访问配置中心

配置中心服务端搭建完成，下一步就是配置客户端去连接和访问配置中心的配置了。

1、添加maven依赖

新建项目时，在依赖页面，直接勾选Config Client即可完成依赖添加。
注：新建的项目，要打开pom，添加如下依赖：

    <dependency> <!-- 用于加载bootstrap.yml配置，否则报错 No spring.config.import property has been defined --><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-bootstrap</artifactId></dependency>

如果是旧的项目，打开项目的pom.xml文件，添加配置：

<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.9</version><relativePath/> <!-- lookup parent from repository -->
</parent>
<properties><java.version>1.8</java.version><spring-cloud.version>2021.0.6</spring-cloud.version>
</properties><dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-config</artifactId></dependency><dependency> <!-- 用于加载bootstrap.yml配置，否则报错 No spring.config.import property has been defined --><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-bootstrap</artifactId></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>

2、添加`bootstrap.yml`配置

在项目的resources目录下，新建文件bootstrap.yml，内容参考：

spring:application:name: config-client-demo           # 项目名，配置中心读取配置用cloud:config:uri: http://localhost:8999       # 指定配置中心的urlprofile: test                    # 指定使用哪个配置，可以搭配spring.profiles.active使用label: master                    # 指定分支，可为空，默认取主干

注意：如果报错：No spring.config.import property has been defined
要确认下Maven依赖是不是少了spring-cloud-starter-bootstrap

OK，启动客户端，输出一下在配置中心写的配置试试吧
测试的参考代码：

package beinet.cn.configclientdemo;import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.core.env.Environment;@SpringBootApplication
public class ConfigClientDemoApplication implements CommandLineRunner {public static void main(String[] args) {SpringApplication.run(ConfigClientDemoApplication.class, args);}@AutowiredEnvironment env;@Overridepublic void run(String... args) throws Exception {System.out.println(env.getProperty("beinet.config"));}
}

四、客户端配置刷新

客户端成功连接上配置中心后，只能在启动时读取配置，
如果git上的配置进行了修改，必须重启客户端，才能加载到最新的配置。
这里介绍一下，如何手动刷新客户端配置。

1、添加actuator依赖

打开客户端项目config-client-demo的pom.xml，添加如下依赖：

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

2、配置修改

打开客户端项目config-client-demo的bootstrap.yml，添加如下配置：

management:endpoints:web:exposure:include: "refresh"   # 用*表示暴露全部

3、添加`RefreshScope`注解

在读取了配置，且需要刷新的类上添加RefreshScope注解，如：

@Component
@RefreshScope
public class ConfigTest2 {@Value("${beinet.newVal}")String str3;public String getStr3() {return str3;}
}

4、调客户端接口，刷新配置

OK，当配置中心的配置发生了变更时，手工调用客户端的接口即可完成配置刷新：
POST http://localhost:8080/actuator/refresh
对应的CURL命令： curl -X POST http://localhost:8080/actuator/refresh
执行完接口请求，可以看到客户端的日志，会多出重新加载配置的日志，例如：

2023-03-22 13:38:37.976  INFO 2260 --- [nio-8080-exec-8] c.c.c.ConfigServicePropertySourceLocator : Fetching config from server at : http://localhost:8999
2023-03-22 13:38:38.844  INFO 2260 --- [nio-8080-exec-8] c.c.c.ConfigServicePropertySourceLocator : Located environment: name=config-client-demo, profiles=[test], label=master, version=e5b67cb61ad976c2c1bd863dae769aabf1553c21, state=null
2023-03-22 13:38:38.844  INFO 2260 --- [nio-8080-exec-8] b.c.PropertySourceBootstrapConfiguration : Located property source: [BootstrapPropertySource {name='bootstrapProperties-configClient'}, BootstrapPropertySource {name='bootstrapProperties-https://gitee.com/youbl/my-demo.git/spring-configs/config-client-demo-test.yml'}, BootstrapPropertySource {name='bootstrapProperties-https://gitee.com/youbl/my-demo.git/spring-configs/application-test.yml'}, BootstrapPropertySource {name='bootstrapProperties-https://gitee.com/youbl/my-demo.git/spring-configs/config-client-demo.yml'}, BootstrapPropertySource {name='bootstrapProperties-https://gitee.com/youbl/my-demo.git/spring-configs/application.yml'}]
2023-03-22 13:38:38.846  INFO 2260 --- [nio-8080-exec-8] o.s.boot.SpringApplication               : No active profile set, falling back to 1 default profile: "default"
2023-03-22 13:38:38.849  INFO 2260 --- [nio-8080-exec-8] o.s.boot.SpringApplication               : Started application in 0.998 seconds (JVM running for 402.306)
配置中心的front-study-test值..

5、刷新备注说明

通过Environment的Bean读取配置，会被刷新
没加RefreshScope注解的配置，不会被刷新
main函数所在类，不会被刷新，即使增加了RefreshScope也不行

五、通过bus消息总线自动刷新所有客户端配置

上面的方法，只能刷新单个客户端的配置，不会刷新其它服务的配置，
甚至，如果某服务部署了多台机器，那么其它机器也不会被刷新。
你需要知道每个服务部署了哪些机器，一台机器一台机器的去调用接口刷新。

这一节，介绍一下如何在配置中心服务端通知所有客户端去自动刷新配置。
原理说明：

调用配置中心服务端的API，通知刷新
配置中心服务端把消息投递到Kafka
所有客户端监听Kafka消息，进行刷新配置

1、服务端添加依赖和配置

打开配置中心服务端的pom.xml，添加如下依赖：

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

打开配置中心服务端的application.yml，添加如下配置，启用bus消息推送：

spring:cloud:# 启用bus后，对应的消息队列（如kafka）会自动创建一个topic springCloudBus# 使用 curl -X POST http://localhost:8999/actuator/busrefresh 会触发消息推送到这个topic，供client使用bus:refresh:enabled: truekafka:bootstrap-servers: 10.1.2.3:9092  # 用到的Kafka连接信息
management:endpoints:web:exposure:include: "busrefresh"   # 用*表示暴露全部

OK，可以启动配置中心服务端了。

2、客户端添加依赖和配置

打开每个客户端的pom.xml，添加如下依赖：

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

打开每个客户端的bootstrap.yml，添加kafka配置，启用bus消息消费：

spring:kafka:bootstrap-servers: 10.1.2.3:9092  # 用到的Kafka连接信息

OK，把这些客户端启动吧。

3、调服务端接口，刷新所有客户端配置

OK，当配置中心的配置发生了变更时，
还是要手工调用接口，但是是调用服务端的接口，即可完成所有客户端的配置刷新：
POST http://localhost:8999/actuator/busrefresh
对应的CURL命令： curl -X POST http://localhost:8999/actuator/busrefresh

执行完接口请求，可以看到服务端，以及每个客户端，都会多出重新加载配置的日志

最后，原生的配置中心就是这点不好，改了配置，一定要手工调接口，才能刷新。

SpringCloudConfigServer配置中心使用与刷新详解相关推荐

SpringCloud Alibaba 之 Config配置中心,Redis分布式锁详解
目录 1.服务配置中心 1.1 服务配置中心介绍 1.2 Nacos Config 实践 1.2.1 Nacos config 入门案例 1.2.2 Nacos 配置动态刷新 1.2.3 配置共享 ...
分布式配置中心之 —— nacos使用详解
前言随着分布式应用架构的广泛使用,随之而来的要解决的一个很重要的问题就是分布式环境下配置文件该如何处理,我们知道配置文件是任何一个系统中必不可少的,而且承载的信息量也越来越大,如何在分布式环境中对配 ...
[菜鸟SpringCloud实战入门]第七章：配置中心客户端主动刷新机制 + 配置中心服务化和高可用改造...
前言欢迎来到菜鸟SpringCloud实战入门系列(SpringCloudForNoob),该系列通过层层递进的实战视角,来一步步学习和理解SpringCloud. 本系列适合有一定Java以及Sp ...
linux 帐号配置sftp_Linux 下sftp配置之密钥方式登录详解
Linux下sftp配置之密钥方式登录由于vsftp采用明文传输,用户名密码可通过抓包得到,为了安全性,需使用sftp,锁定目录且不允许sftp用户登到服务器.由于sftp使用的是ssh协议,需保证 ...
GPIO 配置之ODR, BSRR, BRR 详解
STM32 GPIO 配置之ODR, BSRR, BRR 详解用stm32 的配置GPIO 来控制LED 显示状态,可用ODR,BSRR,BRR 直接来控制引脚输出状态. ODR寄存器可读可写:既能 ...
window10下拯救者笔记本RTX3060laptop配置CUDA11.0 pytorch版详解
cuda版本11.0 torch=1.7.1+cu110 torchvision==0.8.2+cu110 torchaudio==0.7.2 可以直接用命令: pip install torch== ...
Dropbear 安装配置与启动ssh服务详解
Dropbear 安装配置与启动ssh服务详解扎啤关注 2017.09.12 22:57* 字数 441 阅读 4160评论 0喜欢 0 一.介绍 dropbear作为一款基于ssh协议的轻量级 ...
AndroidManifest.xml文件配置教程及相关指令详解
AndroidManifest.xml 是每个android程序中必须的文件,它位于整个项目的根目录.我们每天都在使用这个文件,往里面配置程序运行所必要的组件,权限,以及一些相关信息.但是对于这个文件 ...
32 usb 配置描述符_USB协议详解第4讲（USB描述符标准配置描述符）
关注+星标公众号,不错过精彩内容编排 | 一个早起的程序员一个早起的程序员 1 USB描述符USB描述符有设备描述符.标准配置描述符.接口描述符.端点描述符.字符串描述符,HID设备有HID描述符 ...

SpringCloudConfigServer配置中心使用与刷新详解

一、为什么不用nacos

二、搭建配置中心服务端

1、创建git配置存储

2、新建项目+Maven依赖

3、代码和配置修改

三、SpringBoot客户端连接访问配置中心

1、添加maven依赖

2、添加`bootstrap.yml`配置

四、客户端配置刷新

1、添加actuator依赖

2、配置修改

3、添加`RefreshScope`注解

4、调客户端接口，刷新配置

5、刷新备注说明

五、通过bus消息总线自动刷新所有客户端配置

1、服务端添加依赖和配置

2、客户端添加依赖和配置

3、调服务端接口，刷新所有客户端配置

SpringCloudConfigServer配置中心使用与刷新详解相关推荐

最新文章

热门文章

SpringCloudConfigServer配置中心使用与刷新详解

一、为什么不用nacos

二、搭建配置中心服务端

1、创建git配置存储

2、新建项目+Maven依赖

3、代码和配置修改

三、SpringBoot客户端连接访问配置中心

1、添加maven依赖

2、添加bootstrap.yml配置

四、客户端配置刷新

1、添加actuator依赖

2、配置修改

3、添加RefreshScope注解

4、调客户端接口，刷新配置

5、刷新备注说明

五、通过bus消息总线自动刷新所有客户端配置

1、服务端添加依赖和配置

2、客户端添加依赖和配置

3、调服务端接口，刷新所有客户端配置

SpringCloudConfigServer配置中心使用与刷新详解相关推荐

最新文章

热门文章

2、添加`bootstrap.yml`配置

3、添加`RefreshScope`注解