命名空间和group

1.namespace作为环境隔离使用,例如开发环境、测试环境、生产环境等。

2.group作为微服务隔离,每个group代表一个微服务,例如customer-service等。

配置文件命名

1.nacos中data-id相当于spring.application.name,由于每个微服务都有一个默认的application.yml配置文件,所以每个微服务的默认配置文件命名为微服务的名称,例如customer-service.yaml

2.所有微服务共用的配置文件,比如数据库信息,日志级别,公共业务配置信息等,目前只提供一个配置文件,单独区分一个group,命名为common-platform.yaml

3.对于微服务之间和微服务与ui之间共享的配置,命名为common-微服务名称,例如:common-customer-serveice.yaml,分组的话和platform在同一组,命名为common组

客户端使用规范

一、基础配置

1.引入jar包

引入jar包 折叠原码

<dependency>

    <groupId>org.springframework.cloud</groupId>

    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>

    <version>0.2.2.RELEASE</version>

</dependency>

  

implementation "org.springframework.cloud:spring-cloud-starter-alibaba-nacos-config:0.2.2.RELEASE"

2.nacos基础配置必须配置在bootstrap.properties中

3.包含微服务名称(spring.application.name

nacos服务器地址(spring.cloud.nacos.config.server-addr)

命名空间(spring.cloud.nacos.config.namespace)

分组(spring.cloud.nacos.config.group)

文件后缀(spring.cloud.nacos.config.file-extension)

基础配置 折叠原码

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

# 基础配置

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

  

spring:

  application:

    name: customer-service

  cloud:

    nacos:

      config:

        #nacos配置中心服务器地址

        server-addr: ${NACOS_ADDR:10.0.228.148:8848}

        #文件后缀格式

        file-extension: yaml

        #nacos配置中心命名空间

        namespace: ${NACOS_NAMESPACE:refactorBoss-dev}

        #nacos配置中心分组

        group: ${spring.application.name}

4.命名空间和服务器地址使用变量配置,例如:${namespace:public},当变量存在时,取变量的值,如果不存在的话,取默认值。

便于售后通过环境变量或者命令行参数进行相关配置

5.相同group下,配置更改时会自动更新,一般分为两种情况:

  • 使用配置类时,更改配置后会自动更新
  • 使用@value注解时,需要在Controller类中添加注解@RefreshScope,这样配置才会更新
  • 推荐使用第一种方式

二、扩展配置

1.有一些场景,需要使用其他微服务的配置,或者使用全局配置,这种情况下可以使用扩展配置

2.扩展配置使用方法如下

扩展配置方式一 折叠原码

# 多配置加载

# 使用默认的 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

扩展配置方式二 折叠原码

ext-config:

  - data-id: ${spring.application.name}-discovery.yml

  - data-id: ${spring.application.name}-log.yml

      group: COMMON

  - data-id: ${spring.application.name}-db.yml

      group: COMMON

      refresh: true

  - data-id: ${spring.application.name}-redis.yml

      group: COMMON

  

#扩展文件,目前用于全局共享,下面的优先级高

ext-config:

  - data-id: common-platform.yaml

    group: common

    refresh: true

  - data-id: common-customer.yaml

    group: common

    refresh: true

3.说明:

  • 通过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来手动开启。

4.注意事项:

  • 多个DataId同时配置时,它的优先级关系是 spring.cloud.nacos.config.ext-config[n].data-id 的值越大,优先级越高,即先加载
  • spring.cloud.nacos.config.ext-config[n].data-id= 必须带上扩展名,即文件格式,支持properties,也支持yaml/yml。此时spring.cloud.nacos.config.file-extension 的配置对自定义扩展的配置的data-id是无效的。

三、共享配置

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

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

共享配置 折叠原码

# 共享配置

spring.cloud.nacos.config.shared-dataids=common-log.yaml,common-redis.yaml

spring.cloud.nacos.config.refreshable-dataids=common-log.yaml

  

#nacos配置中心共享文件,目前用于验证现场问题,预留一个文件位置

#多个文件用逗号分隔,后面的优先级高

shared-dataids: share-${spring.application.name}.yaml

#需要自动刷新配置的文件,多个用逗号分隔

refreshable-dataids: share-${spring.application.name}.yaml

1.说明:

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

2.注意事项:

  • spring.cloud.nacos.config.share-dataids 的配置加载顺序是按照从左到右的,所以如果出现相同的配置时,后面的会覆盖前面的。
  • 使用spring.cloud.nacos.config.share-dataids 来配置共享配置时,需要加上后缀名,即properties,yaml/yml.此时的spring.cloud.nacos.config.file-extension 的配置对此项无效。
  • 通过使用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。

Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