Spring Cloud 基于 Netflix 的几个开源项目进行了封装,提供包括服务注册与发现(Eureka),智能路由(Zuul),熔断器(Hystrix),客户端负载均衡(Ribbon)等在内的核心组件。

在微服务系统中,服务少则十几、几十个,多则上百、几百个(据悉 Netflix 的云平台上运行了500多个微服务),这些微服务通过相互调用来为用户提供功能。那么一个服务调用另一个服务是如何进行的,如何定位到另一个服务的地址?代码中写死,还是配置文件中配置?显然对于服务数量较多的系统,这两种方式先不说后续维护,光写起来就很痛苦。于是,对于微服务架构来说,服务的自动注册与发现就成为非常核心的功能,Eureka就是来负责实现这个功能的。

本系列文章与示例均基于最新的Spring Cloud Hoxton版编写。

Eureka


Eureka是一个基于REST的服务,包括Eureka Server与Eureka Client两个端。Eureka Server作为服务注册中心接受Eureka Client的注册及获取其它服务的地址信息。基本架构如下图所示:

Eureka基本架构

其中

  • Eureka Server: 作为服务注册中心,提供服务注册与发现功能接口

  • Service Provider: 服务提供者,将自身服务注册到服务注册中心,供其它服务消费者发现与调用

  • Service Consumer: 服务消费者,从服务注册中心发现服务,并通过一些负载均衡客户端来调用(比如Ribbon或Feign)

很多时候同一个应用可能既是服务提供者,也是服务消费者——自己作为服务方,为其它服务提供接口,同时也调用其它服务的接口来完成自身的业务逻辑。

Eureka Server


Eureka Server的搭建非常简单,其部署可分为单实例部署与多实例集群部署,一般开发测试环境可以使用单实例部署,但生产环境出于高可用要求,可进行多实例集群部署。

  1. 在pom.xml中添加依赖
    1
    2
    3
    4
    <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    </dependency>

为了方便版本引入,可以在pom中添加依赖管理,这样spring cloud相关的starter依赖就不需要指定版本了(如上省略了version)

1
2
3
4
5
6
7
8
9
10
11
<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>

  1. 在启动类上添加注解 @EnableEurekaServer

    1
    2
    3
    4
    5
    6
    7
    8
    @SpringBootApplication
    @EnableEurekaServer
    public class EurekaApplication {

    public static void main(String[] args) {
    SpringApplication.run(EurekaApplication.class, args);
    }
    }
  2. 在application.yml 或 application.properties配置文件中添加配置(个人比较倾向于yml,两者区别可自行百度)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    spring:
    application:
    name: spring-cloud-eureka
    profiles:
    active: single

    server:
    port: 8761

    ---
    spring:
    profiles: single
    eureka:
    instance:
    hostname: localhost
    client:
    registerWithEureka: false
    fetchRegistry: false
    serviceUrl:
    defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

    ---
    spring:
    profiles: peer1
    server:
    port: 8761
    eureka:
    instance:
    hostname: peer1
    client:
    serviceUrl:
    defaultZone: http://peer2:8762/eureka/,http://peer3:8763/eureka/
    ---
    spring:
    profiles: peer2
    server:
    port: 8762
    eureka:
    instance:
    hostname: peer2
    client:
    serviceUrl:
    defaultZone: http://peer1:8761/eureka/,http://peer3:8763/eureka/
    ---
    spring:
    profiles: peer3
    server:
    port: 8763
    eureka:
    instance:
    hostname: peer3
    client:
    serviceUrl:
    defaultZone: http://peer1:8761/eureka/,http://peer2:8762/eureka/

在该配置文件中,实际上是定义了两种模式,其中默认的profile single是单实例模式, peer1, peer2, peer3组成多实例模式。

  • eureka.client.registerWithEureka:表示是否将自身注册到Eureka Server,默认为true,单实例模式下一般设置为false,否则会在启动时报连接不到服务器的错误
  • eureka.client.fetchRegistry:表示是否从Eureka Server获取注册服务列表,默认为true,同样在单实例模式下设置为false
  • eureka.client.serviceUrl.defaultZone:Eureka Server的地址,多实例模式下多个地址以“,”隔开,多个实例之间只要有一条路线连通,则总会将注册信息进行同步
  1. 启动

对于单实例模式,如果按如上配置,则直接启动程序即可。启动完成后,访问 http://localhost:8761,即可查看Eureka Server的相关信息,如

