Spring Cloud 教程(三) | Nacos配置
一、Nacos是什么?
Nacos是Dynamic Naming and Configuration Service(动态命名与配置服务)的首字母简称,是阿里巴巴开源的一款功能强大的动态服务发现、服务配置和服务管理平台。
它作为一种云原生的解决方案,旨在帮助开发者更好地构建、管理和发现微服务架构中的各种服务。
核心功能
Nacos包括三个核心子系统:服务发现与注册、动态配置管理和动态DNS服务。
应用场景
Nacos可以应用于多种场景,包括但不限于:
- 微服务架构:作为微服务架构中的注册中心,用于服务的注册与发现,使得微服务之间可以方便地相互调用。
- 动态配置管理:管理系统的配置信息,包括配置文件的存储、更新和发布。可以根据业务需要动态修改配置,而不需要重新部署和重启应用。
- 服务健康监测:实时监测微服务的健康状态,当服务出现故障或不可用时,及时发现并进行告警,保障服务的高可用性。
- 服务集群管理:对服务进行集群管理,包括服务的注册、注销和实例的动态扩容与缩容等操作,提供了便捷的服务管理功能。
二、Nacos服务注册配置
一定要配置 spring.application.name 属性,否则会在Nacos上服务列表中找不到你的服务,尽管该服务已经成功连接到Nacos
三、Nacos实现配置中心
强烈要求规范
1.将Nacos的配置信息放在bootstrap配置文件
为什么需要使用 bootstrap前缀的文件?
由于application配置文件的加载优先级低于bootstrap配置文件,如果Nacos的配置信息放在application配置文件中,那么在应用启动时可能会因为还未连接到Nacos服务器而无法加载这些配置。
虽然不是强制要求,但将Nacos的配置信息放在bootstrap配置文件中是最佳实践。
如果出现 错误 “No spring.config.import property has been defined
”,
表示 springcloud新版默认禁用了bootstrap,如果需要使用bootstrap需要自己手动引入对应的依赖。
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>
2.Nacos的命名空间最好配置一个,不要用默认的 public(保留空间)
对应 spring.cloud.nacos.config.group 配置
3.Data ID 的 命名要带上(.properties或.yaml)的后缀。
不加后缀 的后果,会在多文件配置这种情况下体现出来,你会发现带"-"的文件读取不到
Data Id 的命名规则
在 Nacos Spring Cloud 中,dataId 的完整格式如下:
${prefix}-${spring.profiles.active}.${file-extension}
- prefix 默认为 spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
- spring.profiles.active 即为当前环境对应的 profile,详情可以参考 Spring Boot文档。 注意:当 spring.profiles.active 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成 ${prefix}.${file-extension}
- file-exetension 为配置内容的数据格式(默认值为 properties),可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。
文件配置法
虽然nacos-config 可以默认根据 Data Id 的命名规则 帮我们找配置文件,前提是你要创建的nacos文件要满足规则。
例如 :你的服务 spring.application.name(应用程序名称)配置为 user,然后在nacos上面存在 user.properties的文件,在不主动配置配置文件的情况下,会默认帮你找到该配置文件。
但是总归不好,万一你nacos的Data Id名称不一定和应用程序名称一样呢,也是需要再配置的。
所有关于读取的配置文件我们应该自己主动去配置
在bootstrap(.properties或.yaml)的文件中,进行 Nacos配置的时候,主要有以下三类配置:
A: 通过spring.cloud.nacos.config.shared-dataids定义的共享配置
B: 通过spring.cloud.nacos.config.ext-config[n]定义的加载配置
C: 通过内部规则(spring.cloud.nacos.config.prefix、spring.cloud.nacos.config.file-extension、spring.cloud.nacos.config.group这几个参数)拼接出来的配置
其中优先级关系是:A < B < C ,C的优先级别最高,但是没有其他两个灵活度高
在对于多文件配置时,A和B支持且名字自由度高一点,C的需要和spring.profiles.active来配合才可以多文件且名字前缀会固定。
内部规则方式(常规配置)
spring.cloud.nacos.config.prefix(前缀)
spring.profiles.active(中间)
spring.cloud.nacos.config.file-extension(后缀)
例如:nacos上面的user-prod.yaml、user-mq 就如下配置
spring.cloud.nacos.config.prefix=user
spring.profiles.active=prod,mq
spring.cloud.nacos.config.file-extension=yaml
旧版本 shared-dataids 方式、新版本 shared-configs[n](共享配置)
用于指定多个需要被当前应用共享的配置项(Data Ids)。这些配置项可能包含跨应用或跨服务的通用配置信息。
**旧版本 shared-dataids **
spring.cloud.nacos.config.shared-dataids=commons.yml,db.yml
spring.cloud.nacos.config.refreshable-dataids=commons.yml,db.yml
- shared-dataids用于指定多个共享配置的Data ID,
- refreshable-dataids则指定哪些共享配置在变更时可以动态刷新。
新版本 shared-configs[n]
# 模拟第一个shared-config
spring.cloud.nacos.config.shared-configs[0].data-id=commons.yml
spring.cloud.nacos.config.shared-configs[0].group=DEFAULT_GROUP
spring.cloud.nacos.config.shared-configs[0].refresh=true
# 模拟第二个shared-config
spring.cloud.nacos.config.shared-configs[1].data-id=db.yml
spring.cloud.nacos.config.shared-configs[1].group=DEFAULT_GROUP
spring.cloud.nacos.config.shared-configs[1].refresh=true
shared-configs优先级,[0] <[1]
旧版本 ext-config[n] 方式、新版本 extension-configs[n](扩展配置)
加载额外的配置文件(即扩展配置)。这些配置文件可以是针对特定环境、特定服务或特定需求的配置。
旧版本 ext-config[n] 方式
spring.cloud.nacos.config.ext-config[0].data-id=extra-config-1.yml
spring.cloud.nacos.config.ext-config[0].group=EXTRA_GROUP
spring.cloud.nacos.config.ext-config[0].refresh=true
spring.cloud.nacos.config.ext-config[1].data-id=extra-config-2.yml
spring.cloud.nacos.config.ext-config[1].refresh=false
ext-configs优先级,[0] <[1]
新版本 extension-configs[n]
spring.cloud.nacos.config.extension-configs[0]=extra-config-1.yml
spring.cloud.nacos.config.extension-configs[0].group=EXTRA_GROUP
spring.cloud.nacos.config.extension-configs[0].refresh=true
extension-configs优先级,[0] <[1]
参考文章
【1】Spring Cloud Alibaba基础教程:Nacos配置的多文件加载与共享配置
【2】nacos-config配置中心、多环境配置、加载多配置文件