【微服务~原始真解】Spring Cloud —— Eureka Client原码解析(二)

这里是【秒懂·云原生】，关注我学习云原生不迷路
如果对你有帮助，给博主一个免费的点赞以示鼓励
欢迎各位点赞评论收藏⭐️

专栏介绍

【秒懂·云原生】 目前主要更新微服务，一起学习一起进步。

本期介绍

主要介绍Spring Cloud —— Eureka Client原码解析(二)

服务发现客户端

为了对Eureka Client的执行原理进行讲解，首先需要对服务发现客户端com.netflix.discover.DiscoveryClient职能以及相关类进行讲解，它负责了与EurekaServer交互的关键逻辑。

1.DiscoveryClient职责

DiscoveryClient是Eureka Client的核心类，包括与Eureka Server交互的关键逻辑，具备了以下职能:

• 注册服务实例到Eureka Server中;
• 发送心跳更新与Eureka Server的租约;
• 在服务关闭时从Eureka Server中取消租约，服务下线;
• 查询在Eureka Server中注册的服务实例列表。

2.DiscoveryClient类结构

DiscoverClient的核心类图如图所示。

DiscoveryClient继承了LookupService接口，LookupService作用是发现活跃的服务实例，主要方法如下:

//LookupService. java
public interface LookupService<T> {
//根据服务实例注册的appName来获取封装有相同appName的服务实例信息容器Application getApplication(String appName) ;
//返回当前注册表中所有的服务实例信息
Applications getApplications () ;//根据服务实例的id获取服务实例信息
List<InstanceInfo> getInstancesById(String id) ;
}

Application持有服务实例信息列表，它可以理解成同一个服务的集群信息，这些服务实例都挂在同一个服务名appName下。InstanceInfo代表一个服务实例信息。
Application部分代码如下:

//Application. java
public class Application {
private static Random shuffleRandom = new Random() ;
//服务名
private String name;
@XStream0mitField
private volatile boolean isDirty = false;
@XStreamImplicit
private final Set<InstanceInfo> instances;
private final AtomicReference <List<InstanceInfo>> shuffledInstances;
private final Map<String， InstanceInfo> instancesMap;
}

为了保证原子性操作，Application中对Instancelnfo的操作都是同步操作。

Applications是注册表中所有服务实例信息的集合，里面的操作大多也是同步操作。

EurekaClient继承了LookupService接口，为DiscoveryClient提供了一个上层接口，目的是方便从Eureka 1.x到Eureka 2.x(已停止开发)的升级过渡。EurekaClient接口属于比较稳定的接口，即使在下一阶段也会被保留。

EurekaCient在LookupService的基础上扩充了更多的接口，提供了更丰富的获取服务实例的方式，主要有:

• 提供了多种方式获取Instancelnfo，例如根据区域、Eureka Server地址等获取。
• 提供了本地客户端（所处的区域、可用区等)的数据，这部分与AWS密切相关。
• 提供了为客户端注册和获取健康检查处理器的能力。

除去查询相关的接口，我们主要关注EurekaClient中以下两个接口，代码如下所示:

// EurekaClient.java
//为Eureka Client注册健康检查处理器
public void registerHealthCheck(HealthCheckHandler healthCheckHandler);
//为Eureka Client注册一个EurekaEventListener(事件监听器)
//监听Client服务实例信息的更新
public void registerEventListener(EurekaEventListener eventListener);

