SpringCloud Eureka Server 源码解析

小鱼儿 2022-12-29 14:23 159阅读 0赞

**SpringCloud Eureka Server 源码解析**  
Eureka Server 作为一个开箱即用的服务注册中心，提供了以下的功能，用以满足与Eureka Client 交互的需求：

*  服务注册
 *  接受服务心跳
 *  服务剔除
 *  服务下线
 *  集群同步
 *  获取注册表中服务实例信息

需要注意的是， Eureka Server 同时也是一个Eureka C l ient ，在不禁止Eureka Server 的客户端行为时，它会向它配置文件中的其他Eureka Server 进行拉取注册表、服务注册和发送心跳等操作。

看本篇之前请先看  
[五分钟学会 Spring Cloud Eureka：服务注册与发现（小白必看，一看就会教程）][Spring Cloud Eureka]

[SpringCloud Eureka Client 源码解析][SpringCloud Eureka Client]

## 服务实例注册表 ##

InstanceRegistry 是Eureka Server 中注册表管理的核心接口。它的类结构如图4 - 14 所示。图中出现了两个InstanceRegistry ， 最下面的lnstanceRegistry 对Eureka Server 的注册表实现类PeerAwarelnstanceRegistrylmpl 进行了继承和扩展， 使其适配Spring Clo ud 的使用环境，主要实现由Peer AwarelnstanceR巳gistrylmpl 提供。  
上层的lnstanceRegistry 是E u reka Server 注册表的最核心接口，其职责是在内存中管理注册到Eureka Server 中的服务实例信息。

InstanceRegist可分别继承了LeaseManager 和LookupService 接口。LeaseManager 接口的功能是对注册到Eureka Server 中的服务实例租约进行管理。而LookupService 提供对服务实例进行检索的功能，在Eureka Client 的源码解析中已进行介绍，在此不对其接口进行展示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70]  
LeaseManager 接口提供的方法代码如下所示：

//LeaseManager.java
    public 工nterface LeaseManager<T> { 
    void register(T r , int leaseDuration , boolean isReplication) ;
    boolean cancel(Str 工ng appName , String id , boolean isReplication);
    boolean renew(String appName , String id , boolean isReplication);
    void evict () ;

LeaseManager 接口作用是对注册到Eureka Server 中的服务实例租约进行管理，分别有服务注册、服务下线、服务租约更新以及服务剔除等操作。  
LeaseManager 中管理的对象是Lease , Lease 代表一个Eureka Client 服务实例信息的租约，它提供了对其内持有的类的时间有效性操作。Lease 持有的类是代表服务实例信息的Instanceinfo 。Lease 中定义了租约的操作类型，分别是注册、下线、更新，同时提供了对租约中时间属性的各项操作。租约默认有效时长（ duration ）为90 秒。

InstanceRegi stry 在继承LeaseManager 和Lookup Service 接口的基础上，还添加了一些特有的方法，可以更为简单地管理服务实例租约和查询注册表中的服务实例信息。可以通过AbstractinstanceRegistry 查看InstanceRegistry 接口方法的具体实现。

PeerAwareinstanceRegis町继承了Instanc巳Registry 接口，在其基础上添加了Eureka Server集群同步的操作，其实现类PeerAwareinstanceRegistryimpl 继承了AbstractinstanceRegistry  
的实现，在对本地注册表操作的基础上添加了对其peer 节点的同步复制操作，使得EurekaSever 集群中的注册表信息保持一致。

## 服务注册 ##

我们了解到Eureka C lient 在发起服务注册时－会将自身的服务实例元数据封装在Instancelnfo中，然后将Instancelnfo 发送到Eureka Server。Eureka Server 在接收到Eureka Client 发送的Instancelnfo 后将会尝试将其放到本地注册表中以供其他E山·eka Cli ent 进行服务发现。

在register 中，服务实例的Instancelnfo 保存在Lease 中， Lease 在AbstractlnstanceRegistry中统一通过ConcurrentHashMap 保存在内存中。在服务注册过程中，会先获取一个读锁，防止其他线程对reg i stry 注册表进行数据操作，避免数据的不一致。然后从resgitry  
查询对应的Instancelnfo 租约是否已经存在注册表中，根据appName 划分服务集群，使用Instanceld 唯一标记服务实例。如果租约存在，比较两个租约中的lnstancelnfo 的最后更新时间lastDirtyTimestamp ，保留时间戳大的服务实例信息Instancelnfo 。如果租约不存在，意味这是一次全新的服务注册，将会进行自我保护的统计，创建新的租约保存Instancelnfo 。接着将租约放到resgitry 注册表中。

之后将进行一系列缓存操作并根据覆盖状态规则设置服务实例的状态， 缓存操作包括将lnstancelnfo 加人用于统计Eureka Client 增量式获取注册表信息的recentlyChangedQueue和失效responseCach巳中对应的缓存。最后设置服务实例租约的上线时间用于计算租约的有  
效时间，释放读锁并完成服务注册.

## 接受服务心跳 ##

在Eureka Client 完成服务注册之后，它需要定时向Eureka Server 发送心跳请求（默认30 秒一次），维持自己在Eureka Server 中租约的有效性。  
Eureka Server 处理心跳请求的核心逻辑位于AbstractlnstanceRegistry\#renew 方法中。renew 方法是对Eureka Client 位于注册表中的租约的续租操作，不像register 方法需要服务  
实例信息，仅根据服务实例的服务名和服务实例i d 即可更新对应租约的有效时间。具体代码如下所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 1]  
在＃renew 方法中，不关注Instancelnfo ，仅关注于租约本身以及租约的服务实例状态。如果根据服务实例的appName 和instancelnfold 查询出服务实例的租约，并且根据\#g巳tOverriddenlnstanceStatu s 方法得到的instanceStatus 不为InstanceStatus.UNKNOWN,  
那么更新租约中的有效时间， 即更新租约Lease 中lastUpdateTimestamp ，达到续约的目的；如果租约不存在，那么返回续租失败的结果。

