十一、Nacos多配置加载和共享配置

Nacos多配置加载和共享配置

中文文档:https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config

通过前两小节,我们已经掌握了Nacos作为分布式配置中心的基本功能,比如:配置读取,自动刷新,加载原则,多环境管理等。但是,在实际项目中,配置文件一般会安装实际业务进行拆分,所以会存在多个配置文件需要加载。当然,对于多个服务之间,可能会存在一些共享的配置,所以这一节我们了解一下多配置文件加载和配置共享。

多配置文件加载

我们知道,配置文件的加载规则是由相面几个属性组合而成的:

1
2
3
4
5
spring.cloud.nacos.config.namespace= 默认:""//空,此处填的是namespaceId,而不是名字public
spring.cloud.nacos.config.group= 默认:DEFAULT_GROUP
# ${spring.cloud.nacos.config.prefix} > ${spring.cloud.nacos.config.name} > ${spring.application.name}
spring.cloud.nacos.config.prefix=
spring.cloud.nacos.config.file-extension= 默认 .properties

控制页面添加配置

具体配置如下:

nacos-multi-config.yaml

1
2
server:
port: 8888

nacos-multi-config-discovery.yaml

1
2
discovery:
host: 127.0.0.1:8848

nacos-multi-config-log.yaml

1
2
log:
level: Info

nacos-multi-config-db.yaml

1
2
3
4
5
6
7
spring:
datasource:
username: root
password: 123

server:
port: 7777

nacos-multi-config-redis.yaml

1
2
3
4
5
6
7
redis:
host: 127.0.0.1
username: amdin
password: admin

server:
port: 9999

bootstrap.properties

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# 基础配置
spring.application.name=nacos-multi-config
spring.cloud.nacos.config.file-extension=yaml
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
# spring.cloud.nacos.config.group=ouYangGroup
spring.cloud.nacos.config.namespace=28dacdf7-263f-40af-9d31-592529746f6e

# 多配置加载
# 使用默认的 DEFAULT_GROUP,如果上面配置了,则按照上面配置的加载
# 默认自动刷新
spring.cloud.nacos.config.ext-config[0].data-id=nacos-multi-config-discovery.yaml

# 不再默认的组,不会自动刷新
spring.cloud.nacos.config.ext-config[1].data-id=nacos-multi-config-log.yaml
spring.cloud.nacos.config.ext-config[1].group=ouYangGroup

# 不再默认的组,手动启动自动刷新
spring.cloud.nacos.config.ext-config[2].data-id=nacos-multi-config-db.yaml
spring.cloud.nacos.config.ext-config[2].group=ouYangGroup
spring.cloud.nacos.config.ext-config[2].refresh=true

# 测试加载顺序
spring.cloud.nacos.config.ext-config[3].data-id=nacos-multi-config-redis.yaml
spring.cloud.nacos.config.ext-config[3].group=ouYangGroup

注意

  • 通过spring.cloud.nacos.config.ext-config[n].data-id的配置来配置多个DataId 的配置。
  • 通过spring.cloud.nacos.config.ext-config[n].group 的配置来指定dataId所在的组,不明确指定的话使用默认的DEFAULT_GROUP
  • 通过spring.cloud.nacos.config.ext-config[n].refresh 的配置来控制该dataId属性变更时,是否动态刷新加载,默认如果不在DEFAULT_GROUP,自动刷新是关闭的,可以通过置为true来手动开启。

测试结果

注意1:

多个DataId同时配置时,它的优先级关系是 spring.cloud.nacos.config.ext-config[n].data-id 的值越大,优先级越高,即先加载,所以可以通过结果看到server.port=8888.是因为先加载server.port=9999.再7777覆盖了9999,再8888覆盖了7777,所以最后的结果就是server.port=8888 .

注意2:

spring.cloud.nacos.config.ext-config[n].data-id= 必须带上扩展名,即文件格式,支持properties,也支持yaml/yml.

此时spring.cloud.nacos.config.file-extension 的配置对自定义扩展的配置的data-id是无效的。

共享配置

通过上述自定义扩展dataId,已经解决了多个应用之间配置贡献的问题,同时也支持一个应用有多个配置文件。

下面我可以通过这种简单方式来配置共享配置:

1
2
3
# 共享配置
spring.cloud.nacos.config.shared-dataids=common-log.yaml,common-redis.yaml
spring.cloud.nacos.config.refreshable-dataids=common-log.yaml

