【云原生&微服务四】SpringCloud之Ribbon和Erueka/服务注册中心的集成细节（获取服务实例列表、动态更新服务实例信息、负载均衡出一个实例、IPing机制判断实例是否存活）

今天药忘吃喽~ 2023-09-28 10:19 49阅读 0赞

#### 文章目录 ####

*  一、前言
 *  二、Ribbon和Eureka
 *   *  1、Ribbon如何与eureka整合，通过eureka client获取到对应的注册表？
     *   *  1）为什么是DynamicServerListLoadBalancer的restOfInit()方法？
         *  2）DynamicServerListLoadBalancer\#restOfInit()
         *   *  0> 初始化服务实例列表流程图
             *  1> 初始化服务实例列表
             *  ServerList<T>从哪来的?
     *  2、 动态更新服务实例列表
     *   *  1）流程图
         *  2）流程解析
     *  3、 如何根据负载均衡规则从\`List<Server>\`中选出一个Server？
     *   *  1）轮询算法
     *  4、如何发送网络HTTP请求？
     *   *  1）流程图
         *  2）流程解析
     *  5、ping机制如何检查服务实例是否还存活？
     *   *  1）哪里使用到了IPing的isAlive()方法？
 *  三、总结 以及 后续文章

## 一、前言 ##

在前面的文章，博主聊了Ribbon如何与SpringCloud、Eureka集成，Ribbon如何自定义负载均衡策略、Ribbon如何和SpringCloud集成：

> 1.  [【云原生&微服务一】SpringCloud之Ribbon实现负载均衡详细案例（集成Eureka、Ribbon）][SpringCloud_Ribbon_Eureka_Ribbon]
> 2.  [【云原生&微服务二】SpringCloud之Ribbon自定义负载均衡策略（含Ribbon核心API）][SpringCloud_Ribbon_Ribbon_API]
> 3.  [【云原生&微服务三】SpringCloud之Ribbon是这样实现负载均衡的（源码剖析@LoadBalanced原理）][SpringCloud_Ribbon_LoadBalanced]

在[【云原生&微服务三】SpringCloud之Ribbon是这样实现负载均衡的（源码剖析@LoadBalanced原理）][SpringCloud_Ribbon_LoadBalanced]一文中博主分析到了SpringCloud集成Ribbon如何获取到负载均衡器`ILoadBalancer`；本文我们接着分析如下问题：

>  *  ZoneAwareLoadBalancer（属于ribbon）如何与eureka整合，通过eureka client获取到对应注册表?
>  *  ZoneAwareLoadBalancer如何持续从Eureka中获取最新的注册表信息?
>  *  如何根据负载均衡器`ILoadBalancer`从Eureka Client获取到的`List<Server>`中选出一个Server？
>  *  Ribbon如何发送网络HTTP请求？
>  *  Ribbon如何用IPing机制动态检查服务实例是否存活？

**PS：** 文章中涉及到的SpringBoot相关知识点，比如自动装配，移步博主的SpringBoot专栏：[Spring Boot系列][Spring Boot]。

**PS–2：Ribbon依赖Spring Cloud版本信息如下：**

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.3.7.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.SR8</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2.2.5.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

下面以请求`http://localhost:9090/say/saint`为入口进行debug。

## 二、Ribbon和Eureka ##

我们知道SpringCloud诞生之初，我们通常采用Eureka作为服务注册/发现中心、Ribbon作为负载均衡器，而Ribbon的诞生也正是因为要结合Eureka做负载均衡；而现在很多项目都是Nacos + OpenFeign的组合，不过OpenFeign的底层还是Ribbon，其很多便捷性体现在代理对象的封装，后续我们接着讨论。

### 1、Ribbon如何与eureka整合，通过eureka client获取到对应的注册表？ ###

在博文：[SpringCloud之Ribbon是这样实现负载均衡的（源码剖析@LoadBalanced原理）][SpringCloud_Ribbon_LoadBalanced]中我们知道了Ribbon默认的ILoadBalancer是`ZoneAwareLoadBalancer`；所以我们这里就看一下ZoneAwareLoadBalancer如何与eureka整合，通过eureka client获取到对应的注册表？

