【深入理解SpringCloud微服务】深入理解nacos配置中心（五）——客户端监听配置变更并刷新的源码分析

于 2024-09-14 09:34:33 发布
阅读量557 收藏 7
点赞数 17
分类专栏： 深入理解SpringCloud微服务 文章标签： spring cloud 微服务 java spring 架构 nacos spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43889578/article/details/137194807
版权

【深入理解SpringCloud微服务】深入理解nacos配置中心（五）——客户端监听配置变更并刷新的源码分析

原理回顾

在之前的《宏观理解nacos配置中心原理》这一篇文章中，我们分析过nacos客户端监听配置变更并刷新配置的这一部分的流程。

首先是nacos会给当前客户端引用的每个配置文件都添加一个监听器，这个监听器收到通知会触发配置刷新的操作。

在这里插入图片描述

以上是给被客户端引用的配置文件添加监听器的流程。在SpringBoot启动完成的时候，会发布ApplicationReadyEvent事件，触发Spring的事件监听机制，该事件被NacosContextRefresher接收并处理，然后NacosContextRefresher的onApplicationEvent方法就会给每个被客户端引用的配置文件创建一个CacheData对象，然后在CacheData对象中添加一个上面所说的监听器。

在这里插入图片描述

我们还解析了这个CacheData的结构，包含了配置文件的dataId、group、tenant（也就是namespace）、配置文件内容content，配置文件MD5，监听器列表listeners等成员属性。

既然给每个被客户端引用的配置文件添加了监听器，那么就会有触发该监听器的地方。

在nacos配置中心客户端启动的时候，会创建NacosConfigService，NacosConfigService的构造方法中又会创建ClientWorker，然后ClientWorker初始化的时候会启动定时任务。这个监听器就是在ClientWorker的定时任务中触发的。

在这里插入图片描述
ClientWorker的定时任务流程大概四这样：

  1. 通过http请求获取服务端中发生变更的DataID列表。
  2. 根据这些DataID列表再次请求服务端获取对应的配置文件内容content。
  3. 再把content赋值到CacheData并重新计算MD5值。
  4. 计算出来的MD5值跟CacheData的listeners中每个Listener保存的老MD5值比较，如果不一致，就会调用Listener的receiveConfigInfo()方法。

这里调用Listener的receiveConfigInfo()方法就会调用到NacosContextRefresher添加的监听器的receiveConfigInfo()方法，也就是说监听器就是在这里触发的。

NacosContextRefresher添加的这个监听器的receiveConfigInfo()方法会发布一个RefreshEvent事件。

在这里插入图片描述

发布的RefreshEvent事件会触发Spring的事件监听机制，会被spring-cloud-context包提供的RefreshEventListener监听器接收并处理，触发配置刷新。这里的配置刷新不是nacos实现的，nacos只是发布了一个RefreshEvent事件，后续的都是spring-cloud-context里面的公共逻辑。

因此我们本篇文章只会讲到nacos发布RefreshEvent事件，后续的逻辑在下一篇文章中分析。

源码分析

给当前微服务引用的配置文件创建CacheData并添加监听器

ApplicationReadyEvent事件发布

SpringBoot启动之后，在SpringApplication的run方法执行到最后，会在调用listeners.running(context)时发布ApplicationReadyEvent事件。

SpringApplication#run(java.lang.String…)

	public ConfigurableApplicationContext run(String... args) {
		...

		try {
			listeners.running(context);
		}
		catch (...) {...}
		return context;
	}

SpringApplicationRunListeners#running

	void running(ConfigurableApplicationContext context) {
		for (SpringApplicationRunListener listener : this.listeners) {
			listener.running(context);
		}
	}

EventPublishingRunListener#running

	@Override
	public void running(ConfigurableApplicationContext context) {
		context.publishEvent(new ApplicationReadyEvent(this.application, this.args, context));
		...
	}

在这里插入图片描述

NacosContextRefresher监听ApplicationReadyEvent事件

