【Nacos】Nacos配置中心的使用与SpringCloud整合

在微服务架构中，当系统从一个单体应用，被拆分成分布式系统上一个个服务节点后，配置文件也必须跟着迁移（分割），这样配置就分散了，不仅如此，分散中还包含着冗余。配置中心将配置从各应用中剥离出来，对配置进行统一管理，应用自身不需要自己去管理配置。

配置中心的服务流程如下：

1. 用户在配置中心更新配置信息
2. 服务A和服务B及时得到配置更新通知，从配置中心获取配置

配置中心就是一种统一管理各种应用配置的基础服务组件。

什么是Nacos配置中心

官方文档： https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config

Nacos提供用于存储配置和其他元数据的key/value存储，为分布式系统中的外部化配置提供服务器端和客户端支持。使用Spring Cloud Alibaba Nacos Config组件，您可以在Nacos Server集中管理你Spring Cloud应用的外部属性配置。

Nacos配置中心的架构如下：

Nacos配置中心核心API的使用

Nacos配置中心的核心接口为ConfigService。

package com.morris.order.demo;

import com.alibaba.nacos.api.NacosFactory;
import com.alibaba.nacos.api.PropertyKeyConst;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.ConfigType;
import com.alibaba.nacos.api.config.listener.Listener;
import com.alibaba.nacos.api.exception.NacosException;

import java.util.Properties;
import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;

/**
 * Nacos配置中心核心API的使用
 */
public class NacosConfigDemo {
    public static void main(String[] args) throws NacosException, InterruptedException {

        Properties properties = new Properties();
        properties.setProperty(PropertyKeyConst.SERVER_ADDR, "127.0.0.1:8848");
        ConfigService configService = NacosFactory.createConfigService(properties);

        String dateId = "order";
        String group = "DEFAULT_GROUP";

        // 查询Nacos配置中心的配置
        String content = configService.getConfig(dateId, group, 1_000);

        System.out.println("config: " + content);

        configService.addListener(dateId, group, new Listener() {
            @Override
            public Executor getExecutor() {
                return null;
            }

            @Override
            public void receiveConfigInfo(String configInfo) {
                // 监听配置
                System.out.println("config change: " + configInfo);
            }
        });

        // 休眠一会让上面的线程池启动
        TimeUnit.SECONDS.sleep(300);
        // 发布配置
        configService.publishConfig(dateId, group, "age: 40", ConfigType.PROPERTIES.getType());
    }
}

Spring Cloud整合Nacos配置中心

引入maven依赖：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

配置文件配置Nacos Server地址：

spring:
  application:
    name: order-service

  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848

启动服务order-service，测试微服务是否能动态使用配置中心的配置：

package com.morris.order;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

import java.util.concurrent.TimeUnit;

@SpringBootApplication
public class OrderServiceApplication {

    public static void main(String[] args) throws InterruptedException {
        ConfigurableApplicationContext applicationContext = SpringApplication.run(OrderServiceApplication.class, args);
        while (true) {
            //当动态配置刷新时，会更新到 Enviroment中，因此这里每隔一秒中从Enviroment中获取配置
            String age = applicationContext.getEnvironment().getProperty("age");
            System.err.println("age: " + age);
            TimeUnit.SECONDS.sleep(1);
        }
    }

}

一开始age为null，当在nacos配置中心增加配置order-service时，age就会自动获取最新的值。

配置说明

Nacos数据模型Key由三元组唯一确定, Namespace默认是空串，公共命名空间（public），分组默认是 DEFAULT_GROUP。

支持profile粒度的配置

在Nacos Spring Cloud中，dataId的完整格式如下：${prefix}-${spring.profiles.active}.${file-extension}

• prefix: 默认为spring.application.name的值，也可以通过配置项spring.cloud.nacos.config.prefix来配置
• spring.profiles.active：即为当前环境对应的profile，注意当spring.profiles.active为空时，对应的连接符-也将不存在，dataId的拼接格式变成 ${prefix}.${file-extension}
• file-exetension：为配置内容的数据格式，可以通过配置项spring.cloud.nacos.config.file-extension来配置。

