Spring Cloud 入門教程 - Eureka服務註冊與發現

張旭乾發表於2018-05-03
SpringCloud

簡介

在微服務中，服務註冊與發現對管理各個微服務子系統起著關鍵作用。隨著系統水平擴充套件的越來越多，系統拆分為微服務的數量也會相應增加，那麼管理和獲取這些微服務的URL就會變得十分棘手，如果我們每新加一個微服務，就要在其它用到此微服務的地方手動加上它的URL地址或者其他通訊協議的地址，這樣會經常出錯，而且工作量巨大，一旦某個微服務的地址發生了變化，就要手動修改所有引用它的微服務的配置檔案。所以spring-cloud eureka server就是為了解決這樣的問題而出現，經過簡單的配置，即可自動註冊和發現微服務。

基礎環境

  • JDK 1.8
  • Maven 3.3.9
  • IntelliJ 2018.1
  • Git

專案原始碼

Gitee碼雲

搭建Eureka Server

上篇部落格我們介紹瞭如何搭建spring-cloud的配置中心，還有一個測試的web client去訪問它，這次我們在之前的基礎上搭建一個eureka server，並且讀取配置中心的配置，然後把web client作為Discovery Client註冊到eureka服務。首先在IntelliJ下新建一個Maven專案：

  • groupId: cn.zxuqian
  • artifactId: registry

然後在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>cn.zxuqian</groupId>
    <artifactId>registry</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
        <relativePath/>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</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>Finchley.M9</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/libs-milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

</project>
複製程式碼

這裡用到了spring-cloud-starter-netflix-eureka-server這個eureka-server核心依賴，還有訪問配置中心服務的客戶端元件spring-cloud-starter-config。 然後在src/main/resources下建立bootstrap.yml檔案，新增如下配置：

spring:
  application:
    name: eureka-server
  cloud:
    config:
      uri: http://localhost:8888
複製程式碼

此檔案配置了用以讀取配置檔案的應用名，即spring.application.name，它的名字對應於服務中心的檔名。另外Eureka的自動註冊和發現也是基於這個引數的。然後配置了配置服務中心的uri。 新建一個Java類，cn.zxuqian.Application，使用如下程式碼：

package cn.zxuqian;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

@EnableEurekaServer
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
複製程式碼

這裡只用@EnableEurekaServer一條註解即把該應用配置為Eureka Server。然後在配置中心的git倉庫中建立eureka-server.yml檔案，新增如下配置：

server:
  port: 8761

eureka: 
 client: 
  register-with-eureka: false
  fetch-registry: false
複製程式碼

此檔案配置了eureka-server的埠，以及關閉eureka自我註冊和發現，因為如果不關閉的話，eureka在啟動過程中就會去嘗試註冊自己，然而發現服務並沒有啟動就會報錯。到此，eureka server就配置完了。

更新Web Client

現在我們要更新web client，使之可以被eureka自動註冊和發現。首頁在pom.xml中新增eureka client的依賴：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
複製程式碼

然後在Application類中加上@EnableDiscoveryClient註解：

@EnableDiscoveryClient
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
複製程式碼

最後我們建立一個類用以測試服務是不是已成功註冊和發現。新建一個Java類cn.zxuqian.controllers.ServiceInstanceController，新增如下程式碼：

package cn.zxuqian.controllers;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class ServiceInstanceController {

    @Autowired
    private DiscoveryClient discoveryClient;

    @RequestMapping("/service-instances/{applicationName}")
    public List<ServiceInstance> serviceInstancesByApplicationName(
            @PathVariable String applicationName) {
        return this.discoveryClient.getInstances(applicationName);
    }

}
複製程式碼

這是一個普通的RestController, 定義了一個DiscoveryClient型別的變數並新增了@Autowire註解。此註解是Spring框架提供的依賴注入功能，在Spring的context下，它會自動尋找DiscoveryClient的實現類，此處是eureka client。關於Spring的一些特性和原理，將在以後的博文中講到。 此類還定義了serviceInstancesByApplicationName方法，用以處理/service-instances/{applicationName}請求。這裡的{applicationName}匹配url路徑中/service-instances/以後的部分，然後用@PathVariable註解賦值給方法的applicationName引數。例如訪問http://localhost:8080/service-instances/web-client，那麼applicationName的值就是web-client。方法的作用是從discoveryClient中根據spring.application.name的值來取出對應的例項資訊，返回的是一個list，會自動轉換為json陣列的形式返回給瀏覽器。

測試

因為eureka server和web client都需要從配置服務中讀取配置，所以先啟動config-server，然後再啟動eureka-server，最後啟動web-client，在啟動成功後可能需要稍等十幾秒讓eureka-server發現和註冊web-client。完成之後訪問http://localhost:8080/service-instances/web-client，會得到如下結果：

[{"host":"xuqians-imac","port":8080,"instanceInfo":{"instanceId":"xuqians-imac:web-client","app":"WEB-CLIENT","appGroupName":null,"ipAddr":"192.168.72.31","sid":"na","homePageUrl":"http://xuqians-imac:8080/","statusPageUrl":"http://xuqians-imac:8080/actuator/info","healthCheckUrl":"http://xuqians-imac:8080/actuator/health","secureHealthCheckUrl":null,"vipAddress":"web-client","secureVipAddress":"web-client","countryId":1,"dataCenterInfo":{"@class":"com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo","name":"MyOwn"},"hostName":"xuqians-imac","status":"UP","leaseInfo":{"renewalIntervalInSecs":30,"durationInSecs":90,"registrationTimestamp":1525319124967,"lastRenewalTimestamp":1525319124967,"evictionTimestamp":0,"serviceUpTimestamp":1525319124363},"isCoordinatingDiscoveryServer":false,"metadata":{"management.port":"8080"},"lastUpdatedTimestamp":1525319124967,"lastDirtyTimestamp":1525319124297,"actionType":"ADDED","asgName":null,"overriddenStatus":"UNKNOWN"},"metadata":{"management.port":"8080"},"uri":"http://xuqians-imac:8080","serviceId":"WEB-CLIENT","secure":false,"scheme":null}]
複製程式碼

注意一下，這裡並沒有把配置中心服務設定為可以被eureka server註冊和發現，因為這裡把配置檔案都放到了config-server中，它和eureka server有著雞生蛋，蛋生雞的問題，所以如果要讓config-server被自動註冊和發現，那麼就需要單獨配置eureka server，然後在config server中配置eureka的uri，以及設定spring.cloud.config.discovery.enabled為true。具體以後需要用的時候再詳細說明。

總結

配置eureka server相當簡單，只需要加一條@EnableEurekaServer註解，並在配置中關閉自我註冊和發現即可。然後在客戶端應用的Application類中加上@EnableDiscoveryClient註解即可。

歡迎訪問我的部落格

相關文章