SpringCloud(六) Nacos配置管理
Nacos除了可以做注册中心,同样可以做配置管理来使用;
Nacos做注册中心的使用和注意事项详看:SpringCloud(四) Nacos注册中心-CSDN博客
目录
一, 统一配置管理
1. 在Nacos中添加配置文件
2. 从微服务拉取配置
(1) 引入nacos-config依赖
(2) 添加bootstrap.yaml
(3) 读取nacos配置
(4) 重启userservice服务并访问
二, 配置热更新
1. 通过@Value注解
2. 通过@ConfigurationProperties注解
三, 配置共享
1. 添加一个环境共享变量
2. 在user-service 中读取共享配置
3. 运行两个UserApplication,使用不同的profile
4. 配置共享的优先级
一, 统一配置管理
当微服务部署的实例越来越多,达到数十,数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错;我们需要一种统一配置管理方案,可以集中管理所有实例的配置;
Nacos一方面可以将配置集中管理,另一方面可以在配置变更时,及时通知微服务,实现配置的热更新.
1. 在Nacos中添加配置文件
如何在nacos中管理配置?
注意:项目的核心配置,需要热更新的配置才有放到nacos管理的必要,基本不会变的一些配置还是保存在微服务本地比较好.
2. 从微服务拉取配置
微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并,才能完成项目的启动.
但如果尚未读取application.yml,又如何得知nacos地址呢?
因此,Spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下:
(1) 引入nacos-config依赖
首先,在user-service服务中,引入nacos-config的客户端依赖:
<!--nacos配置管理依赖-->
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>(2) 添加bootstrap.yaml
然后,在user-service中添加一个bootstrap.yaml文件,内容如下:
spring:application:name: userservice # 服务名称profiles:active: dev #开发环境，这里是dev cloud:nacos:server-addr: localhost:8848 # Nacos地址config:file-extension: yaml # 文件后缀名
这里会根据spring.cloud.nacos.server-addr获取nacos地址,再根据${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id，来读取配置;本例中就是读取userservice-dev.yaml:
(3) 读取nacos配置
在user-service中的UserController中添加业务逻辑,读取pattern.dateformat配置:
(4) 重启userservice服务并访问
二, 配置热更新
我们的最终目的,是修改nacos中的配置后,微服务无需重启即可让配置生效,也就是配置热更新,实现配置热更新的方式有两种:
- 通过@Value注解
- 通过@ConfigurationProperties注解
1. 通过@Value注解
在@Value注入的变量所在类上添加注解@RefreshScope:
更改nacos管理平台的配置文件并重新发布
重新访问查看是否可以获取配置文件
2. 通过@ConfigurationProperties注解
在user-service服务中,添加一个类,读取pattern.dateformat属性:
在UserController中使用这个类代替@Value
修改nacos管理平台的配置文件重新获取
三, 配置共享
其实微服务启动的时候会去nacos读取多个配置,例如:
[spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml[spring.application.name].yaml，例如：userservice.yaml
而[spring.application.name].yaml不包含环境,可以被多个环境共享(类似于所有带环境的配置文件的父文件).
1. 添加一个环境共享变量
2. 在user-service 中读取共享配置
在user-service服务中,修改PatternProperties类,读取新添加的属性:
在user-service服务中,修改UserController,添加一个方法:
3. 运行两个UserApplication,使用不同的profile
让8081端口号对应的user-service的环境是dev
让8082端口号对应的user-service的环境是test
修改UserApplication这个启动项,改变其profile值:
访问8081端口号的结果:
访问8082端口号的结果:
可以看出来,不管是dev,还是test环境,都读取到了envSharedValue这个属性的值
4. 配置共享的优先级
当nacos,服务本地同时出现相同属性时,优先级有高低之分,为了方便大家记忆,这里给出了一个图片:
服务名-profile.yaml > 服务名称.yaml > 本地配置