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

- 在基於SpringCloud做開發的時候，EnableDiscoveryClient和EnableEurekaClient這兩個註解我們並不陌生，今天就來聊聊它們的區別，和網上更早期的類似文章不同的是：本文會聊到Dalston之後的版本中，這兩個註解的區別；

### Spring Cloud版本說明
- 大致發展情況如下：
Angle -> Brixton -> Camden -> Dalston -> Edgware -> Finchley

### 文章概覽
- 全文由以下幾部分組成，注意Dalston版本是個很重要的時間點，這之後的版本中EnableDiscoveryClient、EnableEurekaClient的作用發生了很大的變化，因此我們接下來的討論都要先分清楚是Dalston版本之前還是之後：
1. 問題的起源；
2. 來自作者的權威答案（Dalston或更早期的版本）；
3. 官方文件（Dalston或更早期的版本）；
4. 看原始碼（Dalston或更早期的版本）；
5. Edgware版本中EnableEurekaClient的變化；
6. Edgware版本官方文件對EnableDiscoveryClient的解釋；
7. 原始碼揭示EnableDiscoveryClient的變化；
8. 一點遺留問題待確定；
9. 小結；

### 問題的起源
- 在使用Spring Cloud的Dalston版本或更早期的版本中，為了將應用釋出到Eureka註冊中心，我們會在配置類中增加@EnableDiscoveryClient或者@EnableEurekaClient註解，例如以下程式碼：

```java
package com.bolingcavalry.springclouddeepprovider;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class SpringclouddeepproviderApplication {

public static void main(String[] args) {
		SpringApplication.run(SpringclouddeepproviderApplication.class, args);
	}
}
```

- 於是就有了疑問：EnableDiscoveryClient和EnableEurekaClient的區別和關係。

### 來自作者的權威答案（Dalston或更早期的版本）
- 請注意，下面這段內容的背景是Spring Cloud的Dalston版本，或更早期的版本，這一點很重要！

- EnableDiscoveryClient和EnableEurekaClient的區別在網上有不少文章分析，但最權威的答案應該來自這兩個類的作者Spencer Gibb，他在StackOverflow上有回覆，地址是：https://stackoverflow.com/questions/31976236/whats-the-difference-between-enableeurekaclient-and-enablediscoveryclient，內容如下圖：
![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220706/1657080424392528349.png)

- 我的理解：註冊發現服務有三種實現方式：eureka、consul、zookeeper，EnableDiscoveryClient註解在common包中，透過專案的classpath來決定使用哪種實現，而EnableEurekaClient註解在netflix包中，只會使用eureka這種實現方式；

