### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

### 關於服務註冊
- 以下圖片來自[Netflix官方](https://github.com/Netflix/eureka/wiki/Eureka-at-a-glance)，圖中顯示Eureka Client會向註冊中心發起Get Registry請求來獲取服務列表：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220619/1655652807876992684.png)

- 以Spring Cloud的Edgware.RELEASE版本為例，Eureka client的註冊動作是在com.netflix.discovery.DiscoveryClient類的initScheduledTasks方法中執行的，相關程式碼片段如下所示，請注意中文註釋：

```java
//略去不相關程式碼
...
//例項化InstanceInfoReplicator物件
instanceInfoReplicator = new InstanceInfoReplicator(
                    this,
                    instanceInfo,
                    clientConfig.getInstanceInfoReplicationIntervalSeconds(),
                    2); // burstSize

//監聽器，用來監聽作為Eureka client的自身的狀態變化
            statusChangeListener = new ApplicationInfoManager.StatusChangeListener() {
                @Override
                public String getId() {
                    return "statusChangeListener";
                }

@Override
                public void notify(StatusChangeEvent statusChangeEvent) {
                    if (InstanceStatus.DOWN == statusChangeEvent.getStatus() ||
                            InstanceStatus.DOWN == statusChangeEvent.getPreviousStatus()) {
                        // log at warn level if DOWN was involved
                        logger.warn("Saw local status change event {}", statusChangeEvent);
                    } else {
                        logger.info("Saw local status change event {}", statusChangeEvent);
                    }
                    //狀態變化時notify方法會被執行，此時上報最新狀態到Eureka server
                    instanceInfoReplicator.onDemandUpdate();
                }
            };

if (clientConfig.shouldOnDemandUpdateStatusChange()) {
                //註冊監聽器
                applicationInfoManager.registerStatusChangeListener(statusChangeListener);
            }
            //服務註冊
            instanceInfoReplicator.start(clientConfig.getInitialInstanceInfoReplicationIntervalSeconds());
```
- 上述程式碼表明，將自身資訊上報到Eureka server的工作是透過呼叫instanceInfoReplicator的api完成的；

### InstanceInfoReplicator的作用
- 先看InstanceInfoReplicator原始碼的註釋：

```java
/**
 * A task for updating and replicating the local instanceinfo to the remote server. Properties of this task are:
 * - configured with a single update thread to guarantee sequential update to the remote server
 * - update tasks can be scheduled on-demand via onDemandUpdate()
 * - task processing is rate limited by burstSize
 * - a new update task is always scheduled automatically after an earlier update task. However if an on-demand task
 *   is started, the scheduled automatic update task is discarded (and a new one will be scheduled after the new
 *   on-demand update).
 *
 *   @author dliu
 */
```

- 我的理解：
1. InstanceInfoReplicator是個任務類，負責將自身的資訊週期性的上報到Eureka server；
2. 有兩個場景觸發上報：週期性任務、服務狀態變化(onDemandUpdate被呼叫)，因此，在同一時刻有可能有兩個上報的任務同時出現；
3. 單執行緒執行上報的操作，如果有多個上報任務，也能確保是序列的；
4. 有頻率限制，透過burstSize引數來控制；
5. 先建立的任務總是先執行，但是onDemandUpdate方法中建立的任務會將週期性任務給丟棄掉；

### 原始碼分析
- 以前面對註釋的理解作為主線，去看原始碼：
- 先看構造方法，如下，中文註釋位置需要注意：

```java
InstanceInfoReplicator(DiscoveryClient discoveryClient, InstanceInfo instanceInfo, int replicationIntervalSeconds, int burstSize) {
        this.discoveryClient = discoveryClient;
        this.instanceInfo = instanceInfo;
		//執行緒池，core size為1，使用DelayedWorkQueue佇列
        this.scheduler = Executors.newScheduledThreadPool(1,
                new ThreadFactoryBuilder()
                        .setNameFormat("DiscoveryClient-InstanceInfoReplicator-%d")
                        .setDaemon(true)
                        .build());

this.scheduledPeriodicRef = new AtomicReference<future>();

this.started = new AtomicBoolean(false);
        //RateLimiter是個限制頻率的工具類，用來限制單位時間內的任務次數
        this.rateLimiter = new RateLimiter(TimeUnit.MINUTES);
        this.replicationIntervalSeconds = replicationIntervalSeconds;
        this.burstSize = burstSize;
        //透過週期間隔，和burstSize引數，計算每分鐘允許的任務數
        this.allowedRatePerMinute = 60 * this.burstSize / this.replicationIntervalSeconds;
        logger.info("InstanceInfoReplicator onDemand update allowed rate per min is {}", allowedRatePerMinute);
    }
```

- 從以上程式碼可見，構造方法中準備好了執行緒池和頻率限制工具，再算好了每分鐘允許的任務數；
- 在com.netflix.discovery.DiscoveryClient類的initScheduledTasks方法中，透過呼叫instanceInfoReplicator.start方法啟動了週期性任務，現在來看此方法：

```java
public void start(int initialDelayMs) {
		//CAS操作，不但保證了只執行一次，多執行緒場景也能保證
		if (started.compareAndSet(false, true)) {
		        instanceInfo.setIsDirty();  // for initial register
		        //提交一個任務，延時執行，注意第一個引數是this，因此延時結束時，InstanceInfoReplicator的run方法會被執行
		        Future next = scheduler.schedule(this, initialDelayMs, TimeUnit.SECONDS);
		        //這個任務的Feature物件放在成員變數scheduledPeriodicRef中
		        scheduledPeriodicRef.set(next);
		}
}
```

- 延時時間到達時，會執行run方法：

```java
public void run() {
        try {
            //更新資訊，用於稍後的上報
            discoveryClient.refreshInstanceInfo();

Long dirtyTimestamp = instanceInfo.isDirtyWithTime();
            if (dirtyTimestamp != null) {
                //上報
                discoveryClient.register();
                instanceInfo.unsetIsDirty(dirtyTimestamp);
            }
        } catch (Throwable t) {
            logger.warn("There was a problem with the instance info replicator", t);
        } finally {
            //每次執行完畢都會建立一個延時執行的任務，就這樣實現了週期性執行的邏輯
            Future next = scheduler.schedule(this, replicationIntervalSeconds, TimeUnit.SECONDS);
            //每次建立的週期性任務，都要放入scheduledPeriodicRef，
            //如果外部呼叫了onDemandUpdate，就能透過onDemandUpdate取得當前要執行的任務
            scheduledPeriodicRef.set(next);
        }
    }
```

- 以上程式碼彙總起來，就完成了週期性任務的邏輯，接下來看看被外部呼叫的onDemandUpdate方法：

```java
public boolean onDemandUpdate() {
        //沒有達到頻率限制才會執行
        if (rateLimiter.acquire(burstSize, allowedRatePerMinute)) {
            //提交一個任務
            scheduler.submit(new Runnable() {
                @Override
                public void run() {
                    logger.debug("Executing on-demand update of local InstanceInfo");
                    //取出之前已經提交的任務
                    Future latestPeriodic = scheduledPeriodicRef.get();
                    //如果此任務未完成，就立即取消
                    if (latestPeriodic != null && !latestPeriodic.isDone()) {
                        logger.debug("Canceling the latest scheduled update, it will be rescheduled at the end of on demand update");
                        latestPeriodic.cancel(false);
                    }
					//透過呼叫run方法，令任務在延時後執行，相當於週期性任務中的一次
                    InstanceInfoReplicator.this.run();
                }
            });
            return true;
        } else {
            //如果超過了設定的頻率限制，本次onDemandUpdate方法就提交任務了
            logger.warn("Ignoring onDemand update due to rate limiter");
            return false;
        }
    }
```

- 如上述程式碼所示，可見之前註釋中提到的功能都已實現；

- 至此，InstanceInfoReplicator已分析完畢，可見這是個功能強大的輔助類，在應用資訊上報到Eureka server時發揮了重要的作用，業務邏輯可以放心的提交上報請求，併發、頻率超限等情況都被InstanceInfoReplicator處理好了；

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)</future>

Eureka的InstanceInfoReplicator類（服務註冊輔助工具）

相關文章