先看`ZoneAwareLoadBalancer`的类图：  
![在这里插入图片描述][2367826324fa4bf0867fcb68a1d5c69d.png]  
ZoneAwareLoadBalancer的父类是`DynamicServerListLoadBalancer`，DynamicServerListLoadBalancer构造函数中会调用`restOfInit()`方法（其中会获取到所有的服务实例）；

void restOfInit(IClientConfig clientConfig) {
        
        boolean primeConnection = this.isEnablePrimingConnections();
        // turn this off to avoid duplicated asynchronous priming done in BaseLoadBalancer.setServerList()
        this.setEnablePrimingConnections(false);
        // 感知新的服务实例的添加/移除，即动态维护服务实例列表
        enableAndInitLearnNewServersFeature();
    
        // 更新Eureka client 中所有服务的实例列表，即初始化服务实例列表
        updateListOfServers();
        if (primeConnection && this.getPrimeConnections() != null) {
        
            this.getPrimeConnections()
                .primeConnections(getReachableServers());
        }
        this.setEnablePrimingConnections(primeConnection);
        LOGGER.info("DynamicServerListLoadBalancer for client {} initialized: {}", clientConfig.getClientName(), this.toString());
    }

#### 1）为什么是DynamicServerListLoadBalancer的restOfInit()方法？ ####

**第一次获取Eureka中服务实例列表的执行流程如下：**  
![在这里插入图片描述][da554477c9d1402dba779f79c4e1e5ed.png]  
第一次从Ribbon的`SpringClientFactory`中获取`GREETING-SERVICE`服务对应的Spring子上下文时，获取不到，所以需要创建针对`GREETING-SERVICE`服务创建Spring子上下文；

最终进入到`NamedContextFactory#createContext(String name)`方法中，方法的最后会调用`AnnotationConfigApplicationContext#refresh()`方法，refresh()方法中会对`ZoneAwareLoadBalancer`进行初始化；又由于DynamicServerListLoadBalancer是ZoneAwareLoadBalancer的父类，所以初始化ZoneAwareLoadBalancer时也会执行DynamicServerListLoadBalancer的构造函数，进而会执行DynamicServerListLoadBalancer的`restOfInit()`方法；

![在这里插入图片描述][aaa798a519c4429f8e1bfd9b136e23ff.png]

#### 2）DynamicServerListLoadBalancer\#restOfInit() ####

![在这里插入图片描述][c8a3d1e74a6b45889c6035652f3acd27.png]

`restOfInit()`中主要做两件事：

> 1.  启动一个定时任务，定时更新服务实例列表。
> 2.  初始化服务实例列表`List<Server>`，并感知服务实例信息的变更；

**下面我们分开来看：**

##### 0> 初始化服务实例列表流程图 #####

![在这里插入图片描述][81ced5343e3346cdb152bace19db0548.png]

##### 1> 初始化服务实例列表 #####

`updateListOfServers()`方法负责初始化服务实例列表，代码执行流程如下：  
![在这里插入图片描述][7b554d9541254ec3b1bc32e2ce76eaed.png]  
最终进入到`DiscoveryEnabledNIWSServerList`的`obtainServersViaDiscovery()`方法从Eureka Client本地缓存的服务注册表中获取到服务的全部实例信息；

**我们debug过程中，知道了`updateListOfServers()`方法中涉及到的`ServerList<T> serverListImpl`是，那么`serverListImpl`是从哪来的？**  
![在这里插入图片描述][93cb7060e2904905893dfef3d6680ebf.png]  
PS：如果使用Nacos作为服务注册中心，这里的ServerList是NacosServerList。

##### ServerList从哪来的? #####

serverListImpl是和Eureka相关的，我们去找eureka相关的jar包，最终找到`spring-cloud-netflix-eureka-client` jar包，其中有个`org.springframework.cloud.netflix.ribbon.eureka`目录，目录中有个`EurekaRibbonClientConfiguration`类：

![在这里插入图片描述][e2d9eb2d1f31490694b1a494670d1bef.png]

其中负责实例化`ServerList<T>`为`DomainExtractingServerList`，然而我们调用`DomainExtractingServerList`的`getUpdatedListOfServers()`方法获取服务的所有实例时，实际是交给其组合的`DiscoveryEnabledNIWSServerList`类成员的`getUpdatedListOfServers()`方法去执行；

至此，我们知道了**ZoneAwareLoadBalancer（属于ribbon）如何与eureka整合，通过eureka client获取到对应注册表?**