- 有兩個時間點需要注意：
1. Spencer Gibb的這段話發表於2015年8月13日；
2. Spencer Gibb於2017年10月25日，在Spring官方部落格宣佈[Edgware.RC1版本釋出](https://spring.io/blog/2017/10/25/spring-cloud-edgware-rc1-released)，如下圖，此時距離他在StackOverflow上那個回答已經過去了兩年：
![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220706/1657080438855690278.png)

- 因此，如果您使用的Spring Cloud版本是Edgware或者更新的版本，您在考慮EnableDiscoveryClient和EnableEurekaClient的區別時，Spencer Gibb在StackOverflow上的那個解釋就未必準確了，因為您的版本距離他當時的版本已經有了兩年以上的間隔；

### 官方文件（Dalston或更早期的版本）
- 在Spring官方部落格，於2014年12月9日宣佈Spring Cloud 1.0.0.RC1釋出，地址是：https://spring.io/blog/2014/12/19/spring-cloud-1-0-0-rc1-available-now，裡面有段描述如下圖紅框所示：
![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220706/1657080458087628604.png)

- 我對以上描述的理解：
1. 服務註冊發現功能被抽象後放入spring-cloud-commons庫，該庫的EnableDiscoveryClient可以取代舊的EnableEurekaClient，使用註解EnableDiscoveryClient就能啟用服務註冊發現功能；
2. 同理，EnableHystrix也被EnableCircuitBreaker取代了；

- 可見，從Spring Cloud 1.0.0.RC1版本開始，就已經不推薦使用EnableEurekaClient和EnableHystrix了；

### 看原始碼（Dalston或更早期的版本）
- 看一下Dalston版本的EnableEurekaClient原始碼：

```java
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@EnableDiscoveryClient
public @interface EnableEurekaClient {

}
```
- 上述程式碼顯示，EnableEurekaClient 中使用了EnableDiscoveryClient，因此，從使用者角度來看兩者確實已經沒有什麼區別了，按照官方的建議使用EnableDiscoveryClient其實是個不錯的選擇；

### Edgware版本中EnableEurekaClient的變化
- 來看看Edgware版本中，EnableEurekaClient.java的內容：

```java
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface EnableEurekaClient {

}
```
- 如上所示，之前版本中的@EnableDiscoveryClient註解已經不存在了，而且也沒有用到任何@Import註解，因此，EnableEurekaClient這個註解已經沒什麼用處了，在程式碼中用不用它，是沒什麼差別的；

### Edgware版本官方文件對EnableDiscoveryClient的解釋
- Dalston之後的第一個版本為Edgware，Spring官方部落格在2017年10月25日宣佈釋出，一起來看看此版本的EnableEurekaClient和EnableDiscoveryClient的區別；

- 首先還是看[官方部落格](https://spring.io/blog/2017/10/25/spring-cloud-edgware-rc1-released)，關鍵資訊如下圖：
![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220706/1657080472361465426.png)

- 我對以上內容的理解：
1. EnableDiscoveryClient註解現在是可選項了(你用不用這個註解，是不會影響服務註冊發現功能的)；
2. 只要依賴了以spring-cloud-starter-netflix為字首的庫(例如spring-cloud-starter-netflix-eureka-client)，就啟用了服務註冊發現功能；
3. 使用配置項spring.cloud.service-registry.auto-registration.enabled=false即可禁止服務註冊發現功能；

- 從官方部落格上看來EnableDiscoveryClient註解已經不會影響服務註冊發現功能了；

### 如何理解“@EnableDiscoveryClient is now optional”？
- 既然註解@EnableDiscoveryClient用或者不用都不影響服務註冊發現功能，那為什麼官方文件將其描述為"is now optional"（可選項），為什麼不直接廢棄這個註解呢？
- 從官方文件對EnableDiscoveryClient的描述，我們可以看個明白，如下圖：
![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220706/1657080482293324558.png)

- 上圖是Edgware版本的開發文件，地址：http://cloud.spring.io/spring-cloud-static/Edgware.SR4/multi/multi__spring_cloud_commons_common_abstractions.html#__enablediscoveryclient

- 從上圖描述可以看出，spring容器在查詢spring.factories的過程中，如果找到了EnableDiscoveryClient的配置，就會例項化該配置對應的服務註冊發現：例如eureka、consul、zookeeper等；

- 紅框中提到，EnableDiscoveryClient不是必須的，只要classpath中存在DiscoveryClient的實現就可以保證將應用註冊到註冊中心了，這個功能是如何實現的，後面我們會分析到(和spring.factories有關)；

### 原始碼揭示EnableDiscoveryClient的變化
- 透過原始碼來確認官方文件的資訊，這種方式可以加深對Spring Cloud的理解；

- 尋找突破點：
- 面對浩瀚的原始碼，如何下手呢？前面官方文件的那句話給了我們一個線索，如下圖紅框所示：

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

- 只依賴以spring-cloud-starter-netflix為字首的庫(例如spring-cloud-starter-netflix-eureka-client)，就啟用了服務註冊發現功能，這個特性讓我想起了spring容器透過META-INF/spring.factories檔案載入配置的能力；

- 於是開啟工程spring-cloud-netflix-eureka-client(Edgware版對應的該工程版本號為1.4.0.RELEASE)，去看src\main\resources\META-INF目錄下的spring.factories檔案，發現在springboot的自動配置項中，出現了一個關鍵配置EurekaDiscoveryClientConfiguration，如下圖：

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

- EurekaDiscoveryClientConfiguration負責啟動實現服務註冊發現功能，實現機制相對複雜，在此不展開細說了，看看部分原始碼如下：

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

- 真相大白：服務註冊發現功能是否啟動，是由配置類EurekaDiscoveryClientConfiguration控制的，在Edgware版本中，如果開啟了springboot的自動配置，那麼EurekaDiscoveryClientConfiguration就會生效，因此不是靠EnableDiscoveryClient註解來控制了；

- 現在我們對Edgware版本的服務註冊發現已經有所瞭解，再去看看Dalston版本下的spring.factories，應該能有不少收穫；

- Dalston版的Spring Cloud，其spring-cloud-netflix-eureka-client工程的版本號為1.3.6.RELEASE，開啟該工程下面的spring.factories檔案，內容如下：

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

- 真相大白：在Dalston版本下，使用註解EnableDiscoveryClient才會使配置類EurekaDiscoveryClientConfiguration生效；

### 一點遺留問題待確定
- 前面我們在Edgware和Dalston版本下分別開啟spring-cloud-netflix-eureka-client工程的spring.factories，透過對比spring.factories，弄清楚了服務註冊發現功能是如何啟動的；

- 但是似乎有個問題：
1. 在Edgware版本中，官方建議使用spring-cloud-netflix-eureka-client作為starter；
2. 在Dalston版本中，官方建議使用spring-cloud-starter-eureka作為start，也就是所我們的pom.xml中並沒有出現spring-cloud-netflix-eureka-client；

- 那麼問題來了，如果Dalston版本中沒有用到spring-cloud-netflix-eureka-client庫，那麼它的spring.factories自然也就不會生效，那我們剛才的分析豈不是無用了？

- 除非是被pom.xml中的其他庫間接依賴了，還是建立一個工程來驗證一下吧；

- 基於maven建立一個springboot工程，裡面依賴了Spring Cloud的Dalston版本，pom.xml內容如下：
```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>springclouddeepprovider</artifactid>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

<name>springclouddeepprovider</name>
	<description>Demo project for Spring Cloud service provider</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-eureka</artifactid>
		</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>Dalston.SR5</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>
```
- 注意starter用的是spring官方推薦的spring-cloud-starter-eureka，現在工程目錄下執行命令mvn dependency:tree看依賴關係，如下圖紅框所示，spring-cloud-netflix-eureka-client被spring-cloud-starter-eureka間接依賴了：

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

- 之前的疑惑已解開，分析如下：
1. 由於spring-cloud-starter-eureka的間接依賴，spring-cloud-netflix-eureka-client會出現在classpath中；
2. 因此spring啟動時會掃描到spring-cloud-netflix-eureka-client.jar包中的spring.factories檔案；
3. 如果當前工程使用了EnableDiscoveryClient註解，按照spring.factories中的配置，配置類EurekaDiscoveryClientConfiguration會生效，進而開啟服務註冊發現功能；

### 小結
- 至此，EnableDiscoveryClient與EnableEurekaClient的區別我們已經全部弄明白了，在這裡小結一下吧：

- 在Spring Cloud的Dalston及其之前的版本中：
1. 從2014年的Spring Cloud 1.0.0.RC1版本開始，官方就推薦使用EnableDiscoveryClient來取代EnableEurekaClient；
2. EnableEurekaClient原始碼中使用了註解EnableDiscoveryClient，因此如果要使用eureka的註冊發現服務，兩者功能是一樣的；
3. EnableDiscoveryClient註解在spring.factories配置中透過配置項EurekaDiscoveryClientConfiguration來開啟服務註冊發現功能；

- 在Dalston之後的版本中（不含Dalston）：
1. 在spring.factories配置中，配置類EurekaDiscoveryClientConfiguration被配置到springboot的自動配置註解中，與EnableDiscoveryClient註解沒有關係了,也就是說只要開啟了springboot的自動配置，服務註冊發現功能就會啟用；
2. EnableEurekaClient原始碼中沒有使用註解EnableDiscoveryClient，此時EnableEurekaClient已經沒用了；

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

EnableDiscoveryClient與EnableEurekaClient的區別(Edgware版)

相關文章