Nacos控制台

nacos-config-share.yaml

1
2
server:
port: 9999

common-log.yaml

1
2
log:
level: DEBUG

common-redis.yaml

1
2
3
4
5
redis:
host: 127.0.0.1
port: 6379
log:
level: Info

主程序测试

主程序:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@SpringBootApplication
public class NacosConfigShareApplication {

public static void main(String[] args) {
ConfigurableApplicationContext applicationContext
= SpringApplication.run(NacosConfigShareApplication.class, args);
ConfigurableEnvironment environment = applicationContext.getEnvironment();
String port = environment.getProperty("server.port");
String level = environment.getProperty("log.level");
String redisHost = environment.getProperty("redis.host");
String redisPort = environment.getProperty("redis.port");
System.out.println("server.port:"+port);
System.out.println("log.level:"+level);
System.out.println("redis.host:"+redisHost+" | redis.port:"+redisPort);
}
}

结果:

1
2
server.port:9999
log.level:Info

可以看出:

  • 通过spring.cloud.nacos.config.share-dataids 来支持多个共享dataId的配置,多个配置文件之间用逗号隔开。
  • 通过spring.cloud.nacos.config.refreshable-dataids 来支持哪些共享配置的Data Id在变化时,应用中是否动态刷新,能感知到最新的值,多个DataId之间用逗号隔开。如果没有明确指定的配置,默认情况下所共享的配置是不支持动态刷新。

注意

  1. spring.cloud.nacos.config.share-dataids 的配置加载顺序是按照从左到右的,所以如果出现相同的配置时,后面的会覆盖前面的,如上述的log.level
  2. 使用spring.cloud.nacos.config.share-dataids 来配置共享配置时,需要加上后缀名,即properties,yaml/yml.此时的spring.cloud.nacos.config.file-extension 的配置对此项无效。
  3. 通过使用spring.cloud.nacos.config.refreshable-dataids 来指定哪些共享配置是需要支持自动刷新的。默认未指定的配置是不支持自动刷新的。同时也需要加上配置的后缀名

配置的优先级

我们用下面的实例来测试优先级:

spring cloud alibaba nacos config 目前提供了三种配置能力从Nacos拉取相关的配置。

  • A : 通过spring.cloud.nacos.config.shared-datadis 支持多个共享data id的配置。
  • B : 通过spring.cloud.nacos.config.ext-config[n].data-id 的方式支持多个扩展Data Id的配置。
  • C : 通过内部相关规则(应用名、应用名+profile)自动生成的DataId配置。

优先级:A < B < C 即,先读取C,再读取B,最后读取A。

nacos-config.yaml

1
2
log:
level: warning

nacos-config-share.yaml

1
2
log:
level: error

common.log.yaml

1
2
log:
level: DEBUG

boostrap.properties文件

case one:

1
2
3
4
spring.cloud.nacos.config.file-extension=yaml
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.shared-dataids=common-log.yaml
spring.cloud.nacos.config.refreshable-dataids=common-log.yaml

result:

1
log.level:DEBUG

case two:

1
2
3
4
5
6
spring.cloud.nacos.config.file-extension=yaml
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.ext-config[0].data-id=nacos-config.yaml
spring.cloud.nacos.config.ext-config[0].refresh=true
spring.cloud.nacos.config.shared-dataids=common-log.yaml
spring.cloud.nacos.config.refreshable-dataids=common-log.yaml

result:

1
log.level:warning

case three:

1
2
3
4
5
6
7
8
spring.application.name=nacos-share-config
spring.cloud.nacos.config.prefix=nacos-config-share
spring.cloud.nacos.config.file-extension=yaml
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.ext-config[0].data-id=nacos-config.yaml
spring.cloud.nacos.config.ext-config[0].refresh=true
spring.cloud.nacos.config.shared-dataids=common-log.yaml
spring.cloud.nacos.config.refreshable-dataids=common-log.yaml

result:

1
log.level:error

完全关闭配置

通过设置spring.cloud.nacos.config.enabled =false 来完全关闭Spring Cloud Nacos Config 配置功能。

完整配置参考

https://spring-cloud-alibaba-group.github.io/github-pages/greenwich/spring-cloud-alibaba.html#_more_information_about_nacos_config_starter_configurations

#

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×