Nacos服務(wù)注冊客戶端服務(wù)端原理分析

更新時(shí)間：2023年02月09日 14:23:13 作者：碼出code

這篇文章主要為大家介紹了Nacos服務(wù)注冊客戶端服務(wù)端原理分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

正文

在分布式服務(wù)中，原來的單體服務(wù)會(huì)被拆分成一個(gè)個(gè)微服務(wù)，服務(wù)注冊實(shí)例到注冊中心，服務(wù)消費(fèi)者通過注冊中心獲取實(shí)例列表，直接請求調(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ù)端版本號(hào)都為2.1.1。

客戶端

啟動(dòng)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文件里找到啟動(dòng)配置類信息，SpringBoot服務(wù)啟動(dòng)時(shí)會(huì)將這些配置類信息注入到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，該類配置三個(gè)bean對象：

NacosServiceRegistry
NacosRegistration
NacosAutoServiceRegistration

NacosAutoServiceRegistration

NacosAutoServiceRegistration繼承了抽象類AbstractAutoServiceRegistration。AbstractAutoServiceRegistration抽象類又實(shí)現(xiàn)了ApplicationListener接口。

實(shí)現(xiàn)ApplicationListener接口的方法，會(huì)在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&lt;&gt;(this, getConfiguration()));
    this.running.compareAndSet(false, true);
  }
}

調(diào)用了register方法，最終調(diào)用的是NacosServiceRegistry類的register方法。

NacosServiceRegistry

根據(jù)上文可知，服務(wù)器啟動(dòng)后調(diào)用NacosServiceRegistry類的register方法，該方法實(shí)現(xiàn)將實(shí)例注冊到服務(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)建實(shí)例
  Instance instance = getNacosInstanceFromRegistration(registration);
  try {
    // 注冊實(shí)例 
    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)建實(shí)例，然后通過namingService.registerInstance方法注冊實(shí)例，然后查看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ā)送實(shí)例 
    serverProxy.registerService(NamingUtils.getGroupedName(serviceName, groupName), groupName, instance);
}

registerInstance主要做兩件事：

發(fā)送心跳包

beatReactor.addBeatInfo使用定時(shí)服務(wù)，每隔5s向服務(wù)端發(fā)送一次心跳請求，通過http請求發(fā)送心跳信息，路徑為/v1/ns/instance/beat。

心跳請求定時(shí)任務(wù)使用線程池ScheduledThreadPoolExecutor.schedule()，而該方法只會(huì)調(diào)用一次，定時(shí)任務(wù)的實(shí)現(xiàn)是在每次請求任務(wù)只會(huì)再調(diào)用一次ScheduledThreadPoolExecutor.schedule(), 簡單說就是nacos在發(fā)送心跳的時(shí)候，會(huì)調(diào)用schedule方法，在schedule要執(zhí)行的任務(wù)中，如果正常發(fā)送完心跳，會(huì)再次調(diào)用schedule方法。

那為什么不直接調(diào)用周期執(zhí)行的線程池ScheduledThreadPoolExecutor.scheduleAtFixedRate()？可能是由于發(fā)送心跳服務(wù)發(fā)生異常后，定時(shí)任務(wù)還會(huì)繼續(xù)執(zhí)行，但是周期執(zhí)行的線程池遇到報(bào)錯(cuò)后也不會(huì)重復(fù)調(diào)用執(zhí)行的任務(wù)。

線程任務(wù)BeatTask的run方法，，每次執(zhí)行會(huì)先判斷isStopped,如果是false，說明心跳停止，就不會(huì)觸發(fā)下次執(zhí)行任務(wù)。如果使用定時(shí)任務(wù)scheduleAtFixedRate,即使心跳停止還會(huì)繼續(xù)執(zhí)行任務(wù)，造成資源不必要浪費(fèi)。

注冊實(shí)例

registerService主要封裝實(shí)例信息，比如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ù)端主要接收兩個(gè)信息：心跳包和實(shí)例信息。

心跳包

客戶端向服務(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);
    // 獲取實(shí)例信息
    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時(shí)間。注冊中心會(huì)定時(shí)查詢實(shí)例，當(dāng)前時(shí)間 - lastHeartBeatTime > 設(shè)置時(shí)間(默認(rèn)15秒)，就標(biāo)記實(shí)例為不健康實(shí)例。如果心跳實(shí)例不健康，發(fā)送通知給訂閱方，變更實(shí)例。

服務(wù)端在15秒沒有收到心跳包會(huì)將實(shí)例設(shè)置為不健康，在30秒沒有收到心跳包會(huì)將臨時(shí)實(shí)例移除掉。

實(shí)例注冊

客戶端請求的地址是/nacos/v1/ns/instance，對應(yīng)的是服務(wù)端是在InstanceController類。找到類上對應(yīng)的post請求方法上。

注冊流程：

InstanceController#register ——>InstanceOperatorClientImpl#registerInstance ——>ClientOperationServiceProxy#registerInstance ——>EphemeralClientOperationServiceImpl#registerInstance

創(chuàng)建 Service

服務(wù)注冊后，將服務(wù)存儲(chǔ)在一個(gè)雙層map集合中：

private final Map<String, Map<String, Service>> serviceMap = new ConcurrentHashMap<>();

通過是否存在ephemeral,true，走AP模式，否則走CP模式。

Nacos 默認(rèn)就是采用的AP模式使用Distro協(xié)議實(shí)現(xiàn)。實(shí)現(xiàn)的接口是EphemeralConsistencyService對節(jié)點(diǎn)信息的持久化主要是調(diào)用put方法,

會(huì)先寫入到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é)

從依賴上找到需要啟動(dòng)的是要加載的服務(wù)注冊類NacosDiscoveryAutoConfiguration,主要配置三個(gè)對象

NacosServiceRegistry
NacosRegistration
NacosAutoServiceRegistration

NacosServiceRegistry類的register方法，封裝實(shí)例和心跳信息

通過http請求，定時(shí)發(fā)送發(fā)送心跳包,默認(rèn)時(shí)間間隔是5秒。
通過http請求，發(fā)送實(shí)例信息。

服務(wù)端

接收到心跳請求，更新心跳包最新時(shí)間。服務(wù)端在15秒沒有收到心跳包會(huì)將實(shí)例設(shè)為不健康，在30秒沒有收到心跳包會(huì)將臨時(shí)實(shí)例移除掉。
接收到服務(wù)注冊接口，通過ephemeral判斷是否走AP還是走CP，AP模式使用Distro協(xié)議。通過調(diào)用EphemeralConsistencyService接口實(shí)現(xiàn)，持久化實(shí)例信息。

參考

Nacos源碼之注冊中心的實(shí)現(xiàn)

Nacos 服務(wù)注冊源碼分析

以上就是Nacos服務(wù)注冊客戶端服務(wù)端原理分析的詳細(xì)內(nèi)容，更多關(guān)于Nacos服務(wù)注冊原理的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: