04_Nacos Config配置中心

配置中心介绍：

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

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

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 ：

在注册中心添加配置：

增加配置信息：server.port = 9000

配置中心核心API接口：

public class ConfigServerDemo {

    public static void main(String[] args) throws NacosException, InterruptedException {
        String serverAddr = "127.0.0.1:8848";
        String dataId = "nacos-config-demo.yaml";
        String group = "DEFAULT_GROUP";
        Properties properties = new Properties();
        properties.put(PropertyKeyConst.SERVER_ADDR, serverAddr);

        //获取配置中心服务
        ConfigService configService = NacosFactory.createConfigService(properties);

        //从配置中心拉取配置
        String content = configService.getConfig(dataId, group, 5000);
        System.out.println(content);

        //注册监听器
        configService.addListener(dataId, group, new Listener() {
            @Override
            public void receiveConfigInfo(String configInfo) {
                System.out.println("感知配置变化:" + configInfo);
            }

            @Override
            public Executor getExecutor() {
                return null;
            }
        });

        //发布配置
        //发送properties格式
        boolean publishConfig = configService.publishConfig(dataId, group, "common.age=30", ConfigType.PROPERTIES.getType());
        System.out.println(publishConfig);
        Thread.sleep(3000);

        //从配置中心拉取配置
        content = configService.getConfig(dataId, group, 5000);
        System.out.println(content);

        // 删除配置
        boolean isRemoveOk = configService.removeConfig(dataId, group);
        System.out.println(isRemoveOk);
        Thread.sleep(3000);

        // 删除后则获取不到该配置

        content = configService.getConfig(dataId, group, 5000);
        System.out.println(content);
        Thread.sleep(Integer.MAX_VALUE);
    }
}

Spring Cloud 整合Nacos配置中心快速开始

nacos server配置中心中准备配置数据：

nacos server中新建nacos-config.properties，并新增配置内容：

user.name = yyj
user.age = 666

微服务接入配置中心

        <!--nacos配置中心-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>

添加bootstrap.properties

必须使用 bootstrap.properties 配置文件来配置Nacos Server 地址

spring.application.name=nacos-config
# 配置中心地址
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

# dataid 格式： `${spring.application.name}-${profile}.${file-extension:properties}`
# dataid 为 yaml 的文件扩展名配置方式   nacos-config-dev.yaml
spring.cloud.nacos.config.file-extension=yaml
#profile粒度的配置，对应nacos-config-prod.yaml
spring.profiles.active=dev

在 Nacos Spring Cloud 中，dataId 的完整格式如下：

${prefix}-${spring.profiles.active}.${file-extension}

prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。

spring.profiles.active 即为当前环境对应的 profile，详情可以参考 SpringBoot文档。注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.${file-extension}

file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。

启动服务，测试微服务是否使用配置中心的配置

    public static void main(String[] args) throws InterruptedException {
        ConfigurableApplicationContext applicationContext = SpringApplication.run(NacosConfigApplication.class, args);

        while (true) {
            //当动态配置刷新时，会更新到 Environment中，因此这里每隔3秒中从Environment中获取配置
            String userName = applicationContext.getEnvironment().getProperty("common.name");
            String userAge = applicationContext.getEnvironment().getProperty("common.age");
            System.err.println("common name:" + userName + "; age: " + userAge);
            TimeUnit.SECONDS.sleep(3);
        }
    }

Config相关配置

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

支持配置的动态更新

        while (true) {
            //当动态配置刷新时，会更新到 Environment中，因此这里每隔3秒中从Environment中获取配置
            String userName = applicationContext.getEnvironment().getProperty("common.name");
            String userAge = applicationContext.getEnvironment().getProperty("common.age");
            System.err.println("common name:" + userName + "; age: " + userAge);
            TimeUnit.SECONDS.sleep(3);
        }

支持profile粒度的配置

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} 这个配置项来配置。

#profile粒度的配置，对应nacos-config-dev.yaml
spring.profiles.active=dev

支持自定义 namespace 的配置

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

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

#自定义 namespace 的配置
spring.cloud.nacos.config.namespace=3be29f81-293f-4e4a-919d-885eacf9a602

支持自定义 Group 的配置

Group是组织配置的维度之一。通过一个有意义的字符串（如 Buy 或 Trade ）对配置集进行分组，从而区分 Data ID 相同的配置集。当您在 Nacos 上创建一个配置时，如果未填写配置分组的名称，则配置分组的名称默认采用 DEFAULT_GROUP 。

配置分组的常见场景：

不同的应用或组件使用了相同的配置类型，如 database_url 配置和 MQ_topic 配置。

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

# 自定义 Group 的配置
spring.cloud.nacos.config.group=DEFAULT_GROUP

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

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

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

# 自定义 Data Id 的配置
#不同工程的通用配置 支持共享的 DataId
spring.cloud.nacos.config.sharedConfigs[0].data-id= common.yaml
spring.cloud.nacos.config.sharedConfigs[0].group=DEFAULT_GROUP
spring.cloud.nacos.config.sharedConfigs[0].refresh=true
# 支持一个应用多个 DataId 的配置
spring.cloud.nacos.config.extensionConfigs[0].data-id=nacos.yaml
spring.cloud.nacos.config.extensionConfigs[0].group=REFRESH_GROUP
spring.cloud.nacos.config.extensionConfigs[0].refresh=true
# config external configuration
spring.cloud.nacos.config.extensionConfigs[1].data-id=ext-common.yaml
spring.cloud.nacos.config.extensionConfigs[1].group=REFRESH_GROUP
spring.cloud.nacos.config.extensionConfigs[1].refresh=true

