当服务实例越来越多的时候,一个个实例去修改配置的话,其容易出错的概率和所消耗的时间就不言而喻了,这时候统一配置管理就显得尤为重要了。
Naocs不仅可以做注册中心,还可以做统一配置管理。Nacos 一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。
目录
创建配置
1. 在 Nacos 控制面板中添加配置文件
然后在弹出的表单中,填写配置信息:
注意:项目的核心配置,需要热更新的配置才有放到 nacos 管理的必要。基本不会变更的一些配置(例如数据库连接)建议还是保存在微服务本地较好。
拉取配置
首先我们需要了解 Nacos 读取配置文件的环节是在哪一步,在没加入 Nacos 配置之前,获取配置是这样:
加入 Nacos 配置,它的读取是在 application.yml 之前的:
这时候如果把 nacos 地址放在 application.yml 中,显然是不合适的,因为这样Nacos 就无法根据地址去获取配置了(按顺序,读取Nacos地址在读取Nacos配置之后,导致无法获取地址)
因此,nacos 地址必须放在优先级最高的 bootstrap.yml 文件
1. 引入 nacos-config 依赖
<!--nacos配置管理依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
2. 添加 bootstrap.yml
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,来读取配置。在这个例子例中,就是去读取Nacos中 userservice-dev.yaml的配置
完成这一步,就可以成功读取到Nacos重的配置了
配置热更新
我们最终的目的,是修改 nacos 中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新。实现配置热更新有两种方式
- 用
@value
读取配置时,搭配 注解@RefreshScope
; - 直接用
@ConfigurationProperties
读取配置
@RefreshScope
方式一:在 @Value
注入的变量所在类上添加注解 @RefreshScope
@ConfigurationProperties
方式二:使用 @ConfigurationProperties
注解读取配置文件,就不需要加 @RefreshScope
注解。
例如:在 user-service 服务中,添加一个 PatternProperties 类,读取 patterrn.dateformat
(上面的Nacos配置例子)属性
@Data
@Component
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
public String dateformat;
}
@Autowired
private PatternProperties patternProperties;
@GetMapping("now2")
public String now2(){
//格式化时间
return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.dateformat));
}
配置共享
其实在服务启动时,nacos 会读取多个配置文件,例如:
[spring.application.name]-[spring.profiles.active].yaml
,例如:userservice-dev.yaml[spring.application.name].yaml
,例如:userservice.yaml
这里的 [spring.application.name].yaml
不包含环境,因此可以被多个环境共享。所以不管是 dev环境,还是 test 环境,或是其他环境,都可以读取到userservice.yaml中属性的值。
上面的都是同一个微服务下,那么不同微服务之间可以环境共享吗?答案是通过下面的两种方式来指定:
- extension-configs
- shared-configs
spring:
cloud:
nacos:
config:
file-extension: yaml # 文件后缀名
extends-configs: # 多微服务间共享的配置列表
- dataId: common.yaml # 要共享的配置文件id
spring:
cloud:
nacos:
config:
file-extension: yaml # 文件后缀名
shared-configs: # 多微服务间共享的配置列表
- dataId: common.yaml # 要共享的配置文件id
配置优先级
当 nacos、服务本地同时出现相同属性时,优先级有高低之分。