在spring-cloud-starter-alibaba-nacos-config的spring.factories文件中指定了nacos的自动配置类NacosConfigAutoConfiguration，在NacosConfigAutoConfiguration中通过@Bean注解配置了NacosContextRefresher。

NacosContextRefresher实现了ApplicationListener接口监听ApplicationReadyEvent事件。

在这里插入图片描述

NacosContextRefresher#onApplicationEvent(ApplicationReadyEvent)

NacosContextRefresher#onApplicationEvent(ApplicationReadyEvent)

	public void onApplicationEvent(ApplicationReadyEvent event) {
		if (this.ready.compareAndSet(false, true)) {
			this.registerNacosListenersForApplications();
		}
	}

NacosContextRefresher#registerNacosListenersForApplications()

	private void registerNacosListenersForApplications() {
		if (isRefreshEnabled()) {
			for (NacosPropertySource propertySource : NacosPropertySourceRepository
					.getAll()) {
				...
				// 引用的配置文件对应的dataId
				String dataId = propertySource.getDataId();
				// 注册监听器
				registerNacosListener(propertySource.getGroup(), dataId);
			}
		}
	}

NacosContextRefresher#registerNacosListener(String, String)

	private void registerNacosListener(final String groupKey, final String dataKey) {
		...
		try {
			// 调用NacosConfigService添加监听器
			configService.addListener(dataKey, groupKey, listener);
		}
		catch (...) {...}
	}

沿着NacosContextRefresher的onApplicationEvent方法一路下来，就可以看到调用了NacosConfigService的addListener方法添加监听器。
在这里插入图片描述

NacosConfigService#addListener(String, String, Listener)

    public void addListener(String dataId, String group, Listener listener) throws NacosException {
    	// 调用ClientWorker添加监听器
        worker.addTenantListeners(dataId, group, Arrays.asList(listener));
    }

NacosConfigService的构造方法会创建ClientWorker，NacosConfigService的addListener就是直接调用ClientWorker添加监听器。

在这里插入图片描述

ClientWorker#addTenantListeners(String, String, List<? extends Listener>)

    public void addTenantListeners(String dataId, String group, List<? extends Listener> listeners)
            throws NacosException {
        ...
        // 往ClientWorker的Map中添加一个CacheData并返回
        CacheData cache = addCacheDataIfAbsent(dataId, group, tenant);
        synchronized (cache) {
            for (Listener listener : listeners) {
            	// 往CacheData中添加指定监听器
                cache.addListener(listener);
            }
            ...
        }
    }

ClientWorker这样的的成员变量：

    /**
     * groupKey -> cacheData.
     */
    private final AtomicReference<Map<String, CacheData>> cacheMap = new AtomicReference<Map<String, CacheData>>(
            new HashMap<String, CacheData>());

groupKey就是根据dataId, group, tenant三元组按一定规则拼接而成的字符串，作为Map中该CacheData对应的key，每个dataId, group, tenant三元组对应就是一个配置文件，在Map中都有一个groupKey与CacheData的映射。

ClientWorker的addTenantListeners方法就是创建一个CacheData并放入这个cacheMap中，然后往这个CacheData中添加一个指定的监听器listener。

在这里插入图片描述

CacheData

CacheData的结构我们已经分析过，包含了配置文件的dataId、group、tenant（也就是namespace）、配置文件内容content，配置文件MD5,，监听器列表listeners等成员属性。

public class CacheData {
    
    ...
    
    public final String dataId;
    
    public final String group;
    
    public final String tenant;
    
    private final CopyOnWriteArrayList<ManagerListenerWrap> listeners;
    
    private volatile String md5;
   
   	...
    
    private volatile String content;
        
	...
}

在这里插入图片描述

ClientWorker定时任务

    public NacosConfigService(Properties properties) throws NacosException {
		...
		// 创建ClientWorker
        this.worker = new ClientWorker(this.configFilterChainManager, serverListManager, properties);
		...
        
    }

    public ClientWorker(final ConfigFilterChainManager configFilterChainManager, ServerListManager serverListManager,
            final Properties properties) throws NacosException {
		...
		// 创建ConfigRpcTransportClient
        agent = new ConfigRpcTransportClient(properties, serverListManager);
		...
		// 设置定时任务线程池ScheduledExecutorService
        agent.setExecutor(executorService);
        // 启动定时任务
        agent.start();
        
    }

