Spring Cloud構建微服務架構：服務注冊與發現（Eureka、Consul）

作者：翟永超 2017-06-25 13:33:25

Spring Cloud是一個基于Spring Boot實現的云應用開發工具，它為基于JVM的云應用開發中涉及的配置管理、服務發現、斷路器、智能路由、微代理、控制總線、全局鎖、決策競選、分布式會話和集群狀態管理等操作提供了一種簡單的開發方式。

已經有非常長的時間沒有更新《Spring Cloud構建微服務架構》系列文章了，自從開始寫Spring Cloud的專題內容開始就獲得了不少的閱讀量和認可，當然也有一些批評，其中也不乏一些很中肯的意見和深度的問題，對我來說也是進一步提高的契機，在此感謝所有關注我博客的讀者們。

由于之前主要精力都花在的編寫《Spring Cloud微服務實戰》一書上，所以該系列文章就沒有得到持續的維護和更新。由于漫長的寫書過程和繁瑣的出版流程，在本書一面世的時候，在版本上已經落后于當前的最新版本。雖然在書中前前后后加入了一些版本更新的注意事項，但是認識過程不是一蹴而就的，總是隨著實踐的深入慢慢發現的。所以，決定重寫一下該系列文章，一方面將Spring Cloud的版本更新到Dalston，另一方面重新組織內容并增加一些之前沒有寫過的重要組件。希望通過這個系列，來幫助準備使用Spring Cloud的朋友們快速入門。同時，也是作為《Spring Cloud微服務實戰》一書對最新版本做一些不同內容的補充。

Spring Cloud簡介

Spring Cloud包含了多個子項目(針對分布式系統中涉及的多個不同開源產品)，比如：Spring Cloud Config、Spring Cloud Netflix、Spring Cloud0 CloudFoundry、Spring Cloud AWS、Spring Cloud Security、Spring Cloud Commons、Spring Cloud Zookeeper、Spring Cloud CLI等項目。

微服務架構

“微服務架構”在這幾年非常的火熱，以至于關于微服務架構相關的開源產品被反復的提及(比如：netflix、dubbo)，Spring Cloud也因Spring社區的強大知名度和影響力也被廣大架構師與開發者備受關注。

那么什么是“微服務架構”呢?簡單的說，微服務架構就是將一個完整的應用從數據存儲開始垂直拆分成多個不同的服務，每個服務都能獨立部署、獨立維護、獨立擴展，服務與服務間通過諸如RESTful API的方式互相調用。

對于“微服務架構”，大家在互聯網可以搜索到很多相關的介紹和研究文章來進行學習和了解。也可以閱讀始祖Martin Fowler的《Microservices》(中文版翻譯點擊查看)，本文不做更多的介紹和描述。

服務治理

在簡單介紹了Spring Cloud和微服務架構之后，下面回歸本文的主旨內容，如何使用Spring Cloud來實現服務治理。

由于Spring Cloud為服務治理做了一層抽象接口，所以在Spring Cloud應用中可以支持多種不同的服務治理框架，比如：Netflix Eureka、Consul、Zookeeper。在Spring Cloud服務治理抽象層的作用下，我們可以無縫地切換服務治理實現，并且不影響任何其他的服務注冊、服務發現、服務調用等邏輯。

所以，下面我們通過介紹兩種服務治理的實現來體會Spring Cloud這一層抽象所帶來的好處。

Spring Cloud Eureka

首先，我們來嘗試使用Spring Cloud Eureka來實現服務治理。

Spring Cloud Eureka是Spring Cloud Netflix項目下的服務治理模塊。而Spring Cloud Netflix項目是Spring Cloud的子項目之一，主要內容是對Netflix公司一系列開源產品的包裝，它為Spring Boot應用提供了自配置的Netflix OSS整合。通過一些簡單的注解，開發者就可以快速的在應用中配置一下常用模塊并構建龐大的分布式系統。它主要提供的模塊包括：服務發現(Eureka)，斷路器(Hystrix)，智能路由(Zuul)，客戶端負載均衡(Ribbon)等。

下面，就來具體看看如何使用Spring Cloud Eureka實現服務治理。

創建“服務注冊中心”

創建一個基礎的Spring Boot工程，命名為eureka-server，并在pom.xml中引入需要的依賴內容：

<parent> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-parent</artifactId> 
    <version>1.5.4.RELEASE</version> 
    <relativePath/> 
</parent> 
<dependencies> 
    <dependency> 
        <groupId>org.springframework.cloud</groupId> 
        <artifactId>spring-cloud-starter-eureka-server</artifactId> 
    </dependency> 
