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

### 從Eureka server獲取服務列表
- Spring cloud環境中的應用，如果註冊到Eureka server，就會從Eureka server獲取所有應用的註冊資訊（也叫服務列表），然後儲存到本地，這個操作是週期性的，預設每三十秒一次；

- 以下是來自官方的架構圖，可以看到Application Service向Eureka Server有Get Registry的請求：

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

### 參考文章
- 如果您有興趣，想深入瞭解*spring廣播機制*或者*Eureka client更新服務列表*，推薦您參考以下兩篇文章：
1. [《spring4.1.8擴充套件實戰之三：廣播與監聽 》](http://blog.itpub.net/70017844/viewspace-2900211/)
2. 《Spring Cloud原始碼分析之Eureka篇第五章：更新服務列表 》

### 實戰內容
- 本文是一篇實戰的文章，實戰內容如下：
1. 啟動Eureka server；
2. 開發一個應用springcloudcustomizelistener，啟動後會註冊到Eureka server；
3. 此時該應用身份為Eureka client，會週期性的從Eureka server獲取服務列表（已有邏輯）；
4. 每次成功獲取的服務列表成功都會存入本地快取（已有邏輯）；
5. 存入快取後，會在spring容器內傳送廣播（已有邏輯）；
6. 本次實戰的重點就是自定義一個監聽器來接收上述廣播，收到廣播後把詳情用日誌列印出來；
7. 再啟動另一個應用springclouddeepprovider，也會註冊到Eureka server；
8. 再去觀察springcloudcustomizelistener的廣播監聽日誌，會發現springclouddeepprovider的註冊資訊；

### Eureka client快取服務列表的原始碼簡介
- 實戰前，先對Eureka client快取服務列表的實現原始碼做個簡介，這樣才能做出匹配的監聽器；

- 應用作為Eureka Client的啟動時，在com.netflix.discovery.DiscoveryClient類的initScheduledTasks方法中，會啟動週期性任務，每隔30秒從Eureka server獲取服務列表資訊，如下圖，紅框中的TimedSupervisorTask負責週期性執行，綠框中的CacheRefreshThread負責具體的更新邏輯：

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

- 在CacheRefreshThread類中經過層層呼叫，獲取服務列表並更新本地快取的邏輯在fetchRegistry方法中實現，如下圖，紅框中的getAndStoreFullRegistry方法負責全量更新，綠框中的getAndUpdateDelta方法負責增量更新，黃框中的onCacheRefreshed方法就是今天的重點：傳送廣播，廣播型別是*服務列表的本地快取已更新*

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

- onCacheRefreshed方法在子類CloudEurekaClient中被重寫，可見這裡傳送了一個普通的spring容器內廣播，型別是HeartbeatEvent，我們可以自定義監聽類來接收廣播，並透過泛型規定只接受HeartbeatEvent型別：

```java
    @Override
    protected void onCacheRefreshed() {
        if (this.cacheRefreshedCount != null) { //might be called during construction and will be null
            long newCount = this.cacheRefreshedCount.incrementAndGet();
            log.trace("onCacheRefreshed called with count: " + newCount);
            //spring容器內廣播，HeartbeatEvent例項在建立時收到兩個引數：CloudEurekaClient例項和快取重新整理次數
            this.publisher.publishEvent(new HeartbeatEvent(this, newCount));
        }
    }
```

### 實戰應用設定
- 本次實戰要搭建一個小的Spring Cloud環境，包括以下應用：

| 應用名稱      |   身份 |   作用|   埠|  啟動順序 |
| :-------- | :----| :----| :----| :------|
| springclouddeepeureka| Eureka server | 註冊中心 |8081| 第一 |
| springcloudcustomizelistener | Eureka client | 有自定義廣播監聽器，監聽服務列表快取更新的廣播 | 8085 | 第二|
| springclouddeepprovider | Eureka client | 普通web應用 | 8082 | 第三 |

### 原始碼下載
- springclouddeepeureka和springclouddeepprovider這兩個應用，在文章《Spring Cloud原始碼分析之Eureka篇第一章：準備工作》中已有詳細介紹，本文中就不多說了，您可以參考文章，也可以在github下載這兩個應用的原始碼，地址和連結資訊如下表所示：

| 名稱      |   連結 |   備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |

- 這個git專案中有多個資料夾，本章原始碼分別在springclouddeepeureka、springclouddeepprovider這兩個資料夾下，如下圖紅框所示：

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

### 啟動springclouddeepeureka
- 應用springclouddeepeureka開發完成後就立即啟動，在瀏覽器訪問地址：http://localhost:8081，可見Eureka server已經啟動，不過還沒有任何應用註冊上來，如下圖：

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

### 開發springcloudcustomizelistener
- 接下來一起開發應用springcloudcustomizelistener，在此應用中新增自定義的spring廣播監聽器，如果您不想敲程式碼，也可以從github上直接下載原始碼，地址和連結資訊如下表所示：

| 名稱      |   連結 |   備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |

- 這個git專案中有多個資料夾，本章原始碼在springcloudcustomizelistener資料夾下，如下圖紅框所示：

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

- 一起來開發吧：

- 建立一個springboot的web應用，pom.xml內容如下，注意為了在日誌中展示更詳細的內容，依賴了fastjson庫：

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelversion>4.0.0</modelversion>

<groupid>com.bolingcavalry</groupid>
 <artifactid>springcloudcustomizelistener</artifactid>
 <version>0.0.1-SNAPSHOT</version>
 <packaging>jar</packaging>

<name>springcloudcustomizelistener</name>
 <description>Demo project for Spring Boot</description>

<parent>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-starter-parent</artifactid>
 <version>1.5.9.RELEASE</version>
 </parent>

<dependencies>
 <dependency>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-starter-web</artifactid>
 </dependency>

<dependency>
 <groupid>org.springframework.cloud</groupid>
 <artifactid>spring-cloud-starter-netflix-eureka-client</artifactid>
 </dependency>

<dependency>
 <groupid>com.alibaba</groupid>
 <artifactid>fastjson</artifactid>
 <version>1.2.28</version>
 </dependency>

<dependency>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-starter-test</artifactid>
 <scope>test</scope>
 </dependency>
 </dependencies>

<dependencymanagement>
 <dependencies>
 <dependency>
 <groupid>org.springframework.cloud</groupid>
 <artifactid>spring-cloud-dependencies</artifactid>
 <version>Edgware.RELEASE</version>
 <type>pom</type>
 <scope>import</scope>
 </dependency>
 </dependencies>
 </dependencymanagement>
 
 <build>
 <plugins>
 <plugin>
 <groupid>org.springframework.boot</groupid>
 <artifactid>spring-boot-maven-plugin</artifactid>
 </plugin>
 </plugins>
 </build>
</project>
```

- 應用配置檔案application.yml的內容如下：

```yml
server:
  port: 8085
spring:
  application:
    name: springcloud-customize-listener
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8081/eureka/
  instance:
    prefer-ip-address: true
```

- 建立監聽器EurekaCacheRefreshListener.java，前面已經分析過HeartbeatEvent例項的兩個成員變數，值為快取重新整理次數和CloudEurekaClient例項，在收到廣播時，將這兩個成員變數都在日誌中列印出來：

```java
@Component
public class EurekaCacheRefreshListener implements ApplicationListener<heartbeatevent> {

private static final Logger logger = LoggerFactory.getLogger(EurekaCacheRefreshListener.class);

@Override
    public void onApplicationEvent(HeartbeatEvent event) {
        Object count = event.getValue();
        Object source = event.getSource();

logger.info("start onApplicationEvent, count [{}], source :\n{}", count, JSON.toJSON(source));
    }
}
```

- 啟動應用，等待大約30秒左右，EurekaCacheRefreshListener中的日誌就會在控制檯輸出，內容十分豐富，建議您複製這些內容去線上格式化JSON的網站做一下格式化再來看，下面列出部分關鍵資訊，其他的內容已經略去：

```JSON
{
    "instanceRemoteStatus": "UP",
    "lastSuccessfulHeartbeatTimePeriod": 316,
    "allKnownRegions": [
        "us-east-1"
    ],
    ...
    此處省略部分內容
    ...
    "applications": {
        "appsHashCode": "UP_1_",
        "registeredApplications": [
            {
                "instances": [
                    {
                        "hostName": "192.168.31.104",
                        "overriddenStatus": "UNKNOWN",
                        "metadata": {
                            "jmx.port": "64656",
                            "management.port": "8085"
                        },
                        "statusPageUrl": "http://192.168.31.104:8085/info",
                        "secureVipAddress": "springcloud-customize-listener",
                        "leaseInfo": {
                            "renewalIntervalInSecs": 30,
                            "registrationTimestamp": 1537827838033,
                            "evictionTimestamp": 0,
                            "renewalTimestamp": 1537827987419,
                            "durationInSecs": 90,
                            "serviceUpTimestamp": 1537827837461
                        },
                        "homePageUrl": "http://192.168.31.104:8085/",
                        "countryId": 1,
                        "sID": "na",
                        "securePort": 443,
                        "dataCenterInfo": {
                            "name": "MyOwn"
                        },
                        "instanceId": "DESKTOP-82CCEBN:springcloud-customize-listener:8085",
                        "coordinatingDiscoveryServer": false,
                        "id": "DESKTOP-82CCEBN:springcloud-customize-listener:8085",
                        "vIPAddress": "springcloud-customize-listener",
                        "dirty": false,
                        "lastUpdatedTimestamp": 1537827838033,
                        "healthCheckUrl": "http://192.168.31.104:8085/health",
                        "appName": "SPRINGCLOUD-CUSTOMIZE-LISTENER",
                        "lastDirtyTimestamp": 1537827837401,
                        "iPAddr": "192.168.31.104",
                        "version": "unknown",
                        "actionType": "ADDED",
                        "port": 8085,
                        "healthCheckUrls": [
                            "http://192.168.31.104:8085/health"
                        ],
                        "status": "UP"
                    }
                ]
```
- 如上所示，當前應用的例項資訊在本地已經快取了；

### 啟動springclouddeepprovider 
- 應用springclouddeepprovider是最後一個啟動的應用，啟動該應用後，再去觀察springcloudcustomizelistener的日誌，發現應用springclouddeepprovider的註冊資訊已經獲取到了：

```JSON
{
                "instances": [
                    {
                        "hostName": "192.168.119.1",
                        "overriddenStatus": "UNKNOWN",
                        "metadata": {
                            "jmx.port": "58420",
                            "management.port": "8082"
                        },
                        "statusPageUrl": "http://192.168.119.1:8082/info",
                        "secureVipAddress": "springcloud-deep-provider",
                        "leaseInfo": {
                            "renewalIntervalInSecs": 30,
                            "registrationTimestamp": 1537840715486,
                            "evictionTimestamp": 0,
                            "renewalTimestamp": 1537840715486,
                            "durationInSecs": 90,
                            "serviceUpTimestamp": 1537840715486
                        },
                        "homePageUrl": "http://192.168.119.1:8082/",
                        "countryId": 1,
                        "sID": "na",
                        "securePort": 443,
                        "dataCenterInfo": {
                            "name": "MyOwn"
                        },
                        "instanceId": "localhost:springcloud-deep-provider:8082",
                        "coordinatingDiscoveryServer": false,
                        "id": "localhost:springcloud-deep-provider:8082",
                        "vIPAddress": "springcloud-deep-provider",
                        "dirty": false,
                        "lastUpdatedTimestamp": 1537840715486,
                        "healthCheckUrl": "http://192.168.119.1:8082/health",
                        "appName": "SPRINGCLOUD-DEEP-PROVIDER",
                        "lastDirtyTimestamp": 1537840715451,
                        "iPAddr": "192.168.119.1",
                        "version": "unknown",
                        "actionType": "ADDED",
                        "port": 8082,
                        "healthCheckUrls": [
                            "http://192.168.119.1:8082/health"
                        ],
                        "status": "UP"
                    }
                ],
                "name": "SPRINGCLOUD-DEEP-PROVIDER",
                "instancesAsIsFromEureka": [
                    {
                        "hostName": "192.168.119.1",
                        "overriddenStatus": "UNKNOWN",
                        "metadata": {
                            "jmx.port": "58420",
                            "management.port": "8082"
                        },
                        "statusPageUrl": "http://192.168.119.1:8082/info",
                        "secureVipAddress": "springcloud-deep-provider",
                        "leaseInfo": {
                            "renewalIntervalInSecs": 30,
                            "registrationTimestamp": 1537840715486,
                            "evictionTimestamp": 0,
                            "renewalTimestamp": 1537840715486,
                            "durationInSecs": 90,
                            "serviceUpTimestamp": 1537840715486
                        },
                        "homePageUrl": "http://192.168.119.1:8082/",
                        "countryId": 1,
                        "sID": "na",
                        "securePort": 443,
                        "dataCenterInfo": {
                            "name": "MyOwn"
                        },
                        "instanceId": "localhost:springcloud-deep-provider:8082",
                        "coordinatingDiscoveryServer": false,
                        "id": "localhost:springcloud-deep-provider:8082",
                        "vIPAddress": "springcloud-deep-provider",
                        "dirty": false,
                        "lastUpdatedTimestamp": 1537840715486,
                        "healthCheckUrl": "http://192.168.119.1:8082/health",
                        "appName": "SPRINGCLOUD-DEEP-PROVIDER",
                        "lastDirtyTimestamp": 1537840715451,
                        "iPAddr": "192.168.119.1",
                        "version": "unknown",
                        "actionType": "ADDED",
                        "port": 8082,
                        "healthCheckUrls": [
                            "http://192.168.119.1:8082/health"
                        ],
                        "status": "UP"
                    }
                ]
            }
```

- 至此，本次實戰就完成了，透過開發自定義的廣播監聽器，我們對Eureka的註冊發現機制有了進一步瞭解，在您的Spring Cloud學習過程中，希望本文能祝您一臂之力；

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

實戰監聽Eureka client的快取更新

相關文章