*  其实就是从eureka client里去获取一下注册表，然后更新到LoadBalancer中去。

### 2、 动态更新服务实例列表 ###

#### 1）流程图 ####

![在这里插入图片描述][dc139aea6438475ca423c88f2b19cd31.png]

#### 2）流程解析 ####

`enableAndInitLearnNewServersFeature()`方法负责定时更新服务实例列表，代码执行逻辑如下：  
![在这里插入图片描述][f1a41679eaeb4a46a9c3e34d7ef8b0b8.png]  
`PollingServerListUpdater#start(UpdateAction)`方法中会**启动一个延迟1S并每间隔3S执行一次的定时任务去执行`DynamicServerListLoadBalancer#doUpdate()`方法去动态更新服务实例列表。**

再看`DynamicServerListLoadBalancer#doUpdate()`方法：  
![在这里插入图片描述][a47760631b324c77b802b2a215bd3f42.png]  
方法内部其实就是调用初始化服务实例类别的那个方法：`updateListOfServers()`，也就是我们上面聊的。

至此，我们也就知道了**ZoneAwareLoadBalancer如何持续从Eureka中获取最新的注册表信息?**

### 3、 如何根据负载均衡规则从`List<Server>`中选出一个Server？ ###

回到RibbonLoadBalancerClient\#execute()方法中：  
![在这里插入图片描述][7954c9f307d64623b1d473083c258100.png]  
进入到getServer()方法，看如何选择一个服务的？  
![在这里插入图片描述][714c305385f244f290b6f5dc8d37d5b7.png]

**核心逻辑如下：**

> 1.  会进入到BaseLoadBalancer的`chooseServer()`方法中，用IRule来选择了一台服务器；
> 2.  IRule是RibbonClientConfiguraiton中实例化的`ZoneAvoidanceRule`，调用它的choose()方法来选择一个server，最终是用的`ZoneAvoidanceRule`的父类`PredicateBasedRule`\#choose()方法：
>     
>     > 先执行过滤规则，过滤掉一批server，再根据我们自己指定的filter规则，然后用round robin轮询算法选择一个Server。

**下面看看负载均衡的轮询算法是怎么做的？**

#### 1）轮询算法 ####

![在这里插入图片描述][8024bbfff25f489388e80af414d1c0c1.png]  
![在这里插入图片描述][573ac58d638a402ab1a8bf7b6047e2e9.png]

轮询算法很简单，重点在于通过AtomicInteger原子类型变量 + 死循环 CAS操作实现，每次返回原子类型变量nextIndex的当前值，因为原子类型变量nextIndex可能超过服务实例数，所以每次对原子类型变量nextIndex赋值时，都会对其做取余运算。

### 4、如何发送网络HTTP请求？ ###

#### 1）流程图 ####

![在这里插入图片描述][d55ae86268bc4e1d9b478528cee3cc53.png]

#### 2）流程解析 ####

getServer()方法选择出一个服务实例之后，进入到execute()重载方法去执行HTTP请求：  
![在这里插入图片描述][8a6b86e9614b4fc2a297496e275f4966.png]  
代码整体执行流程如下：  
![在这里插入图片描述][67bd66d5823b4bd5ad2002acc8f752bd.png]

**流程说明：**

> 1.  在`LoadBalancerInterceptor#intercept()`方法中通过`LoadBalancerRequestFactory`工厂封装了HTTP请求为LoadBalancerRequest；  
>     ![在这里插入图片描述][96a28eda49ef4c17acb505c9653c829a.png]
> 2.  在RibbonLoadBalancerClient的execute()方法中，调用了`T returnVal = request.apply(serviceInstance);`，进入到LoadBalancerRequest的apply()方法中，传入了选择出来的server，对这台server发起一个指定的一个请求。
>     
>     > 1.  将LoadBalancerRequest和server再次封装为了一个ServiceRequestWrapper；
>     > 2.  然后通过`ServiceRequestWrapper#getURI()`方法，基于选择出来的server的地址，重构请求URI；即：将服务名替换为具体的IP:Port地址。
>     > 3.  最后将将真正的请求URL交给spring-web下的负责底层的http请求的组件`ClientHttpRequestExecution`去执行，发起了一次真正的HTTP请求。