配置的优先级

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

A: 通过 spring.cloud.nacos.config.shared-configs 支持多个共享 Data Id 的配置

B: 通过 spring.cloud.nacos.config.ext-config[n].data-id 的方式支持多个扩展Data Id 的配置

C: 通过内部相关规则(应用名、应用名+ Profile )自动生成相关的 Data Id 配置

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

优先级从高到低：

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

${spring.application.name}.${file-extension:properties}

${spring.application.name}

extensionConfigs 一个微服务的多个配置，比如 nacos,mybatis

sharedConfigs 多个微服务公共配置，比如 redis

@RefreshScope实现动态感知

@Value注解可以获取到配置中心的值，但是无法动态感知修改后的值，需要利用@RefreshScope注解

@RestController
@RefreshScope  //动态感知修改后的值
public class TestController implements ApplicationListener<RefreshScopeRefreshedEvent> {

    @Value("${common.age}")
    String age;
    @Value("${common.name}")
    String name;

    @GetMapping("/common")
    public String hello() {
        return name + "," + age;
    }
}

@RefreshScope 导致@Scheduled定时任务失效问题，当利用@RefreshScope刷新配置后会导致定时任务失效

@RestController
@RefreshScope  //动态感知修改后的值
public class TestController implements ApplicationListener<RefreshScopeRefreshedEvent> {

    @Value("${common.age}")
    String age;
    @Value("${common.name}")
    String name;

    @GetMapping("/common")
    public String hello() {
        return name + "," + age;
    }

    //触发@RefreshScope执行逻辑会导致@Scheduled定时任务失效
    @Scheduled(cron = "*/3 * * * * ?")  //定时任务每隔3s执行一次
    public void execute() {
        System.out.println("定时任务正常执行。。。。。。");
    }

    @Override
    public void onApplicationEvent(RefreshScopeRefreshedEvent event) {
        this.execute();
    }
}

测试结果：

当在配置中心变更属性后，定时任务失效，当再次访问http://localhost:8010/common，定时任务生效

原因：@RefreshScope修饰的bean的属性发生变更后，会从缓存中清除。此时没有这个bean，定时任务当然也就不生效了。

详细原因如下：

1. @RefreshScope 注解标注了@Scope 注解，并默认了ScopedProxyMode.TARGET_CLASS属性，此属性的功能就是创建一个代理，在每次调用的时候都用它来调用GenericScope#get 方法来获取bean对象。

2. 在GenericScope 里面包装了一个内部类 BeanLifecycleWrapperCache 来对加了@RefreshScope 的bean进行缓存，使其在不刷新时获取的都是同一个对象。

3. 如属性发生变更会调用 ContextRefresher#refresh()——>RefreshScope#refreshAll() 进行缓存清理方法调用，并发送刷新事件通知 ——>调用GenericScope#destroy() 实现清理缓存。

4. 当下一次使用此bean对象时，代理对象会调用GenericScope#get(String name,ObjectFactory<?> objectFactory) 方法创建一个新的bean对象，并存入缓存中，此时新对象因为Spring 的装配机制就是新的属性了。

核心源码：GenericScope#get

解决方案

实现Spring事件监听器，监听 RefreshScopeRefreshedEvent事件，监听方法中进行一次定时方法的调用。

@RestController
@RefreshScope  //动态感知修改后的值
public class TestController implements ApplicationListener<RefreshScopeRefreshedEvent> {

    @Value("${common.age}")
    String age;
    @Value("${common.name}")
    String name;

    @GetMapping("/common")
    public String hello() {
        return name + "," + age;
    }

    //触发@RefreshScope执行逻辑会导致@Scheduled定时任务失效
    @Scheduled(cron = "*/3 * * * * ?")  //定时任务每隔3s执行一次
    public void execute() {
        System.out.println("定时任务正常执行。。。。。。");
    }

    @Override
    public void onApplicationEvent(RefreshScopeRefreshedEvent event) {
        this.execute();
    }
}

posted @ 2023-04-27 00:17 1640808365 阅读(124) 评论(0) 编辑收藏举报

刷新页面返回顶部

Loading

YYJ-Blog | 业精于勤，荒于嬉。

04_Nacos Config配置中心

配置中心介绍：

什么是Nacos配置中心：

Nacos配置中心的架构：

Nacos配置中心核心API ：

配置中心核心API接口：

Spring Cloud 整合Nacos配置中心快速开始

nacos server配置中心中准备配置数据：

微服务接入配置中心

添加bootstrap.properties

启动服务，测试微服务是否使用配置中心的配置

Config相关配置

支持配置的动态更新

支持profile粒度的配置

支持自定义 namespace 的配置

支持自定义 Group 的配置

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

配置的优先级

@RefreshScope实现动态感知

解决方案

公告

Loading

YYJ-Blog | 业精于勤，荒于嬉。

04_Nacos Config配置中心

配置中心介绍：

什么是Nacos配置中心 ：

Nacos配置中心的架构：

Nacos配置中心核心API ：

配置中心核心API接口：

Spring Cloud 整合Nacos配置中心快速开始

nacos server配置中心中准备配置数据：

微服务接入配置中心

添加bootstrap.properties

启动服务，测试微服务是否使用配置中心的配置

Config相关配置

支持配置的动态更新

支持profile粒度的配置

支持自定义 namespace 的配置

支持自定义 Group 的配置

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

配置的优先级

@RefreshScope实现动态感知

解决方案

公告

什么是Nacos配置中心：