在NacosConfigService的构造方法会创建ClientWorker，ClientWorker的构造方法会创建一个ConfigRpcTransportClient，给这个ConfigRpcTransportClient设置一个定时任务线程池ScheduledExecutorService，然后调用这个ConfigRpcTransportClient的start()方法启动定时任务。

在这里插入图片描述

ConfigTransportClient#start()

ConfigTransportClient#start()

    public void start() throws NacosException {
        ...
        startInternal();
    }

ClientWorker.ConfigRpcTransportClient#startInternal()

       public void startInternal() {
            executor.schedule(() -> {
                while (!executor.isShutdown() && !executor.isTerminated()) {
                    try {
                    	// 从listenExecutebell这个队列中获取一个元素，阻塞等待5秒，如果没有则返回
                    	// 客户端会在接收到服务端通知时添加一个元素到这个队列中
                        listenExecutebell.poll(5L, TimeUnit.SECONDS);
                        ...
                        // 5秒后还是没有从队列中获取到元素，也往下执行
                        executeConfigListen();
                    } catch (...) {...}
                }
            }, 0L, TimeUnit.MILLISECONDS);
            
        }

ConfigTransportClient的startInternal方法调用上面设置的ScheduledExecutorService执行定时任务，定时任务是一个while循环，每一轮循环先从listenExecutebell这个队列中poll一个元素，这个listenExecutebell队列其实会在客户端收到服务端发送的配置变更通知时，往里面offer一个元素，也就是说如果listenExecutebell.poll()在5秒内返回了，说明收到了服务端发送的配置变更通知，如果5秒后还是没有返回，那么也继续往下执行，调用executeConfigListen()方法。

在这里插入图片描述