## 服务剔除 ##

如果Eureka Client 在注册后，既没有续约，也没有下线（服务崩溃或者网络异常等原因），那么服务的状态就处于不可知的状态，不能保证能够从该服务实例中获取到回馈， 所以需要服务剔除AbstractlnstanceRegistry\#evict 方法定时清理这些不稳定的服务，该方法会批量将注册表中所有过期租约剔除。实现代码如下所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 2]  
服务剔除将会遍历registry 注册表，找出其中所有的过期租约，然后根据配置文件中续租百分比阀值和当前注册表的租约总数量计算出最大允许的剔除租约的数量（当前注册表中租约总数量减去当前注册表租约阀值），分批次剔除过期的服务实例租约。对过期的服  
务实例租约调用AbstractinstanceReg istry\#interna !Cancel 服务下线的方法将其从注册表中清除掉。  
服务剔除＃evict 方法中有很多限制，都是为了保证Eureka Server 的

*  可用性：自我保护时期不能进行服务剔除操作。
 *  过期操作是分批进行。
 *  服务剔除是随机逐个剔除，剔除均匀分布在所有应用中，防止在同一时间内同一服务集群中的服务全部过期被剔除，以致大量剔除发生时，在未进行自我保护前促使了程序的崩溃。

服务剔除是一个定时的任务，所以AbstractlnstanceRegistry 中定义了一个Eviction Task 用于定时执行服务剔除，默认为6 0 秒一次。服务剔除的定时任务一般在AbstractlnstanceRegistry 初始化结束后进行，按照执行频率evictionlnterva!TirnerlnMs 的设定，定时剔除过期的服务实例租约。

## 服务下线 ##

Eureka C li ent 在应用销毁时， 会向Eureka Server 发送服务下线请求，清除注册表中关于本应用的租约，避免无效的服务调用。在服务剔除的过程中，也是通过服务下线的逻辑完成对单个服务实例过期租约的清除工作。服务下线的主要实现代码位于Abstractlnstanc巳Registry\# interna!Cance l 方法中，仅需要服务实例的服务名和服务实例id 即可完成服务下线。具体代码如下所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 3]  
internal Cancel 方法与register 方法的行为过程很类似， 首先通过reg istry 根据服务名和服务实例id 查询关于服务实例的租约Lease 是否存在，统计最近请求下线的服务实例用于Eureka Server 主页展示。如果租约不存在，返回下线失败；如果租约存在，从registry 注册表中移除， 设置租约的下线时间，同时在最近租约变更记录队列中添加新的下线记录， 以用于Eureka Client 的增量式获取注册表信息， 最后设置repsonse 缓存过期。  
internal Cancel 方法中同样通过读锁保证registry 注册表中数据的一致性，避免脏读。