</dependencies> 
<dependencyManagement> 
    <dependencies> 
        <dependency> 
           <groupId>org.springframework.cloud</groupId> 
           <artifactId>spring-cloud-dependencies</artifactId> 
           <version>Dalston.SR1</version> 
           <type>pom</type> 
           <scope>import</scope> 
        </dependency> 
    </dependencies> 
</dependencyManagement>

通過@EnableEurekaServer注解啟動一個服務注冊中心提供給其他應用進行對話。這一步非常的簡單，只需要在一個普通的Spring Boot應用中添加這個注解就能開啟此功能，比如下面的例子：

@EnableEurekaServer 
@SpringBootApplication 
public class Application { 
    public static void main(String[] args) { 
        new SpringApplicationBuilder(Application.class) 
                    .web(true).run(args); 
    } 
}

在默認設置下，該服務注冊中心也會將自己作為客戶端來嘗試注冊它自己，所以我們需要禁用它的客戶端注冊行為，只需要在application.properties配置文件中增加如下信息：

spring.application.name=eureka-server 
server.port=1001 
eureka.instance.hostname=localhost 
eureka.client.register-with-eureka=false 
eureka.client.fetch-registry=false

為了與后續要進行注冊的服務區分，這里將服務注冊中心的端口通過server.port屬性設置為1001。啟動工程后，訪問：http://localhost:1111/，可以看到下面的頁面，其中還沒有發現任何服務。

創建“服務提供方”

下面我們創建提供服務的客戶端，并向服務注冊中心注冊自己。本文我們主要介紹服務的注冊與發現，所以我們不妨在服務提供方中嘗試著提供一個接口來獲取當前所有的服務信息。

首先，創建一個基本的Spring Boot應用。命名為eureka-client，在pom.xml中，加入如下配置：

<parent>  
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-parent</artifactId> 
    <version>1.5.4.RELEASE</version> 
    <relativePath/> <!-- lookup parent from repository --> 
</parent> 
<dependencies> 
    <dependency> 
        <groupId>org.springframework.cloud</groupId> 
        <artifactId>spring-cloud-starter-eureka</artifactId> 
    </dependency> 
    <dependency> 
        <groupId>org.springframework.boot</groupId> 
        <artifactId>spring-boot-starter-web</artifactId> 
    </dependency> 
</dependencies> 
<dependencyManagement> 
    <dependencies> 
        <dependency> 
           <groupId>org.springframework.cloud</groupId> 
           <artifactId>spring-cloud-dependencies</artifactId> 
           <version>Dalston.SR1</version> 
           <type>pom</type> 
           <scope>import</scope> 
        </dependency> 
    </dependencies> 
</dependencyManagement>

其次，實現/dc請求處理接口，通過DiscoveryClient對象，在日志中打印出服務實例的相關內容。

@RestController 
public class DcController { 
    @Autowired 
    DiscoveryClient discoveryClient; 
    @GetMapping("/dc") 
    public String dc() { 
        String services = "Services: " + discoveryClient.getServices(); 
        System.out.println(services); 
        return services; 
    } 
}

最后在應用主類中通過加上@EnableDiscoveryClient注解，該注解能激活Eureka中的DiscoveryClient實現，這樣才能實現Controller中對服務信息的輸出。

@EnableDiscoveryClient 
@SpringBootApplication 
public class Application { 
    public static void main(String[] args) { 
        new SpringApplicationBuilder( 
            ComputeServiceApplication.class) 
            .web(true).run(args); 
    } 
}

我們在完成了服務內容的實現之后，再繼續對application.properties做一些配置工作，具體如下：

spring.application.name=eureka-client 
server.port=2001 
eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/

通過spring.application.name屬性，我們可以指定微服務的名稱后續在調用的時候只需要使用該名稱就可以進行服務的訪問。eureka.client.serviceUrl.defaultZone屬性對應服務注冊中心的配置內容，指定服務注冊中心的位置。為了在本機上測試區分服務提供方和服務注冊中心，使用server.port屬性設置不同的端口。

啟動該工程后，再次訪問：http://localhost:1001/。可以如下圖內容，我們定義的服務被成功注冊了。

當然，我們也可以通過直接訪問eureka-client服務提供的/dc接口來獲取當前的服務清單，只需要訪問：http://localhost:2001/dc，我們可以得到如下輸出返回：

Services: [eureka-client]

其中，方括號中的eureka-client就是通過Spring Cloud定義的DiscoveryClient接口在eureka的實現中獲取到的所有服務清單。由于Spring Cloud在服務發現這一層做了非常好的抽象，所以，對于上面的程序，我們可以無縫的從eureka的服務治理體系切換到consul的服務治理體系中區。

Spring Cloud Consul

Spring Cloud Consul項目是針對Consul的服務治理實現。Consul是一個分布式高可用的系統，它包含多個組件，但是作為一個整體，在微服務架構中為我們的基礎設施提供服務發現和服務配置的工具。它包含了下面幾個特性：

