nacos如何做配置中心？自带自动刷新配置功能？这一篇文章让你明明白白！-CSDN博客

秃了也弱了
310 阅读8分钟

​

目录

nacos做配置中心

pom加上：

bootstrap.yml（优先级高于application.yml）

application.yml

主启动类

controller：

配置yml和nacos上配置名称对应关系：

nacos做分类配置

Namespace+Group+Data ID三者关系？为什么这样设计？

如何配置相应的命名空间、DataId、Group下面的配置文件呢？

总结

一、（补充）

1、什么是Nacos配置中心

2、Nacos配置中心的架构

3、Nacos配置中心核心API

4、nacos支持配置的动态更新

5、支持profile粒度的配置

6、支持自定义 namespace 的配置

7、支持自定义 Group 的配置

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

9、配置的优先级

10、@RefreshScope实现动态感知

nacos做配置中心

pom加上：

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

bootstrap.yml（优先级高于application.yml）

# nacos配置
server:
  port: 3377

spring:
  application:
    name: nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #Nacos服务注册中心地址
      config:
        server-addr: localhost:8848 #Nacos作为配置中心地址
        file-extension: yaml #指定yaml格式的配置

# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# nacos-config-client-dev.yaml

application.yml

spring:
  profiles:
    active: dev # 表示开发环境
    #active: test # 表示测试环境
    #active: info

主启动类

@EnableDiscoveryClient
@SpringBootApplication
public class NacosConfigClientMain3377
{
    public static void main(String[] args) {
        SpringApplication.run(NacosConfigClientMain3377.class, args);
    }
}

controller：

@RestController
@RefreshScope //支持Nacos的动态刷新功能。
public class ConfigClientController
{
    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/config/info")
    public String getConfigInfo() {
        return configInfo;
    }
}

配置yml和nacos上配置名称对应关系：

​编辑

nacos做分类配置

Namespace+Group+Data ID三者关系？为什么这样设计？

是什么：

    类似Java里面的package名和类名。

    最外层的namespace是可以用于区分部署环境的，Group和DataID逻辑上区分两个目标对象。

默认情况：

    Namespace=public，Group=DEFAULT_GROUP，默认Cluster是DEFAULT

    Nacos默认的命名空间是public，Namespace主要用来实现隔离。

    比如说我们现在有三个环境：开发、测试、生产环境，我们就可以创建三个Namespace，不同的Namesoace之间是隔离的。

    Group默认是DEFFAULT_GROUP，Group可以把不同的微服务划分到同一个分组里面去。

    

    Service就是微服务；一个Service可以包含多个Cluster（集群），Nacos默认Cluster是DEFAULT，Cluster是对指定微服务的一个虚拟划分。

    比方说为了容灾，将Service微服务分别部署在了杭州机房和广州机房。

    这时就可以给杭州机房的Service微服务起一个集群名称（HZ），给广州机房的Service微服务起一个集群名称（GZ），还可以尽量让同一个机房的微服务互相调用，以提升性能。

    最后是Instance，就是微服务的实例。

​编辑

如何配置相应的命名空间、DataId、Group下面的配置文件呢？

# nacos配置
server:
  port: 3377

spring:
  application:
    name: nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #Nacos服务注册中心地址
      config:
        server-addr: localhost:8848 #Nacos作为配置中心地址
        file-extension: yaml #指定yaml格式的配置
        group: DEV_GROUP #指定Group
        namespace: 7d8f0f5a-6a53-4785-9686-dd460158e5d4 #指定namespace的id

# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
# nacos-config-client-dev.yaml

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

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

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

总结

相当于读取到某个namespace下的某个DataId、某个Group的指定文件！

一、（补充）

1、什么是Nacos配置中心

官方文档： github.com/alibaba/spr…

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

​编辑

2、Nacos配置中心的架构

​编辑

3、Nacos配置中心核心API

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;

public class ConfigServerDemo {

    public static void main(String[] args) throws NacosException, InterruptedException {
        String serverAddr = "localhost";
        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("===recieve:" + configInfo);
            }

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

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

        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(300000);

    }
}

4、nacos支持配置的动态更新

@SpringBootApplication
public class NacosConfigApplication {

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

		while(true) {
			//当动态配置刷新时，会更新到 Enviroment中，因此这里每隔一秒中从Enviroment中获取配置
			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(1);
		}

	}

}

每次从Environment中获取配置，都是最新的（随着nacos而变化！）。

5、支持profile粒度的配置

spring-cloud-starter-alibaba-nacos-config 在加载配置的时候，不仅仅加载了以 dataid 为 spring.application.name.{spring.application.name}.{file-extension:properties} 为前缀的基础配置，还加载了dataid为 spring.application.name−{spring.application.name}-{profile}.${file-extension:properties} 的基础配置。

在日常开发中如果遇到多套环境下的不同配置，可以通过Spring 提供的 ${spring.profiles.active} 这个配置项来配置。

 spring.profiles.active=dev

6、支持自定义 namespace 的配置

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

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

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

7、支持自定义 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

8、支持自定义扩展的 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=REFRESH_GROUP
spring.cloud.nacos.config.sharedConfigs[0].refresh=true

# config external configuration
# 支持一个应用多个 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

9、配置的优先级

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−{spring.application.name}-{profile}.${file-extension:properties}

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

${spring.application.name}

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

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

10、 @RefreshScope实现动态感知

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

@RefreshScope注解

@RestController
@RefreshScope
public class TestController {

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

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

}

@RefreshScope 导致@Scheduled定时任务失效问题

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

@SpringBootApplication
@EnableScheduling // 开启定时任务功能
public class NacosConfigApplication {
}

@RestController
@RefreshScope //动态感知修改后的值
public class TestController {

	@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("定时任务正常执行。。。。。。");
	}


}

测试结果：

当在配置中心变更属性后，定时任务失效

当再次访问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 的装配机制就是新的属性了

解决方案

实现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();
	}
}

​

avatar
文章
阅读
粉丝