## 集群同步 ##

如果Eureka Server 是通过集群的方式进行部署，那么为了维护整个集群中EurekaServer 注册表数据的一致性， 势必需要一个机制同步Eureka Server 集群中的注册表数据。  
Eureka Server 集群同步包含两个部分， 一部分是Eureka Server 在启动过程中从它的peer 节点中拉取注册表信息，并将这些服务实例的信息注册到本地注册表中；另一部分是Eureka Server 每次对本地注册表进行操作时，同时会将操作同步到它的peer 节点中， 达到集群注册表数据统一的目的。

**Eureka Server 初始化本地注册表信息**  
在Eureka Server 启动的过程中， 会从它的peer 节点中拉取注册表来初始化本地注册表，这部分主要通过PeerAwareinstanceRegis 町＃ sync Up 方法完成，它将从可能存在的peer 节点中，拉取peer 节点中的注册表信息，并将其中的服务实例信息注册到本地注册表中.  
Eureka Server 也是一个Eureka Client ，在启动的时候也会进行DiscoveryClient 的初始化，会从其对应的Eureka Server 中拉取全量的注册表信息。在Eureka Server 集群部署的情况下， Eureka Server 从它的peer 节点中拉取到注册表信息后，将遍历这个Applications ，将所有的服务实例通过AbstractRegistry\#register 方法注册到自身注册表中。

在初始化本地注册表时， Eureka Server 并不会接受来自Eureka Cli 巳nt 的通信请求（如注册、或者获取注册表信息等请求） 。在同步注册表信息结束后会通过PeerAwarelnstanceRegistrylmpl\#openForTraffic 方法允许该Serv巳r 接受流量。代码如下所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 4]  
**Eureka Server 之间注册表信息的同步复制**  
为了保证Eureka Server 集群运行时注册表信息的一致性， 每个Eureka Server 在对本地注册表进行管理操作时，会将相应的操作同步到所有peer 节点中。  
在PeerAwarelnstanceRegistrylmpl 中，对Abstractinstanc巳registry 中的＃register 、＃ canel和＃renew 等方法都添加了同步到peer 节点的操作，使Server 集群中注册表信息保持最终一致性，如下所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 5]

## 获取注册表中服务实例信息 ##

Eureka Se凹er 中获取注册表的服务实例信息主要通过两个方法实现： Abstractlnstanc巳Regis盯  
\#getApplicationsFromMultipleRegions 从多地区获取全量注册表数据， AbstractlnstanceRegistry  
\#getApplicationDeltasFromMultipleRegions 从多地区获取增量式注册表数据。  
获取增量式注册表信息将会从recentlyChangedQueue 中获取最近变化的服务实例信息。recentlyChangedQueue 中统计了近3 分钟内进行注册、修改和剔除的服务实例信息，在服务注册AbstractlnstanceRegistry\#registry 、接受心跳请AbstractlnstanceRegistry\#renew 和服务下线AbstractlnstanceRegis盯＃internalCancel 等方法中均可见到recentlyChangedQueue 对这些服务实例进行登记，用于记录增量式注册表信息。＃getApp licationsFromMultipleRegions方法同样提供了从远程Region 的Eureka Server 获取增量式注册表信息的能力。

写这篇真的花了很久的功夫，但是希望对大家有用，我也就没有白努力，最后记得 **点赞，收藏，关注** 一键三连  
微信搜索【码上代码】文章同步更新，更有**1000道互联网架构师面试题**等你，我们一起进大厂

[Spring Cloud Eureka]: https://blog.csdn.net/weixin_44302240/article/details/110799131
[SpringCloud Eureka Client]: https://blog.csdn.net/weixin_44302240/article/details/111473114
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70]: /images/20221120/beb4ef3a05314e13b138ce57a0074538.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 1]: /images/20221120/0f93321613c94b7ca8a3c4c14f62fe37.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 2]: /images/20221120/2127d995b278463da6b650423cf3abff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 3]: /images/20221120/041e1e40277944a1b31206b4702121ad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 4]: /images/20221120/398b38ac283e4ca8abba4dc674e20ce9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDMwMjI0MA_size_16_color_FFFFFF_t_70 5]: /images/20221120/389e58119a914ccdb96de10392de8495.png