spring-cloud-starter-alibaba-nacos-config在加载配置的时候，不仅仅加载了以dataid为${spring.application.name}.${file-extension:properties}为前缀的基础配置，还加载了dataid为${spring.application.name}-${profile}.${file-extension:properties}的基础配置。在日常开发中如果遇到多套环境下的不同配置，可以通过Spring提供的${spring.profiles.active}这个配置项来配置。

如：

spring.profiles.active: dev

支持自定义namespace的配置

用于进行租户粒度的配置隔离。不同的命名空间下，可以存在相同的Group或Data ID的配置。Namespace的常用场景之一是不同环境的配置的区分隔离，例如开发测试环境和生产环境的资源（如配置、服务）隔离等。

在没有明确指定${spring.cloud.nacos.config.namespace}配置的情况下，默认使用的是Nacos上Public这个namespace。如果需要使用自定义的命名空间，可以通过以下配置来实现：

spring.cloud.nacos.config.namespace=71bb9785-231f-4eca-b4dc-6be446e12ff8

支持自定义Group的配置

Group是组织配置的维度之一。通过一个有意义的字符串（如Buy或Trade）对配置集进行分组，从而区分Data ID相同的配置集。

当您在Nacos上创建一个配置时，如果未填写配置分组的名称，则配置分组的名称默认采用DEFAULT_GROUP。配置分组的常见场景：不同的应用或组件使用了相同的配置类型，如database_url配置和MQ_topic配置。

在没有明确指定${spring.cloud.nacos.config.group}配置的情况下，默认是DEFAULT_GROUP。如果需要自定义自己的Group，可以通过以下配置来实现：

spring.cloud.nacos.config.group=DEVELOP_GROUP

支持自定义扩展的Data Id配置

Data ID是组织划分配置的维度之一。Data ID通常用于组织划分系统的配置集。一个系统或者应用可以包含多个配置集，每个配置集都可以被一个有意义的名称标识。Data ID通常可以使用采用应用名称的命名规则保证全局唯一性。此命名规则非强制。

通过自定义扩展的Data Id配置，既可以解决多个应用间配置共享的问题，又可以支持一个应用有多个配置文件。

自定义Data Id的使用：

#不同工程的通用配置 支持共享的DataId
spring.cloud.nacos.config.sharedConfigs[0].data-id=common.yaml
spring.cloud.nacos.config.sharedConfigs[0].group=REFRESH_GROUP
spring.cloud.nacos.config.sharedConfigs[0].refresh=true

一个应用多个扩展DataId的配置使用：

spring.cloud.nacos.config.extensionConfigs[0].data-id=ext-config-common01.properties
spring.cloud.nacos.config.extensionConfigs[0].group=REFRESH_GROUP
spring.cloud.nacos.config.extensionConfigs[0].refresh=true

spring.cloud.nacos.config.extensionConfigs[1].data-id=ext-config-common02.properties
spring.cloud.nacos.config.extensionConfigs[1].group=REFRESH_GROUP
spring.cloud.nacos.config.extensionConfigs[1].refresh=true

配置的优先级

Spring Cloud Alibaba Nacos Config目前提供了三种配置能力从Nacos拉取相关的配置。

1. 通过spring.cloud.nacos.config.shared-configs支持多个共享Data Id的配置
2. 通过spring.cloud.nacos.config.ext-config[n].data-id的方式支持多个扩展Data Id的配置
3. 通过内部相关规则(应用名、应用名+Profile)自动生成相关的Data Id配置

当三种方式共同使用时，他们的一个优先级关系是:1 < 2 < 3

优先级从高到低：

• ${spring.application.name}-${profile}.${file-extension:properties}
• ${spring.application.name}.${file-extension:properties}
• ${spring.application.name}
• extension-configs
• shared-configs