服務發現
健康檢查
Key/Value存儲
多數據中心

由于Spring Cloud Consul項目的實現，我們可以輕松的將基于Spring Boot的微服務應用注冊到Consul上，并通過此實現微服務架構中的服務治理。

以之前實現的基于Eureka的示例(eureka-client)為基礎，我們如何將之前實現的服務提供者注冊到Consul上呢?方法非常簡單，我們只需要在pom.xml中將eureka的依賴修改為如下依賴：

<dependency> 
  <groupId>org.springframework.cloud</groupId> 
  <artifactId>spring-cloud-starter-consul-discovery</artifactId> 
</dependency>

接下來再修改一下application.properites，將consul需要的配置信息加入即可，比如：(下面配置是默認值)

spring.cloud.consul.host=localhost 
spring.cloud.consul.port=8500

到此為止，我們將eureka-client轉換為基于consul服務治理的服務提供者就完成了。前文我們已經有提到過服務發現的接口DiscoveryClient是Spring Cloud對服務治理做的一層抽象，所以可以屏蔽Eureka和Consul服務治理的實現細節，我們的程序不需要做任何改變，只需要引入不同的服務治理依賴，并配置相關的配置屬性就能輕松的將微服務納入Spring Cloud的各個服務治理框架中。

下面可以嘗試讓consul的服務提供者運行起來。這里可能讀者會問，不需要創建類似eureka-server的服務端嗎?由于Consul自身提供了服務端，所以我們不需要像之前實現Eureka的時候創建服務注冊中心，直接通過下載consul的服務端程序就可以使用。

我們可以用下面的命令啟動consul的開發模式：

$consul agent -dev 
==> Starting Consul agent... 
==> Starting Consul agent RPC... 
==> Consul agent running! 
           Version: 'v0.7.2' 
         Node name: 'Lenovo-zhaiyc' 
        Datacenter: 'dc1' 
            Server: true (bootstrap: false) 
       Client Addr: 127.0.0.1 (HTTP: 8500, HTTPS: -1, DNS: 8600, RPC: 8400) 
      Cluster Addr: 127.0.0.1 (LAN: 8301, WAN: 8302) 
    Gossip encrypt: false, RPC-TLS: false, TLS-Incoming: false 
             Atlas: <disabled> 
==> Log data will now stream in as it occurs: 
    2017/06/22 07:50:54 [INFO] raft: Initial configuration (index=1): [{Suffrage:Voter ID:127.0.0.1:8300 Address:127.0.0.1:8300}] 
    2017/06/22 07:50:54 [INFO] raft: Node at 127.0.0.1:8300 [Follower] entering Follower state (Leader: "") 
    2017/06/22 07:50:54 [INFO] serf: EventMemberJoin: Lenovo-zhaiyc 127.0.0.1 
    2017/06/22 07:50:54 [INFO] consul: Adding LAN server Lenovo-zhaiyc (Addr: tcp/127.0.0.1:8300) (DC: dc1) 
    2017/06/22 07:50:54 [INFO] serf: EventMemberJoin: Lenovo-zhaiyc.dc1 127.0.0.1 
    2017/06/22 07:50:54 [INFO] consul: Adding WAN server Lenovo-zhaiyc.dc1 (Addr: tcp/127.0.0.1:8300) (DC: dc1) 
    2017/06/22 07:51:01 [ERR] agent: failed to sync remote state: No cluster leader 
    2017/06/22 07:51:02 [WARN] raft: Heartbeat timeout from "" reached, starting election 
    2017/06/22 07:51:02 [INFO] raft: Node at 127.0.0.1:8300 [Candidate] entering Candidate state in term 2 
    2017/06/22 07:51:02 [DEBUG] raft: Votes needed: 1 
    2017/06/22 07:51:02 [DEBUG] raft: Vote granted from 127.0.0.1:8300 in term 2. Tally: 1 
    2017/06/22 07:51:02 [INFO] raft: Election won. Tally: 1 
    2017/06/22 07:51:02 [INFO] raft: Node at 127.0.0.1:8300 [Leader] entering Leader state 
    2017/06/22 07:51:02 [INFO] consul: cluster leadership acquired 
    2017/06/22 07:51:02 [INFO] consul: New leader elected: Lenovo-zhaiyc 
    2017/06/22 07:51:02 [DEBUG] consul: reset tombstone GC to index 3 
    2017/06/22 07:51:02 [INFO] consul: member 'Lenovo-zhaiyc' joined, marking health alive 
    2017/06/22 07:51:02 [INFO] agent: Synced service 'consul' 
    2017/06/22 07:51:02 [DEBUG] agent: Node info in sync