ClientWorker.ConfigRpcTransportClient#executeConfigListen()

        public void executeConfigListen() {
            
            ...
                    try {
                        ...
                        // 请求nacos服务端获取发生配置变更的配置文件信息
                        ConfigChangeBatchListenResponse configChangeBatchListenResponse = (ConfigChangeBatchListenResponse) requestProxy(rpcClient, configChangeListenRequest);
                        if (configChangeBatchListenResponse.isSuccess()) {
                            
                            ...
                            if (!CollectionUtils.isEmpty(configChangeBatchListenResponse.getChangedConfigs())) {
                                ...
                                // 遍历每个发生变更的配置
                                for (ConfigChangeBatchListenResponse.ConfigContext changeConfig : configChangeBatchListenResponse
                                        .getChangedConfigs()) {
                                    ...
                                    // 刷新配置
                                    refreshContentAndCheck(changeKey, !isInitializing);
                                }
                                
                            }
                            ...
        }

ConfigTransportClient的executeConfigListen方法会请求服务端获取发生配置变更的配置文件信息，然后遍历每个发生变更的配置，调用refreshContentAndCheck方法刷新配置。

在这里插入图片描述

然后进入到ClientWorker的refreshContentAndCheck方法。

ClientWorker#refreshContentAndCheck(java.lang.String, boolean)

    private void refreshContentAndCheck(String groupKey, boolean notify) {
    	// 根据groupKey拿到CacheData
    	// 这个groupKey也是根据dataId, group, tenant三元组拼接而成的，与放入cacheMap时的拼接规则一样
        CacheData cache = cacheMap.get().get(groupKey);
        if (cache != null) {
            refreshContentAndCheck(cache, notify);
        }
    }

ClientWorker的refreshContentAndCheck方法从ClientWorker的cacheMap中根据groupKey获取对应的CacheData。这个groupKey也是根据dataId, group, tenant三元组拼接而成的，与放入cacheMap时的拼接规则是一样的。然后调用refreshContentAndCheck(cache, notify)，这个cache参数就是CacheData。

在这里插入图片描述

ClientWorker#refreshContentAndCheck(CacheData, boolean)

   private void refreshContentAndCheck(CacheData cacheData, boolean notify) {
        try {
        	// 发起RPC远程调用，获取变更后的配置文件内容
            ConfigResponse response = getServerConfig(cacheData.dataId, cacheData.group, cacheData.tenant, 3000L,
                    notify);
            ...
            // 变更后的配置文件内容更新到cacheData，同时会更新cacheData中的md5值
            cacheData.setContent(response.getContent());
           ...
           // 触发cacheData中的监听器
            cacheData.checkListenerMd5();
        } catch (...) {...}
    }

ClientWorker的refreshContentAndCheck方法首先发起RPC远程调用，获取变更后的配置文件内容，然后把变更后的配置文件内容更新到cacheData，最后调用cacheData.checkListenerMd5()触发cacheData中的监听器。

在这里插入图片描述

CacheData#checkListenerMd5()

    void checkListenerMd5() {
    	// 遍历CacheData中的每一个监听器
        for (ManagerListenerWrap wrap : listeners) {
        	// 比对CacheData中新的md5值和监听器中保存的旧md5值
            if (!md5.equals(wrap.lastCallMd5)) {
            	// 比对不相等，执行safeNotifyListener方法
                safeNotifyListener(dataId, group, content, type, md5, encryptedDataKey, wrap);
            }
        }
    }

checkListenerMd5方法会遍历CacheData中的每一个监听器，比对CacheData中新的md5值和监听器中保存的旧md5值，如果不相等，执行safeNotifyListener方法。

在这里插入图片描述

CacheData#safeNotifyListener(…)

    private void safeNotifyListener(..., final ManagerListenerWrap listenerWrap) {
        final Listener listener = listenerWrap.listener;
        ...
        		// 调用监听器的receiveConfigInfo方法
                listener.receiveConfigInfo(contentTmp);
                ...
                // 更新监听器的md5值
                listenerWrap.lastCallMd5 = md5;
                ...
        };

AbstractSharedListener#receiveConfigInfo(String)

listener.receiveConfigInfo(contentTmp)里面会调用到innerReceive方法，就进入了在NacosContextRefresher的registerNacosListener方法创建的监听器实现的innerReceive方法。

在这里插入图片描述

com.alibaba.cloud.nacos.refresh.NacosContextRefresher#registerNacosListener(String, String)

	private void registerNacosListener(final String groupKey, final String dataKey) {
		...
		Listener listener = listenerMap.computeIfAbsent(key,
				lst -> new AbstractSharedListener() {
					@Override
					public void innerReceive(String dataId, String group,
							String configInfo) {
						...
						// 发布一个RefreshEvent事件
						applicationContext.publishEvent(
								new RefreshEvent(this, null, "Refresh Nacos config"));
						...
					}
				});
		...
	}

这里的监听器的innerReceive方法被触发，发布一个RefreshEvent事件。

在这里插入图片描述

发布的RefreshEvent事件会触发Spring的事件监听机制，被spring-cloud-context包提供的RefreshEventListener监听器接收并处理，后续就是spring-cloud-context里面关于配置刷新的公共逻辑，在下一篇文章中分析。

在这里插入图片描述

黄俊懿
关注
专栏目录
nacos配置中心源码分析——长轮询动态刷新
weixin_36279234的博客
09-23 1236
所谓动态刷新是指nacos用户交互页面发布或者更新配置，在spring cloud微服务中是如何感知的，并且如何动态刷新配置？用户操作nacos UI交互页面发布配置请求，请求url：config/v1/cs/configs。请求来到nacos服务端的ConfigController.publishConfig()方法，由于没有选择beta发布，所以betaIp为空，tag好像是跟容器部署有关。所以直接执行如下if里面两个核心方法：persistService.insertOrUpdate()和Config
防止内卷和被潜规则，Spring Cloud Alibaba微服务架构实战派（上下册）｜35岁程序员那些事
huxian1234的专栏
11-25 9236
欢迎关注公众号：35岁程序员那些事 畅销书“Spring Cloud Alibaba微服务架构实战派（上下册）”作者。
【深入理解SpringCloud微服务】深入理解nacos配置中心（一）——宏观理解nacos配置中心原理
weixin_43889578的博客
08-31 821
nacos配置中心的作用就是在微服务架构中负责集中管理各个微服务工程的配置文件，原先散落到各个微服务本地的配置文件，现在都集中存储到nacos上，这样更方便管理和维护。nacos配置中心客户端以jar包的形式被各微服务引入，然后微服务启动的时候，会通过nacos配置中心客户端请求nacos服务端拉取该微服务对应的配置，然后把拉取到的配置加载到Environment中。nacos有一个控制台界面，可以在上面修改配置信息。
SpringCloud Alibaba实战和源码分析——Nacos1.4.1作为配置中心使用和源码分析（2）
qq_45546075的博客
08-07 914
配置文件的问题：配置文件的数量会随着服务的增加持续递增单个配置文件无法区分多个运行环境配置文件内容无法动态更新，需要重启服务引入配置文件：刚才架构就会成为这样。是由配置中心统一管理统一配置文件管理提供统一标准接口，服务根据标准接口自行拉取配置支持动态更新的到所有服务。
Nacos配置中心源码浅析
Java_dragon95的博客
05-24 865
nacos配置中心源码浅析
SpringCloud Alibaba——精读Nacos+CMDB+核心源码阅读（7w字长篇）
zhouhengzhe的博客
11-13 5431
1、服务发现与健康监测 2、动态配置服务 3、动态DNS服务 4、服务及其元数据管理动态配置服务让您能够以中心化、外部化和动态化的方式管理所有环境的配置。动态配置消除了配置变更时重新部署应用和服务的需要。配置中心化管理让实现无状态服务更简单，也让按需弹性扩展服务更容易。动态服务发现对以服务为中心的（例如微服务和云原生）应用架构方式非常关键。Nacos支持DNS-Based和RPC-Based（Dubbo、gRPC）模式的服务发现。Nacos也提供实时健康检查，以防止将请求发往不健康的主机或服务实例。借助Na
微服务组件nacos
sinat_34814635的博客
11-20 4438
Nacos /nɑ:kəʊs/ 是 Dynamic Naming and Configuration Service的首字母简称，一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。Nacos 致力于帮助您发现、配置和管理微服务。Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据及流量管理。Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。Nacos 是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。
Alibaba微服务组件Nacos注册中心实战
热门推荐
野心与梦
05-29 2万+
思考：不同的微服务如何维护复杂的调用关系？//服务之间通过RestTemplate调用，url写死 String url = "http://localhost:8020/order/findOrderByUserId/" + id;实现服务发现的设计思路：服务注册：就是将提供某个服务的模块信息(通常是这个服务的ip和端口)注册到1个公共的组件上去。服务发现：就是新注册的这个服务模块能够及时的被其他调用者发现。不管是服务新增和服务删减都能实现自动发现。
Nacos配置管理
03-21 5545
应用程序在启动和运行的时候往往需要读取一些配置信息，配置基本上伴随着应用程序的整个生命周期，比如：数据库连接参数、启动参数等。
彻底搞懂 Spring Cloud 前世今生 系列之 第⼀代 Spring Cloud 核⼼组件 ——Eureka
Captain Leo的专栏
03-18 212
Spring Cloud、第一代核心组件、Eureka、原理、主流服务中心对比、图解、细节详解、元数据详解、客户端详解、服务端详解、源码剖析、Eureka Server启动过程、服务接口暴露策略、服务注册接口、服务续约接口、注册服务、下架服务
Springcloud-注册中心-Eureka源码分析
F_Hello_World的博客
07-07 435
springCloud对于注册中心提供了很多的选择，例如实现CAP中AP的Eureka，实现了CP的zookeeper等，这里主要介绍使用的是给予Netflix的Eureka。 首先我们基于的springcloud的最新版本-Hoxton来介绍，这里使用的是springboot2.2.5，关于springboot与springCloud的版本对应关系可以参考下表： SpirngCloud Ve...
SpringCloud学习总结
jtsd2008lm的专栏
04-14 547
SpringCloud 一，微服务架构 1 架构演变 单体架构 =》垂直应用架构 =》SOA架构 =》 微服务架构 2 微服务架构： 微服务架构和SOA架构很明显的一个区别就是服务拆分粒度的不同，但是对于拉勾的架构发展来说，我们所看到的SOA阶段其实服务拆分粒度相对来说已经⽐较细了（超前哦！），所以上述拉勾SOA到拉勾微服务，从服务拆分上来说变化并不⼤，只是引入了相对完整的新⼀代Spring Cloud微服务技术。⾃然，上述我们看到的都是拉勾架构演变的阶段结果，每⼀个阶段其实...
SpringCloudAlibaba看的某马视频笔记
qq_44619964的博客
04-11 1472
----------------------------SpringCloudAlibaba---------------------------- SpringCloudAlibaba组件说明: ·服务注册与发现： 适配SpringCloud服务注册与发现标准，默认集成了Ribbon的支持 ·服务限流降级： 默认支持Servlet、Feign、RestTemplate、Dubbon、和Rocke...
golang学习笔记17——golang使用go-kit框架搭建微服务详解
GoppViper的博客
09-11 2423
微服务架构是一种将单一应用程序拆分为一组小型服务的架构风格。每个服务都运行在自己的进程中，通过轻量级的通信机制进行交互。微服务架构具有高可扩展性、高可用性、易于开发和维护等优点。在 Go-Kit 中，服务接口是通过一组方法来定义的。每个方法代表一个服务操作。例如，我们可以定义一个简单的加法服务接口：本文介绍了如何使用 Go 语言搭建微服务。我们首先介绍了微服务架构的概述和优势，然后介绍了 Go 语言在微服务中的优势。
spring事务详细讲解-深入浅出
小电玩
09-08 512
Spring 事务是本身就是对数据库的事务的支持，没有数据库的事务 Spring 是本身无法实现事务的。Spring只提供了统一事务管理接口，具体的实现还是由各数据库自己实现。在使用 Spring 事务时，可以通过注解或编程方式将需要进行事务管理的方法和代码块标记为事务性操作，当这些操作被执行时，Spring 会负责开启时根据当前环境中设置的隔离级别，调整数据库隔离级别。
Java多线程：深入探索与详细解析
m0_63550220的博客
09-08 1498
作为Java中的基本执行单元，线程是轻量级的进程，由线程ID、程序计数器、Java虚拟机栈、本地方法栈、和线程私有内存等部分组成。每个线程都有独立的执行路径，但共享进程的资源（如内存）。：进程是系统资源分配的基本单位，它包含了一个或多个线程以及这些线程运行所需的资源。在Java中，JVM（Java虚拟机）就是一个进程，而运行在JVM上的多个线程则共享JVM的内存空间。：并发指的是多个任务在同一时间段内交替执行，而并行则指的是多个任务在同一时刻真正同时执行。
自动生成不重复的订单id
最新发布
ClaireCheney的博客
09-13 118
【代码】自动生成不重复的订单id。
Java集合：Stack详解
yang_brother的博客
09-10 564
Java 中的Stack类是一个后进先出（LIFO, Last In First Out）的数据结构，它继承自Vector类。尽管Stack是一个可用的类，但它被认为是遗留的，并且在新代码中不推荐使用。通常建议使用Deque或ArrayDeque作为替代。
币安/OK现货合约量化系统APP开发
I592O929783的博客
09-08 593
后端：考虑系统需要处理大量实时数据和高频交易的特点，选择高性能的编程语言和技术框架，如Python的Django或Flask框架，Java的Spring Boot等。用户交互界面：设计直观易用的用户交互界面，包括交易界面、策略配置界面、风险管理界面等，方便用户进行交易操作、策略配置和风险管理。市场数据接入：开发市场数据接入模块，从币安等交易所或数据服务商获取实时的市场数据，包括行情数据、订单簿数据、成交数据等。前端：选择适合开发复杂界面的前端框架，如React、Vue.js等，以提供用户友好的交互界面。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值