nacos(三) 心跳检测原理

这篇文章主要针对nacos客户端的心跳检测。

1. 在上一篇文章已提到注册服务的时候，碰到临时节点需要注册心跳检测

 	@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);
            //配置心跳检测间隔， 默认5秒
            long instanceInterval = instance.getInstanceHeartBeatInterval();
            beatInfo.setPeriod(instanceInterval == 0 ? DEFAULT_HEART_BEAT_INTERVAL : instanceInterval);

            beatReactor.addBeatInfo(NamingUtils.getGroupedName(serviceName, groupName), beatInfo);
        }

        serverProxy.registerService(NamingUtils.getGroupedName(serviceName, groupName), groupName, instance);
    }

2. 心跳检测间隔是可以改变的， 我们可以进入instance.getInstanceHeartBeatInterval()方法看看nacos是如何获取的

  
 public long getInstanceHeartBeatInterval() {
 		//通过方法名都可以明白意思：根据key去获取检测间隔，如果没有，则选择默认值
        return getMetaDataByKeyWithDefault(PreservedMetadataKeys.HEART_BEAT_INTERVAL, Constants.DEFAULT_HEART_BEAT_INTERVAL);
    }
 
 //key 名称
 public static final String HEART_BEAT_INTERVAL = "preserved.heart.beat.interval";
 //默认值 5秒
 public static final long DEFAULT_HEART_BEAT_INTERVAL = TimeUnit.SECONDS.toMillis(5);

3. 根据HEART_BEAT_INTERVAL常量，我们去application.yml设置自己想要的间隔时间

  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
        heart-beat-interval: 10

4. 我们继续往下走， 进入beatReactor.addBeatInfo()方法， 发现心跳检测主要是创建了一个定时任务， 我们看一下BeatTask里面做了什么

public void addBeatInfo(String serviceName, BeatInfo beatInfo) {
        NAMING_LOGGER.info("[BEAT] adding beat: {} to beat map.", beatInfo);
        String key = buildKey(serviceName, beatInfo.getIp(), beatInfo.getPort());
        BeatInfo existBeat = null;
        //fix #1733
        if ((existBeat = dom2Beat.remove(key)) != null) {
            existBeat.setStopped(true);
        }
        //dom2Beat 是一个concurrenthashmap, 当nacos服务关闭时， 会用到它来销毁定时任务
        dom2Beat.put(key, beatInfo); 
        executorService.schedule(new BeatTask(beatInfo), beatInfo.getPeriod(), TimeUnit.MILLISECONDS);
        MetricsMonitor.getDom2BeatSizeMonitor().set(dom2Beat.size());
    }

5. 发现 BeatTask 实现 runnable接口，serverProxy.sendBeat发送心跳，发送完后，再创建一个定时任务，这个心跳检测就能一直不间断进行下去，直到nacos服务销毁

class BeatTask implements Runnable {

        BeatInfo beatInfo;

        public BeatTask(BeatInfo beatInfo) {
            this.beatInfo = beatInfo;
        }

        @Override
        public void run() {
            if (beatInfo.isStopped()) {
                return;
            }
            long result = serverProxy.sendBeat(beatInfo);
            long nextTime = result > 0 ? result : beatInfo.getPeriod();
            executorService.schedule(new BeatTask(beatInfo), nextTime, TimeUnit.MILLISECONDS);
        }
    }

6. serverProxy.sendBeat(beatInfo)主要是调用nacos服务端的API， 至此心跳检测客服端流程走完。

public long sendBeat(BeatInfo beatInfo) {
        try {
            if (NAMING_LOGGER.isDebugEnabled()) {
                NAMING_LOGGER.debug("[BEAT] {} sending beat to server: {}", namespaceId, beatInfo.toString());
            }
            Map<String, String> params = new HashMap<String, String>(4);
            params.put("beat", JSON.toJSONString(beatInfo));
            params.put(CommonParams.NAMESPACE_ID, namespaceId);
            params.put(CommonParams.SERVICE_NAME, beatInfo.getServiceName());
            String result = reqAPI(UtilAndComs.NACOS_URL_BASE + "/instance/beat", params, HttpMethod.PUT);
            JSONObject jsonObject = JSON.parseObject(result);

            if (jsonObject != null) {
                return jsonObject.getLong("clientBeatInterval");
            }
        } catch (Exception e) {
            NAMING_LOGGER.error("[CLIENT-BEAT] failed to send beat: " + JSON.toJSONString(beatInfo), e);
        }
        return 0L;
    }