Nacos服務(wù)注冊客戶端服務(wù)端原理分析
正文
在分布式服務(wù)中,原來的單體服務(wù)會被拆分成一個個微服務(wù),服務(wù)注冊實例到注冊中心,服務(wù)消費者通過注冊中心獲取實例列表,直接請求調(diào)用服務(wù)。
服務(wù)是如何注冊到注冊中心,服務(wù)如果掛了,服務(wù)是如何檢測?帶著這些問題,我們從源碼上對服務(wù)注冊進(jìn)行簡單的源碼分析。
版本 2.1.1
Nacos Server:2.1.1
spring-cloud-starter-alibaba:2.1.1.RELEASE
spring-boot:2.1.1.RELEASE
方便統(tǒng)一版本,客戶端和服務(wù)端版本號都為2.1.1
。
客戶端
啟動nacos
服務(wù)注冊和發(fā)現(xiàn)需要添加maven
依賴:
<dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> <version>${latest.version}</version> </dependency>
根據(jù)maven
依賴找到對應(yīng)的spring.factories
文件:
在spring.factories
文件里找到啟動配置類信息,SpringBoot
服務(wù)啟動時會將這些配置類信息注入到bean
容器中。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.alibaba.cloud.nacos.NacosDiscoveryAutoConfiguration,\ com.alibaba.cloud.nacos.ribbon.RibbonNacosAutoConfiguration,\ com.alibaba.cloud.nacos.endpoint.NacosDiscoveryEndpointAutoConfiguration,\ com.alibaba.cloud.nacos.discovery.NacosDiscoveryClientAutoConfiguration,\ com.alibaba.cloud.nacos.discovery.configclient.NacosConfigServerAutoConfiguration org.springframework.cloud.bootstrap.BootstrapConfiguration=\ com.alibaba.cloud.nacos.discovery.configclient.NacosDiscoveryClientConfigServiceBootstrapConfiguration
服務(wù)注冊的核心配置類為:NacosDiscoveryAutoConfiguration
,該類配置三個bean
對象:
NacosServiceRegistry
NacosRegistration
NacosAutoServiceRegistration
NacosAutoServiceRegistration
NacosAutoServiceRegistration
繼承了抽象類AbstractAutoServiceRegistration
。AbstractAutoServiceRegistration
抽象類又實現(xiàn)了ApplicationListener
接口。
實現(xiàn)ApplicationListener
接口的方法,會在Spring
容器初始化完成之后調(diào)用onApplicationEvent
方法:
public void onApplicationEvent(WebServerInitializedEvent event) { bind(event); }
調(diào)用bind
方法:
public void bind(WebServerInitializedEvent event) { ApplicationContext context = event.getApplicationContext(); if (context instanceof ConfigurableWebServerApplicationContext) { if ("management".equals(((ConfigurableWebServerApplicationContext) context) .getServerNamespace())) { return; } } this.port.compareAndSet(0, event.getWebServer().getPort()); // 調(diào)用 start 方法 this.start(); }
調(diào)用了start
方法:
public void start() { if (!isEnabled()) { if (logger.isDebugEnabled()) { logger.debug("Discovery Lifecycle disabled. Not starting"); } return; } if (!this.running.get()) { this.context.publishEvent( new InstancePreRegisteredEvent(this, getRegistration())); register(); if (shouldRegisterManagement()) { registerManagement(); } this.context.publishEvent( new InstanceRegisteredEvent<>(this, getConfiguration())); this.running.compareAndSet(false, true); } }
調(diào)用了register
方法,最終調(diào)用的是NacosServiceRegistry
類的register
方法。
NacosServiceRegistry
根據(jù)上文可知,服務(wù)器啟動后調(diào)用NacosServiceRegistry
類的register
方法,該方法實現(xiàn)將實例注冊到服務(wù)端:
public void register(Registration registration) { if (StringUtils.isEmpty(registration.getServiceId())) { log.warn("No service to register for nacos client..."); return; } String serviceId = registration.getServiceId(); String group = nacosDiscoveryProperties.getGroup(); // 創(chuàng)建實例 Instance instance = getNacosInstanceFromRegistration(registration); try { // 注冊實例 namingService.registerInstance(serviceId, group, instance); log.info("nacos registry, {} {} {}:{} register finished", group, serviceId, instance.getIp(), instance.getPort()); } catch (Exception e) { log.error("nacos registry, {} register failed...{},", serviceId, registration.toString(), e); } }
創(chuàng)建實例,然后通過namingService.registerInstance
方法注冊實例,然后查看registerInstance
方法:
@Override public void registerInstance(String serviceName, String groupName, Instance instance) throws NacosException { if (instance.isEphemeral()) { // 封裝心跳包 BeatInfo beatInfo = new BeatInfo(); beatInfo.setServiceName(NamingUtils.getGroupedName(serviceName, groupName)); beatInfo.setIp(instance.getIp()); beatInfo.setPort(instance.getPort()); beatInfo.setCluster(instance.getClusterName()); beatInfo.setWeight(instance.getWeight()); beatInfo.setMetadata(instance.getMetadata()); beatInfo.setScheduled(false); long instanceInterval = instance.getInstanceHeartBeatInterval(); beatInfo.setPeriod(instanceInterval == 0 ? DEFAULT_HEART_BEAT_INTERVAL : instanceInterval); // 發(fā)送心跳包 beatReactor.addBeatInfo(NamingUtils.getGroupedName(serviceName, groupName), beatInfo); } // 發(fā)送實例 serverProxy.registerService(NamingUtils.getGroupedName(serviceName, groupName), groupName, instance); }
registerInstance
主要做兩件事:
- 發(fā)送心跳包
beatReactor.addBeatInfo
使用定時服務(wù),每隔5s
向服務(wù)端發(fā)送一次心跳請求,通過http
請求發(fā)送心跳信息,路徑為/v1/ns/instance/beat
。
心跳請求定時任務(wù)使用線程池ScheduledThreadPoolExecutor.schedule()
,而該方法只會調(diào)用一次,定時任務(wù)的實現(xiàn)是在每次請求任務(wù)只會再調(diào)用一次ScheduledThreadPoolExecutor.schedule()
, 簡單說就是nacos
在發(fā)送心跳的時候,會調(diào)用schedule
方法,在schedule
要執(zhí)行的任務(wù)中,如果正常發(fā)送完心跳,會再次調(diào)用schedule
方法。
那為什么不直接調(diào)用周期執(zhí)行的線程池ScheduledThreadPoolExecutor.scheduleAtFixedRate()
?可能是由于發(fā)送心跳服務(wù)發(fā)生異常后,定時任務(wù)還會繼續(xù)執(zhí)行,但是周期執(zhí)行的線程池遇到報錯后也不會重復(fù)調(diào)用執(zhí)行的任務(wù)。
線程任務(wù)BeatTask
的run
方法,,每次執(zhí)行會先判斷isStopped
,如果是false
,說明心跳停止,就不會觸發(fā)下次執(zhí)行任務(wù)。如果使用定時任務(wù)scheduleAtFixedRate
,即使心跳停止還會繼續(xù)執(zhí)行任務(wù),造成資源不必要浪費。
- 注冊實例
registerService
主要封裝實例信息,比如ip
、port
、servicename
,將這些信息通過http
請求發(fā)送給服務(wù)端。路徑為/v1/ns/instance
。
根據(jù)上面流程,查看以下的流程圖:
服務(wù)端
服務(wù)端就是注冊中心,服務(wù)注冊到注冊中心,在https://github.com/alibaba/nacos/releases/tag/2.1.1
下載源碼部署到本地,方便調(diào)式和查看,部署方式詳見我的另外一篇文章Nacos 源碼環(huán)境搭建。
服務(wù)端主要接收兩個信息:心跳包和實例信息。
心跳包
客戶端向服務(wù)請求的路徑為/v1/ns/instance/beat
,對應(yīng)的服務(wù)端為InstanceController
類的beat
方法:
@PutMapping("/beat") @Secured(action = ActionTypes.WRITE) public ObjectNode beat(HttpServletRequest request) throws Exception { ObjectNode result = JacksonUtils.createEmptyJsonNode(); result.put(SwitchEntry.CLIENT_BEAT_INTERVAL, switchDomain.getClientBeatInterval()); String beat = WebUtils.optional(request, "beat", StringUtils.EMPTY); RsInfo clientBeat = null; // 判斷是否有心跳,存在心跳就轉(zhuǎn)成RsInfo if (StringUtils.isNotBlank(beat)) { clientBeat = JacksonUtils.toObj(beat, RsInfo.class); } String clusterName = WebUtils .optional(request, CommonParams.CLUSTER_NAME, UtilsAndCommons.DEFAULT_CLUSTER_NAME); String ip = WebUtils.optional(request, "ip", StringUtils.EMPTY); int port = Integer.parseInt(WebUtils.optional(request, "port", "0")); if (clientBeat != null) { if (StringUtils.isNotBlank(clientBeat.getCluster())) { clusterName = clientBeat.getCluster(); } else { // fix #2533 clientBeat.setCluster(clusterName); } ip = clientBeat.getIp(); port = clientBeat.getPort(); } String namespaceId = WebUtils.optional(request, CommonParams.NAMESPACE_ID, Constants.DEFAULT_NAMESPACE_ID); String serviceName = WebUtils.required(request, CommonParams.SERVICE_NAME); NamingUtils.checkServiceNameFormat(serviceName); Loggers.SRV_LOG.debug("[CLIENT-BEAT] full arguments: beat: {}, serviceName: {}, namespaceId: {}", clientBeat, serviceName, namespaceId); // 獲取實例信息 BeatInfoInstanceBuilder builder = BeatInfoInstanceBuilder.newBuilder(); builder.setRequest(request); int resultCode = getInstanceOperator() .handleBeat(namespaceId, serviceName, ip, port, clusterName, clientBeat, builder); result.put(CommonParams.CODE, resultCode); // 下次發(fā)送心跳包間隔 result.put(SwitchEntry.CLIENT_BEAT_INTERVAL, getInstanceOperator().getHeartBeatInterval(namespaceId, serviceName, ip, port, clusterName)); result.put(SwitchEntry.LIGHT_BEAT_ENABLED, switchDomain.isLightBeatEnabled()); return result; }
在handleBeat
方法中執(zhí)行線程任務(wù)ClientBeatProcessorV2
的run
方法,延長lastHeartBeatTime
時間。注冊中心會定時查詢實例,當(dāng)前時間 - lastHeartBeatTime
> 設(shè)置時間(默認(rèn)15秒),就標(biāo)記實例為不健康實例。如果心跳實例不健康,發(fā)送通知給訂閱方,變更實例。
服務(wù)端在15
秒沒有收到心跳包會將實例設(shè)置為不健康,在30
秒沒有收到心跳包會將臨時實例移除掉。
實例注冊
客戶端請求的地址是/nacos/v1/ns/instance
, 對應(yīng)的是服務(wù)端是在InstanceController
類。找到類上對應(yīng)的post
請求方法上。
注冊流程:
InstanceController#register ——>InstanceOperatorClientImpl#registerInstance ——>ClientOperationServiceProxy#registerInstance ——>EphemeralClientOperationServiceImpl#registerInstance
創(chuàng)建 Service
服務(wù)注冊后,將服務(wù)存儲在一個雙層map
集合中:
private final Map<String, Map<String, Service>> serviceMap = new ConcurrentHashMap<>();
通過是否存在ephemeral
,true
,走AP
模式,否則走CP
模式。
Nacos
默認(rèn)就是采用的AP
模式使用Distro
協(xié)議實現(xiàn)。實現(xiàn)的接口是EphemeralConsistencyService
對節(jié)點信息的持久化主要是調(diào)用put
方法,
會先寫入到DataStore
中:
public void onPut(String key, Record value) { if (KeyBuilder.matchEphemeralInstanceListKey(key)) { Datum<Instances> datum = new Datum<>(); datum.value = (Instances) value; datum.key = key; datum.timestamp.incrementAndGet(); // 數(shù)據(jù)持久化到緩存中 dataStore.put(key, datum); } if (!listeners.containsKey(key)) { return; } notifier.addTask(key, DataOperation.CHANGE); }
總結(jié)
從依賴上找到需要啟動的是要加載的服務(wù)注冊類NacosDiscoveryAutoConfiguration
,主要配置三個對象
NacosServiceRegistry
NacosRegistration
NacosAutoServiceRegistration
NacosServiceRegistry
類的register
方法,封裝實例和心跳信息
- 通過
http
請求,定時發(fā)送發(fā)送心跳包,默認(rèn)時間間隔是5
秒。 - 通過
http
請求,發(fā)送實例信息。
服務(wù)端
- 接收到心跳請求,更新心跳包最新時間。服務(wù)端在
15
秒沒有收到心跳包會將實例設(shè)為不健康,在30
秒沒有收到心跳包會將臨時實例移除掉。 - 接收到服務(wù)注冊接口,通過
ephemeral
判斷是否走AP
還是走CP
,AP
模式使用Distro
協(xié)議。通過調(diào)用EphemeralConsistencyService
接口實現(xiàn),持久化實例信息。
參考
以上就是Nacos服務(wù)注冊客戶端服務(wù)端原理分析的詳細(xì)內(nèi)容,更多關(guān)于Nacos服務(wù)注冊原理的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
SpringSceurity實現(xiàn)短信驗證碼功能的示例代碼
這篇文章主要介紹了SpringSceurity實現(xiàn)短信驗證碼功能的示例代碼,本文通過實例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-06-06Java實現(xiàn)特定范圍的完數(shù)輸出算法示例
這篇文章主要介紹了Java實現(xiàn)特定范圍的完數(shù)輸出算法,簡單說明了完數(shù)的概念、計算原理并結(jié)合實例形式分析了java針對給定范圍內(nèi)的完數(shù)輸出操作實現(xiàn)技巧,需要的朋友可以參考下2017-12-12IDEA創(chuàng)建web項目出現(xiàn)404錯誤解決方法
今天先來搭建一個web工程,工程搭建好運行時發(fā)現(xiàn)404,本文主要介紹了IDEA創(chuàng)建web項目出現(xiàn)404錯誤解決方法,具有一定的參考價值,感興趣的可以了解一下2023-09-09