Eureka Server一般通过心跳(heartbeats）来识别一个实例的状态。EurekaClient中存在一个定时任务定时通过HealthCheckHandler检测当前Client的状态，如果Client的状态发生改变，将会触发新的注册事件，更新Eureka Server的注册表中该服务实例的相关信息。HealthCheckHandler的代码如下所示:

// HealthCheckHandler.java
public interface HealthCheckHandler {
InstanceInfo.InstanceStatus getStatus (InstanceInfo.InstanceStatus currentStatus) ;
}

HealthCheckHandler接口的代码如上所示，其在spring-cloud-netflix-eureka-client中的实现类为EurekaHealthCheckHandler，主要组合了spring-boot-actuator中的HealthAggregator和HealthIlndicator，以实现对Spring Boot应用的状态检测。
Eureka中的事件模式属于观察者模式，事件监听器将监听Client的服务实例信息变化，触发对应的处理事件，下图为Eureka事件的类图:

3.DiscoveryClient

DiscoveryClient可以说是Eureka Client的核心类，负责了与Eureka Server交互的关键逻辑，具备了以下的职能:

• 注册服务实例到Eureka Server中；
• 更新与Eureka Server的契约；
• 在服务关闭时从Eureka Server中取消契约；
• 查询在Eureka Server中注册的服务/实例的列表。

DiscoverClient的核心类图如下：

DiscoveryClient的顶层接口为LookupService，主要的目的是为了发现活跃中的服务实例。

public interface LookupService<T> {
 
	//根据服务实例注册的appName来获取，获取一个封装有相同appName的服务实例信息的容器
   Application getApplication(String appName);
	//返回当前注册的所有的服务实例信息
   Applications getApplications();
   	//根据服务实例的id获取
   	List<InstanceInfo> getInstancesById(String id);
   //获取下一个可能的Eureka Server来处理当前对注册表信息的处理，一般是通过循环的方式来获取下一个Server
   InstanceInfo getNextServerFromEureka(String virtualHostname, boolean secure);
}

Application中持有一个特定应用的多个实例的列表，可以理解成同一个服务的集群信息，它们都挂在同一个服务名appName下，InstanceInfo代表一个服务实例，部分代码如下：

public class Application {
    
    private static Random shuffleRandom = new Random();
 
    //服务名
    private String name;
 
    @XStreamOmitField
    private volatile boolean isDirty = false;
 
    @XStreamImplicit
    private final Set<InstanceInfo> instances;
 
    private final AtomicReference<List<InstanceInfo>> shuffledInstances;
 
    private final Map<String, InstanceInfo> instancesMap;
    
    .....
}

为了保证原子性操作以及数据的唯一性，防止脏数据，Application中对InstanceInfo的操作都是同步操作，感受一下Application.addInstance方法。

public void addInstance(InstanceInfo i) {
	instancesMap.put(i.getId(), i);
	synchronized (instances) {
	instances.remove(i);
	instances.add(i);
	isDirty = true;
	}
}

通过同步代码块，保证每次只有有一个线程对instances进行修改，同时注意instancesMap采用的是ConcurrentHashMap实现，保证了原子性的操作，所以不需要通过同步代码块进行控制。

Applications中代表的是Eureka Server中已注册的服务实例的集合信息，主要是对Application的封装，里面的操作大多也是的同步操作。

EurekaClient继承了LookupService接口，为DiscoveryClient提供了一个上层的接口，目的是试图方便从eureka 1.x 到eureka 2.x 的过渡，这说明EurekaClient这个接口属于比较稳定的接口，即使在下一大阶段也会被依旧保留。

EurekaCient在LookupService的基础上扩充了更多的接口，提供了更丰富的获取服务实例的功能，主要有:

• 提供了多种的方式获取InstanceInfo，例如根据region，Eureka Server地址等获取；
• 提供了本地客户端(位于的区域，可用区等)的数据，这部分与AWS密切相关；
• 提供了为客户端注册和获取健康检查处理器；

除去查询相关的接口，关注EurekaClient中的以下两个接口：

    // 为Eureka Client注册健康检查处理器
    // 一旦注册，客户端将通过调用新注册的健康检查处理器来对注册中instanceInfo
    // 进行一个按需更新，随后按照eurekaclientconfig.getinstanceinforeplicationintervalseconds()
    // 中配置的指定时间调用HealthCheckHandler
    public void registerHealthCheck(HealthCheckHandler healthCheckHandler);
 
    // 为eureka client注册一个EurekaEventListener(事件监听器)
    // 一旦注册，当eureka client的内部状态发生改变的时候，将会调用EurekaEventListener.onEvent()
    // 触发一定的事件。可以通过这种方式监听client的更新而非通过轮询的方式询问client
    public void registerEventListener(EurekaEventListener eventListener);

Eureka Server一般通过心跳(heartbeats)来识别一个实例的状态。Eureka Client中存在一个定时任务定时通过HealthCheckHandler检测当前client的状态，如果client的状态发生改变，将会触发新的注册事件，同步Eureka Server的注册表中该服务实例的相关信息。

public interface HealthCheckHandler {
    InstanceInfo.InstanceStatus getStatus(InstanceInfo.InstanceStatus currentStatus);
}

在spring-cloud-netflix-eureka-client中实现了这个的接口，EurekaHealthCheckHandler，主要的组合了spring-boot-actuator中的HealthAggregator和HealthIndicator实现了对spring-boot应用的状态检测。
主要有以下的状态：

public enum InstanceStatus {
	UP, // 可以接受服务请求
	DOWN, // 无法发送流量-健康检查失败
	STARTING, // 正在启动，无法发送流量
	OUT_OF_SERVICE, // 服务关闭，不接受流量
	UNKNOWN; // 未知状态
    }

Eureka中的事件模式，这是一个很明显的观察者模式，以下为它的类图类图：