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

- Spring Cloud環境下，服務提供者和消費者啟動後都會將自身註冊到Eureka，從本章開始我們來探尋整個註冊過程的程式碼邏輯，以加深對Spring Cloud的服務註冊發現機制的理解；

### 章節概覽
- Eureka的服務註冊發現功能涉及內容較多，因此分為多篇文章進行，大綱如下：
1. 分析一個普通的SpringBoot應用，是如何開始執行服務註冊發現相關的功能的，也就是本篇文章的內容；
2. 分析服務列表的獲取和更新邏輯；
3. 分析註冊到Eureka的邏輯；
4. 分析向Eureka續租的邏輯;

### 將服務註冊到Eureka
- 一個SpringBoot應用如果要註冊到Spring Cloud環境(Edgware.RELEASE版本)，步驟很簡單：
1. pom.xml中新增啟動器：spring-cloud-starter-netflix-eureka-client；
2. 增加配置：eureka.client.serviceUrl.defaultZone: http://localhost:8081/eureka/；
3. 啟動應用；

- 如果註冊中心正常，此時就能在註冊中心發現這個應用了，如下圖紅框所示：
![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220707/1657169975496982170.png)

### 為什麼不用註解@EnableDiscoveryClient
- 在Edgware版本之前的Spring Cloud版本，需要在應用的配置類上新增註解@EnableDiscoveryClient，才會開啟服務註冊發現功能，但是自Edgware版本起，@EnableDiscoveryClient已成為可選項，不用該註解也能開啟服務註冊發現，參考[《
Spring Cloud原始碼分析之Eureka篇第三章：EnableDiscoveryClient與EnableEurekaClient的區別(Edgware版本)》](https://blog.csdn.net/boling_cavalry/article/details/82668480);

### 啟動邏輯分析
- 現在就來分析應用啟動過程，看註冊服務是如何啟動的：
- spring-cloud-netflix-eureka-client-1.4.0.RELEASE.jar是個重要的jar包，很多配置都在此jar內部的spring.factories檔案中，首先要確定這個jar包是否會出現在應用的classpath中（如果不在classpath中，這些配置就不會生效），在pom.xml所在目錄下執行命令<font color="blue">mvn dependency:tree</font>，列印依賴樹，如下圖，可確認spring-cloud-netflix-eureka-client被啟動器spring-cloud-starter-netflix-eureka-client間接依賴，因此會出現在classpath中：

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

- spring-cloud-netflix-eureka-client-1.4.0.RELEASE.jar中的spring.factories檔案，內容如下：

```properties
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.cloud.netflix.eureka.config.EurekaClientConfigServerAutoConfiguration,\
org.springframework.cloud.netflix.eureka.config.EurekaDiscoveryClientConfigServiceAutoConfiguration,\
org.springframework.cloud.netflix.eureka.EurekaClientAutoConfiguration,\
org.springframework.cloud.netflix.ribbon.eureka.RibbonEurekaAutoConfiguration,\
org.springframework.cloud.netflix.eureka.EurekaDiscoveryClientConfiguration

org.springframework.cloud.bootstrap.BootstrapConfiguration=\
org.springframework.cloud.netflix.eureka.config.EurekaDiscoveryClientConfigServiceBootstrapConfiguration
```

- 以上配置資訊可見，如果springboot啟用了自動配置，那麼EurekaClientConfigServerAutoConfiguration、......、EurekaDiscoveryClientConfiguration等五個配置類都會生效；

- 按照spring.factories中的配置，EurekaClientAutoConfiguration中的配置都會生效，包括下面這段程式碼返回的bean：

```java
@Bean
public DiscoveryClient discoveryClient(EurekaInstanceConfig config, EurekaClient client) {
	return new EurekaDiscoveryClient(config, client);
}
```

- spring容器初始化時會例項化所有單例bean，就會執行EurekaClientAutoConfiguration的discoveryClient方法獲取這個bean例項，於是就構造了一個EurekaDiscoveryClient物件；
- 注意EurekaDiscoveryClient的構造方法，第二個入參是com.netflix.discovery.EurekaClient型別，此物件同樣來自EurekaClientAutoConfiguration類，如下方法：

```java
@Bean(destroyMethod = "shutdown")
@ConditionalOnMissingBean(value = EurekaClient.class, search = SearchStrategy.CURRENT)
@org.springframework.cloud.context.config.annotation.RefreshScope
@Lazy
public EurekaClient eurekaClient(ApplicationInfoManager manager, EurekaClientConfig config, EurekaInstanceConfig instance) {
	manager.getInfo(); // force initialization
	return new CloudEurekaClient(manager, config, this.optionalArgs,this.context);
}
```

- CloudEurekaClient的父類com.netflix.discovery.DiscoveryClient來自netflix釋出的eureka-client包中，所以可以這麼理解：EurekaDiscoveryClient類是個代理身份，真正的服務註冊發現是委託給netflix的開源包來完成的，我們可以專心的使用SpringCloud提供的服務註冊發現功能，只需要知道EurekaDiscoveryClient即可，真正的服務是eureka-client來完成的；

- 接下來需要關注com.netflix.discovery.DiscoveryClient的構造方法，因為這裡面有服務註冊的邏輯，整個構造方法內容太多，無需都細看，只看關鍵程式碼即可；

- DiscoveryClient的構造方法中，最熟悉的應該是下圖紅框中這段日誌輸出的了：

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

- 對應的應用啟動日誌中就有這段日誌輸出，如下圖紅框：

- 紅框中的"us-east-1"，是預設的region，來自配置類EurekaClientConfigBean，這裡面有各種eureka相關的配置資訊，以及預設配置，如下圖：

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

- 繼續看DiscoveryClient的構造方法，服務註冊相關的initScheduledTasks方法在此被呼叫，如下圖：

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

- initScheduledTasks方法的內容如下，請注意中文註釋：

```java
private void initScheduledTasks() {
	//獲取服務註冊列表資訊
        if (clientConfig.shouldFetchRegistry()) {
            //服務註冊列表更新的週期時間
            int registryFetchIntervalSeconds = clientConfig.getRegistryFetchIntervalSeconds();
            int expBackOffBound = clientConfig.getCacheRefreshExecutorExponentialBackOffBound();
            //定時更新服務註冊列表
            scheduler.schedule(
                    new TimedSupervisorTask(
                            "cacheRefresh",
                            scheduler,
                            cacheRefreshExecutor,
                            registryFetchIntervalSeconds,
                            TimeUnit.SECONDS,
                            expBackOffBound,
                            new CacheRefreshThread() //該執行緒執行更新的具體邏輯
                    ),
                    registryFetchIntervalSeconds, TimeUnit.SECONDS);
        }

if (clientConfig.shouldRegisterWithEureka()) {
	        //服務續約的週期時間
            int renewalIntervalInSecs = instanceInfo.getLeaseInfo().getRenewalIntervalInSecs();
            int expBackOffBound = clientConfig.getHeartbeatExecutorExponentialBackOffBound();
            //應用啟動可見此日誌，內容是：Starting heartbeat executor: renew interval is: 30
            logger.info("Starting heartbeat executor: " + "renew interval is: " + renewalIntervalInSecs);
            // 定時續約
            scheduler.schedule(
                    new TimedSupervisorTask(
                            "heartbeat",
                            scheduler,
                            heartbeatExecutor,
                            renewalIntervalInSecs,
                            TimeUnit.SECONDS,
                            expBackOffBound,
                            new HeartbeatThread() //該執行緒執行續約的具體邏輯
                    ),
                    renewalIntervalInSecs, TimeUnit.SECONDS);

//這個Runable中含有服務註冊的邏輯
            instanceInfoReplicator = new InstanceInfoReplicator(
                    this,
                    instanceInfo,
                    clientConfig.getInstanceInfoReplicationIntervalSeconds(),
                    2); // burstSize

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);
                    }
                    instanceInfoReplicator.onDemandUpdate();
                }
            };

if (clientConfig.shouldOnDemandUpdateStatusChange()) {
                applicationInfoManager.registerStatusChangeListener(statusChangeListener);
            }
			//服務註冊
			instanceInfoReplicator.start(clientConfig.getInitialInstanceInfoReplicationIntervalSeconds());
        } else {
            logger.info("Not registering with Eureka server per configuration");
        }
    }
```
- 上述程式碼中有幾處需要注意，這些關鍵點在後面的章節將繼續展開：
a. 週期性更新服務列表；
b. 週期性的服務續約；
c. 服務註冊邏輯被放入Runnable實現類InstanceInfoReplicator之中，在新執行緒中執行；

### 關於Spring Cloud工程和Netflix工程
- 在註冊發現相關的內容中，Spring Cloud和Netflix的關係，可以用以下類圖來輔助理解，該圖來自大神程式猿DD的文章[《Spring Cloud原始碼分析（一）Eureka》](http://blog.didispace.com/springcloud-sourcecode-eureka/)，向大神致敬！

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

- 至此，我們已經瞭解了SpringBoot應用啟動服務註冊功能的步驟，接下來的章節會繼續深入如何更新服務列表；

### 歡迎關注華為雲部落格：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](https://bbs.huaweicloud.com/community/usersnew/id_1617494866457674)

Spring Cloud原始碼分析之Eureka篇第四章：服務註冊是如何發起的

相關文章