SpringCloud系列三：將微服務注冊到Eureka Server上

1. 回顧

　　通過上篇博客的講解，我們知道硬編碼提供者地址的方式有不少問題。要想解決這些問題，服務消費者需要一個強大的服務發現機制，服務消費者使用這種機制獲取服務提供者的網絡信息。不僅如此，即使服務提供者的信息發生變化，服務消費者也無須修改配置文件。

　　服務提供者、服務消費者、服務發現組件這三者之間的關系大致如下：

• 各個微服務在啟動時，將自己的網絡地址等信息注冊到服務發現組件中，服務發現組件會存儲這些信息
• 服務消費者可從服務發現組件查詢服務提供者的網絡地址，並使用該地址調用服務提供者的接口
• 各個微服務與服務發現組件使用一定機制（如心跳）通信。服務發現組件如長時間無法與某微服務實例通信，就會注銷該實例。
• 微服務網絡地址發生變更（例如實例增減或IP端口發生變化時），會重新注冊到服務發現組件中。

　　綜上，服務發現組建應具備以下功能。

• 服務注冊表：服務發現組件的核心，用來記錄各個微服務的信息。服務注冊組件提供查詢API和管理API，查詢API用於查詢可用的微服務實例，管理API用於服務的注冊和注銷。
• 服務注冊與服務發現：服務注冊是指微服務在啟動時，將自己的信息注冊到服務發現組件上的過程。服務發現是指查詢可用微服務列表及其網絡地址的機制。
• 服務檢查：服務發現組件使用一定機制定時檢測已注冊的服務，如發現某實例長時間無法訪問，就會從服務注冊表中移除該實例。

　　Spring Cloud提供了多種服務發現組件的支持，例如Eureka、Consul和ZooKeeper等。本文將以Eureka為例，講解服務注冊與發現。

2. Eureka簡介

　　Eureka是Netflix開源的服務發現組件，本身是一個基於REST的服務。它包含Server和Client兩部分。Spring Cloud將它集成在子項目Spring Cloud Netflix中，從而實現微服務的注冊與發現。

　　Eureka包含兩個組件：Eureka Server和Eureka Client。

• Eureka Server提供服務發現的能力，各個微服務啟動時，會向Eureka Server注冊自己的信息（例如IP、端口、微服務名等），Eureka Server會存儲這些信息。
• Eureka Client是一個Java客戶端，用於簡化與Eureka Server的交互。
• 微服務啟動后，會周期性（默認30s）向Eureka Server發送心跳以續約自己的“租期”。
• 如果Eureka Server在一定時間內沒有接收到某個微服務實例的心跳，Eureka Server將會注銷該實例（默認90s）。
• 默認情況下，Eureka Server同時也是Eureka Client。多個Eureka Server實例，互相之間通過復制的方式，來實現服務注冊表中數據的同步。
• Eureka Client會緩存服務注冊表中的信息。這種方式有一定的優勢 —— 首先，微服務無須每次都查詢Eureka Server，從而降低了Eureka Server的壓力；其次，即時Eureka Server所有節點都宕掉，服務消費者依然可以使用緩存中的信息找到服務提供者並完成調用。

　　綜上，Eureka通過心跳檢查、客戶端緩存等機制，提供了系統的靈活性、可伸縮性和可用性。

3. 實現單節點的Eureka Server

　　開發：

　　> 創建一個Spring Boot項目。pom.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.itmuch.cloud</groupId>
    <artifactId>microservice-descovery-eureka</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.M8</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</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>${spring-cloud.version}</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>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>


</project>

　　> 修改啟動類，在啟動類上添加@EnableEurekaServer注解，聲明這是一個Eureka Server。

package com.itmuch.cloud.microservicedescoveryeureka; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer; @EnableEurekaServer // 聲明這是一個Eureka Server
@SpringBootApplication public class MicroserviceDescoveryEurekaApplication { public static void main(String[] args) { SpringApplication.run(MicroserviceDescoveryEurekaApplication.class, args); } }

　　> 編寫配置文件。將application.properties重命名為application.yml。

server: port: 8761 eureka: instance: hostname: localhost client: register-with-eureka: false # 是否將自己注冊到Eureka Server，默認為true。由於當前應用就是Eureka Server，故而設為false fetch-registry: false # 表示是否從Eureka Sever獲取注冊信息，默認為true。因為這個一個單節點的Eureka Server，不需要同步其他的Eureka Server節點的數據，故而設為false service-url: defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka # 設置與Eureka Server交互的地址，查詢服務和注冊服務都需要依賴這個地址。

　　測試：

　　> 啟動Spring Boot項目，訪問：http://localhost:8761，如下圖，則正常

　　此時，還沒有任何微服務實例被注冊到Eureka Server上。

4. 將微服務注冊到Eureka Server上

• 改造用戶微服務：microservice-simple-provider-user

　　> 復制項目microservice-simple-provider-user，將ArtifactId修改為microservice-provider-user

　　> 在pom.xml中添加eureka依賴。內容如下：

<?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.itmuch.cloud</groupId>
    <artifactId>microservice-provider-user</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.M8</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</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>${spring-cloud.version}</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>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

</project>

　　> 在配置文件application.yml中添加如下配置：

spring application: name: microservice-provider-user # 指定注冊到Eureka Server上的應用名稱 eureka: client: service-url: defaultZone: http://localhost:8761/eureka/
 instance: prefer-ip-address: true # 將自己的IP注冊到Eureka Server。若不配置或設置為false，表示注冊微服務所在操作系統的hostname到Eureka Server

　　> 修改啟動類，在啟動類上添加@EnableDiscoveryClient注解，聲明這個一個Eureka Client。

　　　　也可以使用@EnableEurekaClient注解代替@EnableDiscoveryClient。在Spring Cloud中，服務發現組件也有多種選擇，例如Zookeeper、Consul等。

　　　　@EnableEurekaClient：表明是Eureka的Client，該注解時spring-cloud-netflix項目中的注解，只能與Eureka一起工作。

　　　　@EnableDiscoveryClient：為各個服務組件提供了支持，該注解時spring-cloud-commons項目的注解，是一個高度的抽象。

package com.itmuch.cloud.microserviceprovideruser; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; @SpringBootApplication @EnableDiscoveryClient // 聲明這是一個Eureka Client
public class MicroserviceProviderUserApplication { public static void main(String[] args) { SpringApplication.run(MicroserviceProviderUserApplication.class, args); } }

• 改造電影微服務：microservice-simple-consumer-movie

　　> 復制項目microservice-simple-consumer-movie，將ArtifactId修改為microservice-consumer-movie。

　　> 在pom.xml中添加eureka依賴。同上。

　　> 修改application.yml配置。將spring.application.name修改為microservice-consumer-movie，其他同上。

　　> 修改啟動類，在啟動類上添加@EnableDiscoveryClient注解。同上。

　　測試：

　　> 啟動microservice-discovery-eureka。（必須第一個啟動）

　　> 啟動microservice-provider-user。

　　> 啟動microservice-consumer-movie。

　　> 訪問 http://localhost:8761/，若如下圖，則正常。兩個微服務都已經注冊到服務發現組件中。

5. 總結

　　單節點的Eureka Server並不適合線上生成環境。

　　因此，下一篇博文將講解Eureka Server的高可用。敬請期待~~~

6. 參考：

　　周立 --- 《Spring Cloud與Docker微服務架構與實戰》