### 5、ping机制如何检查服务实例是否还存活？ ###

在`RibbonClientConfiguration`类中会注入IPing类型的实例`DummyPing`，其中isAlive()方法直接返回TRUE；

public class DummyPing extends AbstractLoadBalancerPing {
        
    
        public DummyPing() {
        
        }
    
        public boolean isAlive(Server server) {
        
            return true;
        }
    }

这里是Ribbon默认的IPing，但是Eureka和Ribbon整合之后，`EurekaRibbonClientConfiguration`（spring-cloud-netflix-eureka-client包下）类中新定义了一个IPing。

@Bean
    @ConditionalOnMissingBean
    public IPing ribbonPing(IClientConfig config) {
        
        if (this.propertiesFactory.isSet(IPing.class, serviceId)) {
        
            return this.propertiesFactory.get(IPing.class, config, serviceId);
        }
        NIWSDiscoveryPing ping = new NIWSDiscoveryPing();
        ping.initWithNiwsConfig(config);
        return ping;
    }

IPing的实例为NIWSDiscoveryPing；`NIWSDiscoveryPing`的isAlive()方法会检查某个server对应的eureka client中的InstanceInfo的状态，看看服务实例的status是否还正常；

public boolean isAlive(Server server) {
        
        boolean isAlive = true;
        if (server!=null && server instanceof DiscoveryEnabledServer){
        
            DiscoveryEnabledServer dServer = (DiscoveryEnabledServer)server;
            // 获取服务实例信息	            
            InstanceInfo instanceInfo = dServer.getInstanceInfo();
            if (instanceInfo!=null){
        	
               // 获取实例状态                
                InstanceStatus status = instanceInfo.getStatus();
                if (status!=null){
        
                    // 服务实例状态是否为UP
                    isAlive = status.equals(InstanceStatus.UP);
                }
            }
        }
        return isAlive;
    }

#### 1）哪里使用到了IPing的isAlive()方法？ ####

在ZoneAwareLoadBalancer实例构造时（进入到父类BaseLoadBalancer中），会启动一个定时调度的任务，每隔10s，就用IPing组件对server list中的每个server都执行一下isAlive()方法，判断服务实例是否还存活。

public BaseLoadBalancer() {
        
        this.name = DEFAULT_NAME;
        this.ping = null;
        setRule(DEFAULT_RULE);
        // 启动一个每10s执行一次的定时任务，最IPing#isAlive()操作
        setupPingTask();
        lbStats = new LoadBalancerStats(DEFAULT_NAME);
    }
    
    void setupPingTask() {
        
        if (canSkipPing()) {
        
            return;
        }
        if (lbTimer != null) {
        
            lbTimer.cancel();
        }
        lbTimer = new ShutdownEnabledTimer("NFLoadBalancer-PingTimer-" + name,
                                           true);
        // 执行BaseLoadBalancer的内部类PingTask#run()，默认每10s执行一次
        lbTimer.schedule(new PingTask(), 0, pingIntervalSeconds * 1000);
        // 快速进行一次IPing
        forceQuickPing();
    }
    
    class PingTask extends TimerTask {
        
        public void run() {
        
            try {
        
                new Pinger(pingStrategy).runPinger();
            } catch (Exception e) {
        
                logger.error("LoadBalancer [{}]: Error pinging", name, e);
            }
        }
    }

进入到PingTask\#run()方法之后，下面看一下`Pinger(pingStrategy).runPinger()`的执行流程：  
![在这里插入图片描述][f506694c92b24032aaf5f363ad6f7c58.png]  
注意看`canSkipPing()`方法：

private boolean canSkipPing() {
        
        if (ping == null
                || ping.getClass().getName().equals(DummyPing.class.getName())) {
        
            // default ping, no need to set up timer
            return true;
        } else {
        
            return false;
        }
    }

**默认IPing的实现是`DummyPing`，在启动做Ping的Timer会通过`BaseLoadBalancer#canSkipPing()`方法判断是否要跳过Timer的启动，当ping为空或者为`DummyPing`是跳过，所以默认不会启动`Timer`去每10s做一次IPing操作；然而Eureka和Ribbon整合之后，EurekaRibbonClientConfiguration（spring-cloud-netflix-eureka-client包下）类中新定义了一个IPing（`NIWSDiscoveryPing`），此时会启动Timer每10s做一次ping操作。**

