实践Spring Cloud之Eureka

Posted on | In | Visitors

Spring Cloud Eureka Architecture

注：spring-cloud-starter-eureka已经依赖了spring-cloud-starter-ribbon

Eureka Server

1
2
3
4
<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-starter-eureka-server</artifactId>
</dependency>

@EnableEurekaServer

org.springframework.cloud.netflix.eureka.server.EurekaServerConfigBean，此类实现了com.netflix.eureka.EurekaServerConfig.所有的配置属性以eureka.server开头

1
2
3
4
5
6
# Eureka server响应缓存更新时间间隔，Eureka server面板绕过响应缓存的，可以实时看到最新的注册信息
eureka.server.responseCacheUpdateIntervalMs=30
# Eureka server启动是尝试从其他Eureka server同步注册信息，最多5次
eureka.server.numberRegistrySyncRetries=5
# 如果最终失败，则5分钟内阻止客户端从此Eureka server获取注册信息
eureka.server.getWaitTimeInMsWhenSyncEmpty=5

自我保护

1
EMERGENCY! EUREKA MAY BE INCORRECTLY CLAIMING INSTANCES ARE UP WHEN THEY'RE NOT. RENEWALS ARE LESSER THAN THRESHOLD AND HENCE THE INSTANCES ARE NOT BEING EXPIRED JUST TO BE SAFE.

1
eureka.server.enable-self-preservation=false

1
THE SELF PRESERVATION MODE IS TURNED OFF.THIS MAY NOT PROTECT INSTANCE EXPIRY IN CASE OF NETWORK/OTHER PROBLEMS.

服务同步

给注册

提供注册信息

失效剔除

region

默认：us-east-1

1
2
# 自定义region
eureka.client.region=shanghai

zone

默认：defaultZone

1
2
3
# 自定义zone
eureka.client.available-zone.us-east-1=dev,test
eureka.client.available-zone.shanghai=dev,test

Ribbon默认优先访问位于同一zone的服务，其次才是其他zone的服务端

安全保护

1
2
3
4
<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-security</artifactId>  
</dependency>

新增配置：

1
2
3
security.basic.enabled=true
security.user.name=admin
security.user.password=admin123

or

1
2
3
4
5
6
7
# 安全认证的配置  
security:
  basic:
    enabled: true
  user:
    name: admin
    password: admin123

浏览器访问eureka console需要登录。

Eureka Client

1
2
3
4
<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>

@EnableDiscoveryClient

com.netflix.discovery.DiscoveryClient

com.netflix.discovery.shared.resolver.aws.ConfigClusterResolver.getClusterEndpointsFromConfig()

com.netflix.appinfo.InstanceInfo.getZone(String[], InstanceInfo)：当前eureka instance的zone，available-zones的第一个

com.netflix.discovery.endpoint.EndpointUtils.getServiceUrlsMapFromConfig(EurekaClientConfig, String, boolean)

org.springframework.cloud.netflix.eureka.EurekaClientConfigBean，此类实现了com.netflix.discovery.EurekaClientConfig接口，所有的配置属性以eureka.client开头

eureka客户端：

1
eureka.client.service-url.defaultZone=http://admin:admin123@192.168.70.139:8888/eureka/

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
# 配置Eureka server地址，zone-》eureka server list，默认已经定义了defaultZone-》http://localhost:8761/eureka/
eureka.client.service-url.defaultZone=http://192.168.70.139:8888/eureka/
eureka.client.service-url.zone1=http://192.168.70.139:8888/eureka/,http://192.168.70.139:8888/eureka/
# 定义实例可用区域和所在区域（第一个），region-》zone list，如果region没有定义zone list，则取默认的defaultZone，会以所在区域去找eureka server
eureka.client.availability-zones.beijing=zone1,zone2
# 定义服务所在region，默认值us-east-1
eureka.client.region=beijing
# 定义Eureka server地址刷新时间间隔（默认5分钟），可以用来实现动态修改Eureka server地址
eureka.client.eureka-service-url-poll-interval-seconds=300
# 是否注册到Eureka server
eureka.client.register-with-eureka=true
# 向Eureka server发送心跳间隔
eureka.instance.lease-renewal-interval-in-seconds=30
# 如果发送心跳失败，则以2的指数形式延长心跳时间间隔，直到指数上线，然后不断重试
eureka.client.heartbeatExecutorExponentialBackOffBound
# 如果Eureka server连续90秒内没有收到心跳，则会将其移出Eureka server
eureka.instance.lease-expiration-duration-in-seconds=90
# 首次向Eureka server发送InstanceInfo
eureka.client.initialInstanceInfoReplicationIntervalSeconds=40
# 以后每次发送InstanceInfo时间间隔
eureka.client.instanceInfoReplicationIntervalSeconds=30
# 是否从Eureka server获取注册信息
eureka.client.fetch-registry=true
# 获取注册信息时间间隔
eureka.client.registryFetchIntervalSeconds=30
# 如果获取注册信息失败，则以2的指数形式延长心跳时间间隔，直到指数上线，然后不断重试
eureka.client.cacheRefreshExecutorExponentialBackOffBound
# 默认是增量获取注册信息
eureka.client.shouldDisableDelta=true

服务注册

服务续约（renew）

获取服务

服务调用

缓存

服务下线

更新

负载均衡

当无法连接到eureka server时报错如下：

1
2
3
4
5
6
2017-12-29 09:46:57.540 ERROR 5092 --- [           main] com.netflix.discovery.DiscoveryClient    : DiscoveryClient_CTS-HELLO-CLIENT/192.168.88.123:cts-hello-client - was unable to refresh its cache! status = Cannot execute request on any known server

com.netflix.discovery.shared.transport.TransportException: Cannot execute request on any known server
	at com.netflix.discovery.shared.transport.decorator.RetryableEurekaHttpClient.execute(RetryableEurekaHttpClient.java:111) ~[eureka-client-1.6.2.jar:1.6.2]
	at com.netflix.discovery.shared.transport.decorator.EurekaHttpClientDecorator.getApplications(EurekaHttpClientDecorator.java:134) ~[eureka-client-1.6.2.jar:1.6.2]
...

Eureka Instance

org.springframework.cloud.netflix.eureka.EurekaInstanceConfigBean，此类间接实现了com.netflix.appinfo.EurekaInstanceConfig，所有的配置属性以eureka.instance开头。

1
2
3
4
5
6
7
8
9
10
# 实例主机名（基于主机名注册的情况下，同一主机名下不可以运行多个eureka server）
eureka.instance.hostname=peer1
# 默认主机名注册，可以修改为ip注册优先，eureka list status显示名称对应的连接
eureka.instance.prefer-ip-address=true
# 自定义元数据
eureka.instance.metadata-map.zone=zone1
# 如果应用定义了context-path，则需要配置
eureka.instance.metadata-map.configPath=${server.servlet.context-path:}
# eureka.instace.instance-id，eureka list status显示名称
eureka.instance.instance-id=${spring.cloud.client.ipAddress}:${spring.application.name}:${server.port}