前言
Nacos除了可以做注册中心,同样可以做配置管理来使用
一、统一配置管理
当微服务部署的实例越来越多,逐个修改微服务配置很容易出错。所以我们需要一种统一配置管理方案,可以集中管理所有实例的配置
Nacos一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新1.在Nacos中添加配置信息
在弹出表单中填写配置信息
2.从微服务拉取配置
微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并,才能完成项目启动。于是spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下
引入Nacos的配置管理客户端依赖:在user-service服务中,引入nacos-config的客户端依赖
<!--nacos配置管理依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
添加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 # 文件后缀名
读取nacos配置:在user-service中的UserController中添加业务逻辑,读取pattern.dateformat配置
@Value("${pattern.dateformat}")
private String dateformat;
/**
* 按照指定格式返回当前时间
*
* @return
*/
@GetMapping("/now")
public String now(){
return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
}
在页面访问,可以看到效果
二、配置热更新
1.方式一:在@Value注入的变量所在类上添加注解@RefreshScope
2.方式二:使用@ConfigurationProperties注解
在user-service服务中,添加一个类,读取patterrn.dateformat属性
package com.beizhen.user.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
* @author : Bei-Zhen
* @date : 2021-12-12 21:59
*/
@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
private String dateformat;
}
在UserController中使用这个类代替@Value
三、多环境配置共享
微服务启动时会从nacos读取多个配置文件
- [spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml
- [spring.application.name].yaml,例如:userservice.yaml
无论profile如何变化,[spring.application.name].yaml这个文件一定会加载,因此多环境共享配置可以写入这个文文件
1.添加一个环境共享配置:我们在nacos中添加一个userservice.yaml文件
2.在user-service中读取共享配置:修改PatternProperties类,读取新添加的属性
在user-service服务中,修改UserController,添加一个方法
3.运行两个UserApplication,使用不同的profile,修改UserApplication2这个启动项,改变其profile值
这样,UserApplication(8081)使用的profile是dev,UserApplication2(8082)使用的profile是test4.结果如下
5.优先级
四、多服务共享配置
不同微服务之间可以共享配置文件,通过下面的两种方式来指定
方式一
spring:
application:
name: userservice # 服务名称
profiles:
active: dev #开发环境,这里是dev
cloud:
nacos:
server-addr: localhost:8848 # Nacos地址
config:
file-extension: yaml # 文件后缀名
shared-configs: # 多微服务间共享的配置列表
- dataId: common.yaml # 要共享的配置文件id
方式二
spring:
application:
name: userservice # 服务名称
profiles:
active: dev #开发环境,这里是dev
cloud:
nacos:
server-addr: localhost:8848 # Nacos地址
config:
file-extension: yaml # 文件后缀名
extends-configs: # 多微服务间共享的配置列表
- dataId: extend.yaml # 要共享的配置文件id
五、总结
1.将配置交给Nacos管理的步骤
- 在Nacos中添加配置文件
- 在微服务中引入nacos的config依赖
- 在微服务中添加bootstrap.yml,配置nacos地址、当前环境、服务名称、文件后缀名。这些决定了程序启动时去nacos读取哪个文件
2.Nacos配置更改后,微服务可以实现热更新,方式
- 通过@Value注解注入,结合@RefreshScope来刷新
- 通过@ConfigurationProperties注入,自动刷新
注意事项:
不是所有的配置都适合放到配置中心,维护起来比较麻烦。建议将一些关键参数,需要运行时调整的参数放到nacos配置中心,一般都是自定义配置
3.微服务会从nacos读取的配置文件:
- [服务名]-[spring.profile.active].yaml,环境配置
- [服务名].yaml,默认配置,多环境共享
优先级:
- [服务名]-[环境].yaml >[服务名].yaml > 本地配置
4.不同微服务共享的配置文件:
- 通过shared-configs指定
- 通过extension-configs指定
优先级:
环境配置 >服务名.yaml > extension-config > extension-configs > shared-configs > 本地配置