## 三、总结 以及 后续文章 ##

到这里针对Ribbon的整个执行流程我们也就讨论完了，大体执行流程图下：  
![在这里插入图片描述][59027128cd48406182b5a5f48b834b8b.png]

后文章，我们将讨论Ribbon内置的那些负载均衡算法是如何实现的？

[SpringCloud_Ribbon_Eureka_Ribbon]: https://blog.csdn.net/Saintmm/article/details/125082742
[SpringCloud_Ribbon_Ribbon_API]: https://blog.csdn.net/Saintmm/article/details/125152666
[SpringCloud_Ribbon_LoadBalanced]: https://blog.csdn.net/Saintmm/article/details/125264867
[Spring Boot]: https://blog.csdn.net/saintmm/category_11339528.html
[2367826324fa4bf0867fcb68a1d5c69d.png]: https://img-blog.csdnimg.cn/2367826324fa4bf0867fcb68a1d5c69d.png
[da554477c9d1402dba779f79c4e1e5ed.png]: https://img-blog.csdnimg.cn/da554477c9d1402dba779f79c4e1e5ed.png
[aaa798a519c4429f8e1bfd9b136e23ff.png]: https://img-blog.csdnimg.cn/aaa798a519c4429f8e1bfd9b136e23ff.png
[c8a3d1e74a6b45889c6035652f3acd27.png]: https://img-blog.csdnimg.cn/c8a3d1e74a6b45889c6035652f3acd27.png
[81ced5343e3346cdb152bace19db0548.png]: https://img-blog.csdnimg.cn/81ced5343e3346cdb152bace19db0548.png
[7b554d9541254ec3b1bc32e2ce76eaed.png]: https://img-blog.csdnimg.cn/7b554d9541254ec3b1bc32e2ce76eaed.png
[93cb7060e2904905893dfef3d6680ebf.png]: https://img-blog.csdnimg.cn/93cb7060e2904905893dfef3d6680ebf.png
[e2d9eb2d1f31490694b1a494670d1bef.png]: https://img-blog.csdnimg.cn/e2d9eb2d1f31490694b1a494670d1bef.png
[dc139aea6438475ca423c88f2b19cd31.png]: https://img-blog.csdnimg.cn/dc139aea6438475ca423c88f2b19cd31.png
[f1a41679eaeb4a46a9c3e34d7ef8b0b8.png]: https://img-blog.csdnimg.cn/f1a41679eaeb4a46a9c3e34d7ef8b0b8.png
[a47760631b324c77b802b2a215bd3f42.png]: https://img-blog.csdnimg.cn/a47760631b324c77b802b2a215bd3f42.png
[7954c9f307d64623b1d473083c258100.png]: https://img-blog.csdnimg.cn/7954c9f307d64623b1d473083c258100.png
[714c305385f244f290b6f5dc8d37d5b7.png]: https://img-blog.csdnimg.cn/714c305385f244f290b6f5dc8d37d5b7.png
[8024bbfff25f489388e80af414d1c0c1.png]: https://img-blog.csdnimg.cn/8024bbfff25f489388e80af414d1c0c1.png
[573ac58d638a402ab1a8bf7b6047e2e9.png]: https://img-blog.csdnimg.cn/573ac58d638a402ab1a8bf7b6047e2e9.png
[d55ae86268bc4e1d9b478528cee3cc53.png]: https://img-blog.csdnimg.cn/d55ae86268bc4e1d9b478528cee3cc53.png
[8a6b86e9614b4fc2a297496e275f4966.png]: https://img-blog.csdnimg.cn/8a6b86e9614b4fc2a297496e275f4966.png
[67bd66d5823b4bd5ad2002acc8f752bd.png]: https://img-blog.csdnimg.cn/67bd66d5823b4bd5ad2002acc8f752bd.png
[96a28eda49ef4c17acb505c9653c829a.png]: https://img-blog.csdnimg.cn/96a28eda49ef4c17acb505c9653c829a.png
[f506694c92b24032aaf5f363ad6f7c58.png]: https://img-blog.csdnimg.cn/f506694c92b24032aaf5f363ad6f7c58.png
[59027128cd48406182b5a5f48b834b8b.png]: https://img-blog.csdnimg.cn/59027128cd48406182b5a5f48b834b8b.png