Eureka微服務雲架構源碼分析
我們在將一個普通的Spring Boot應用註冊到Eureka Server中,或是從Eureka Server中獲取服務列表時,主要就做了兩件事:
在應用主類中配置了@EnableDiscoveryClient註解
在application.properties中用eureka.client.serviceUrl.defaultZone參數指定了服務註冊中心的位置
/** * Annotation to enable a DiscoveryClient implementation. * @author Spencer Gibb */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @Import(EnableDiscoveryClientImportSelector.class) public @interface EnableDiscoveryClient { }
從該註解的註釋我們可以知道:該註解用來開啟DiscoveryClient的實例。通過搜索DiscoveryClient,我們可以發現有一個類和一個接口。通過梳理可以得到如下圖的關系:
其中,左邊的org.springframework.cloud.client.discovery.DiscoveryClient是Spring Cloud的接口,它定義了用來發現服務的常用抽象方法,而org.springframework.cloud.netflix.eureka.EurekaDiscoveryClient是對該接口的實現,從命名來就可以判斷,它實現的是對Eureka發現服務的封裝。所以EurekaDiscoveryClient依賴了Eureka的com.netflix.discovery.EurekaClient接口,EurekaClient繼承了LookupService接口,他們都是Netflix開源包中的內容,它主要定義了針對Eureka的發現服務的抽象方法,而真正實現發現服務的則是Netflix包中的com.netflix.discovery.DiscoveryClient類。
那麽,我們就看看來詳細看看DiscoveryClient類。先解讀一下該類頭部的註釋有個總體的了解,註釋的大致內容如下:
這個類用於幫助與Eureka Server互相協作。
Eureka Client負責了下面的任務:
- 向Eureka Server註冊服務實例
- 向Eureka Server為租約續期
- 當服務關閉期間,向Eureka Server取消租約
- 查詢Eureka Server中的服務實例列表
Eureka Client還需要配置一個Eureka Server的URL列表。
在具體研究Eureka Client具體負責的任務之前,我們先看看對Eureka Server的URL列表配置在哪裏。根據我們配置的屬性名:eureka.client.serviceUrl.defaultZone,通過serviceUrl我們找到該屬性相關的加載屬性,但是在SR5版本中它們都被@Deprecated標註了,並在註視中可以看到@link到了替代類com.netflix.discovery.endpoint.EndpointUtils,我們可以在該類中找到下面這個函數:
public static Map<String, List<String>> getServiceUrlsMapFromConfig(
EurekaClientConfig clientConfig, String instanceZone, boolean preferSameZone) {
Map<String, List<String>> orderedUrls = new LinkedHashMap<>();
String region = getRegion(clientConfig);
String[] availZones = clientConfig.getAvailabilityZones(clientConfig.getRegion());
if (availZones == null || availZones.length == 0) {
availZones = new String[1];
availZones[0] = DEFAULT_ZONE;
}
……
int myZoneOffset = getZoneOffset(instanceZone, preferSameZone, availZones);
String zone = availZones[myZoneOffset];
List<String> serviceUrls = clientConfig.getEurekaServerServiceUrls(zone);
if (serviceUrls != null) {
orderedUrls.put(zone, serviceUrls);
}
……
return orderedUrls;
}
Region、Zone
在上面的函數中,我們可以發現客戶端依次加載了兩個內容,第一個是Region,第二個是Zone,從其加載邏上我們可以判斷他們之間的關系:
通過getRegion函數,我們可以看到它從配置中讀取了一個Region返回,所以一個微服務應用只可以屬於一個Region,如果不特別配置,就默認為default。若我們要自己設置,可以通過eureka.client.region屬性來定義。
public static String getRegion(EurekaClientConfig clientConfig) {
String region = clientConfig.getRegion();
if (region == null) {
region = DEFAULT_REGION;
}
region = region.trim().toLowerCase();
return region;
}
通過getAvailabilityZones函數,我們可以知道當我們沒有特別為Region配置Zone的時候,將默認采用defaultZone,這也是我們之前配置參數eureka.client.serviceUrl.defaultZone的由來。若要為應用指定Zone,我們可以通過eureka.client.availability-zones屬性來進行設置。從該函數的return內容,我們可以Zone是可以有多個的,並且通過逗號分隔來配置。由此,我們可以判斷Region與Zone是一對多的關系。
public String[] getAvailabilityZones(String region) {
String value = this.availabilityZones.get(region);
if (value == null) {
value = DEFAULT_ZONE;
}
return value.split(",");
}
ServiceUrls
在獲取了Region和Zone信息之後,才開始真正加載Eureka Server的具體地址。它根據傳入的參數按一定算法確定加載位於哪一個Zone配置的serviceUrls。
int myZoneOffset = getZoneOffset(instanceZone, preferSameZone, availZones);
String zone = availZones[myZoneOffset];
List<String> serviceUrls = clientConfig.getEurekaServerServiceUrls(zone);
具體獲取serviceUrls的實現,我們可以詳細查看getEurekaServerServiceUrls函數的具體實現類EurekaClientConfigBean,該類是EurekaClientConfig和EurekaConstants接口的實現,用來加載配置文件中的內容,這裏有非常多有用的信息,這裏我們先說一下此處我們關心的,關於defaultZone的信息。通過搜索defaultZone,我們可以很容易的找到下面這個函數,它具體實現了,如何解析該參數的過程,通過此內容,我們就可以知道,eureka.client.serviceUrl.defaultZone屬性可以配置多個,並且需要通過逗號分隔。
public List<String> getEurekaServerServiceUrls(String myZone) {
String serviceUrls = this.serviceUrl.get(myZone);
if (serviceUrls == null || serviceUrls.isEmpty()) {
serviceUrls = this.serviceUrl.get(DEFAULT_ZONE);
}
if (!StringUtils.isEmpty(serviceUrls)) {
final String[] serviceUrlsSplit = StringUtils.commaDelimitedListToStringArray(serviceUrls);
List<String> eurekaServiceUrls = new ArrayList<>(serviceUrlsSplit.length);
for (String eurekaServiceUrl : serviceUrlsSplit) {
if (!endsWithSlash(eurekaServiceUrl)) {
eurekaServiceUrl += "/";
}
eurekaServiceUrls.add(eurekaServiceUrl);
}
return eurekaServiceUrls;
}
return new ArrayList<>();
}
當客戶端在服務列表中選擇實例進行訪問時,對於Zone和Region遵循這樣的規則:優先訪問同自己一個Zone中的實例,其次才訪問其他Zone中的實例。通過Region和Zone的兩層級別定義,配合實際部署的物理結構,我們就可以有效的設計出區域性故障的容錯集群。
從現在開始,我這邊會將近期研發的springcloud微服務雲架構的搭建過程和精髓記錄下來,幫助更多有興趣研發spring cloud框架的朋友,希望可以幫助更多的好學者。大家來一起探討spring cloud架構的搭建過程及如何運用於企業項目。
Eureka微服務雲架構源碼分析