单实例模式

上图所示,当前没有Eureka Server的副本也没有任何服务注册。

对于多实例集群模式,则需要根据不同的profile启动多个实例,

1
2
3
4
5
mvn clean package
cd target
java -jar springcloud-eureka-1.0-SNAPSHOT.jar --spring.profiles.active=peer1
java -jar springcloud-eureka-1.0-SNAPSHOT.jar --spring.profiles.active=peer2
java -jar springcloud-eureka-1.0-SNAPSHOT.jar --spring.profiles.active=peer3

启动完成后,打开 http://localhost:8761, 可以看到Eureka Server已经存在副本与注册的服务了(Eureka将自身作为一个服务完成了注册)

多实例模式

上述操作如果是在单机进行,则需要在hosts文件中添加映射,linux下是/etc/hosts,windows10 下是C:\Windows\System32\drivers\etc\hosts,

1
2
3
127.0.0.1 peer1
127.0.0.1 peer2
127.0.0.1 peer3

Eureka Client


Eureka Client一般集成在各个微服务中,集成也非常简单。

  1. pom.xml中添加依赖

    1
    2
    3
    4
    5
    6
    7
    8
    <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-web</artifactId>
    </dependency>
  2. application.yml配置文件中添加配置

    1
    2
    3
    4
    5
    6
    7
    eureka:
    client:
    serviceUrl:
    defaultZone: http://localhost:8761/eureka/
    instance:
    prefer-ip-address: true
    instance-id: ${spring.application.name}:${random.uuid}

如果是多实例集群模式,则 eureka.client.serviceUrl.defaultZone 可以配置多个地址,“,”号分隔。

  • eureka.client.*: 发现服务的配置参数
  • eureka.instance.*: 注册服务的配置参数, 如上 eureka.instance.prefer-ip-address 设置为true表示服务注册时使用IP,而不是hostname; eureka.instance.instance-id 配置服务实例的ID,默认为 ${spring.cloud.client.hostname}:${spring.application.name}:${spring.application.instance_id:${server.port}}}

添加了依赖就能集成Eureka Client,主类上添加 @EnableDiscoveryClient 注解不是必须。

启动程序后,进入Eureka Server页面即可看到注册的服务

Eureka客户端

一些知识点(建议掌握)


  1. Eureka Client在注册服务时,提供包括hostname,IP地址, port, health indicator url,status page, home page 等在内的meta-data,其它客户端可通过这些信息来直接与服务进行交互,我们也可以通过 eureka.instance.metadataMap 来添加自定义的meta-data,供客户端访问

  2. Eureka Server通过接收Eureka Client的心跳消息来判断服务实例是否存活,如果某一个实例的心跳在特定时间(可配置)内没收到,则将其从注册表中移除。心跳默认间隔为30s,一个服务被其它客户端发现,可能需要经过3次心跳,这也是有时候服务注册比较慢的原因。可通过eureka.instance.leaseRenewalIntervalInSeconds配置,但生产环境建议最好保持默认

  3. Eureka Client默认不会传播当前应用的健康检查状态,一旦注册成功,只要心跳存在,Eureka总是认为应用处于UP状态。可以启用Eureka的健康检查,将状态传播给Eureka,其它应用只会将请求发给UP状态的服务实例 eureka.client.healthcheck.enabled=true。注意这个配置只能配置在application.yml中,配置在bootstrap.yml中可能导致注册服务时,服务以状态为UNKOWN进行注册

  4. Eureka Server是没有后端存储的,服务实例需要通过心跳来更新注册信息,注册信息存于内存中,Eureka Client也有一个基于内存的缓存,不需要每次请求服务都要访问注册中心获取服务地址信息

  5. Eureka的自我保护机制:Eureka Server在短时间内丢失比较多的客户端时,会进入自我保护模式,在该模式下,Eureka Server即使发现服务实例已经不再发送心跳了,也不会从服务注册表中删除。这样,当发生网络故障时,服务注册信息仍然存于Eureka中,当网络故障恢复后,会自动退出自我保护模式。自我保护模式是一种应对网络异常的安全保护机制。相关配置: eureka.server.renewal-percent-threshold, 触发自我保护机制的阈值,默认为0.85; eureka.server.enable-self-preservation, 自我保护开启,默认为true,如果设置为false,则关闭客户端程序后,可直观地从Eureka Server的页面发现服务实例被注销删除了。

本文示例代码