还没有秃头吗？你真的需要大牛来教你如何深入解析Ribbon源码了

愿天堂没有BUG

发布于 2022-10-28 15:14:44

3880

发布于 2022-10-28 15:14:44

文章被收录于专栏：愿天堂没有BUG（公众号同名）

本章给大家讲解的内容是Ribbon源码解析。

Ribbon源码解析

Ribbon 的源码解析我们从 @LoadBalanced 开始讲起，添加@LoadBalanced注解后AsyncRestTemplate就具备了负载均衡的能力，代码如下：

在初始化HTTP客户端时会加载Ribbon的拦截代码，同时根据配置文件中设置的负载均衡策略或者代码实现定制好的负载均衡策略，实现HTTP请求过程中的后端服务分发。所以源码解读可以分为两个部分。

● 初始化构造过程：获取@LoadBalanced注解标记RestTemplate或者AsyncRestTemplate，然后添加拦截器。

● 负载均衡服务选择过程：在Ribbon设定的负载均衡策略下，从服务集群中根据预定的负载均衡策略实现后端服务的选取及请求转发。

如下图所示是一个简要的Ribbon初始化及调用拦截HTTP请求实现负载均衡的流程。

Ribbon的初始化过程

@LoadBalanced注解对RestTemplate做了标记，使用Ribbon的自动化配置加载类实现对负载均衡客户端的加载，在生成的RestTemplate的Bean上添加注解后，它会配置LoadBalancerClient。首先我们看一下LoadBalancerClient的源码实现：

说明：LoadBalancerClient是一个接口，里面有三个方法。

● ServiceInstance choose（String serviceId）方法，根据传入的serviceId（服务名），从负载均衡器中选择一个服务实例，服务实例通过ServiceInstance类来表示。 ● execute方法，使用从负载均衡器中选择的服务实例来执行请求内容。 ● URI reconstructURI （ ServiceInstance instance ， URIoriginal ）方法：用来重新构建 URI 。我们通过RestTemplate 请求后端服务时会使用 serviceId （服务名），这个方法会把请求的URI进行转换，返回host+port，再通过host+port的形式去请求服务。

从META-INF/spring.factories文件来看Ribbon的自动化加载机制，主要是Spring Common的LoadBalancerClient的初始化和加载过程：

Ribbon的自动配置实现

下面是Ribbon的自动化配置实现：

● 说明 1 ＃：Ribbon 将所有标记 @LoadBalanced 注解的RestTemplate保存到一个List集合中。

● 说明 2 ＃：Ribbon 借助了 Spring IoC 容器的 SmartInitializingSingleton机制。实现该接口后，当所有单例 Bean 都被初始化完成后，容器会调用afterSingletonsInstantiated实现RestTemplateCustomizer的customize定制化方法。

● 说明 3 ＃：获取 RestTemplate 的 interceptors ，在构造LoadBalancerInterceptor时需要传入LoadBalanceClient实例参数，LoadBalanceClient是一个接口，具体实现类将实现choose（服务实例选择）和execute（请求转发执行）方法，这一步完成Ribbon负载均衡策略Bean的构造。

● 说明4：将说明3＃中构造的loadBalancerInterceptor Bean实例注入RestTemplate的定制化Bean中，这一步骤也会在说明2＃的 afterSingletonsInstantiated 方法中被调用，完成RestTemplate的定制化及与LoadBalancerInterceptor实例关联。

Ribbon的重试策略

对于Ribbon的重试策略，可以参考RetryTemplate类的实现，它可以实现Ribbon的重试策略对RestTemplate的拦截控制，代码如下：

Ribbon的负载均衡行为逻辑

Ribbon主要在Spring Cloud Netflix中完成负载均衡行为的初始化过程，这部分初始化主要依赖spring-cloud-netflix-core模块。

下面我们看一下Ribbon在Spring Cloud中是如何实现初始化的，首先看Ribbon的自动加载机制META-INF/spring.factories：

下面是RibbonAutoConfiguration的实现，从源码中可以看到它会构造 SpringClientFactory ， LoadBalancerClient 初始化构造需要SpringClientFactory作为参数。

在Ribbon的自动化配置类中会通过RibbonClientConfiguration配置类获取YAML配置中的负载均衡配置，构造SpringClientFactory并生成LoadBalancer，代码如下：

可以看到，在RestTemplate执行HTTP请求时是如何通过Ribbon设置的拦截机制构造 HTTP 客户端请求的。RestTemplate 继承了InterceptingHttpAccessor，而父类InterceptingHttpAccessor提供了获取及添加拦截器的方法，代码如下：

InterceptingHttpAccessor抽象类的作用正是为我们添加自定义的拦截器：

这段代码的实际拦截器的实例注入（依赖注入）过程其实来自上面的Ribbon自动化配置类 LoadBalancerAutoConfiguration，在配置类中它已经完成了拦截器的注册。

下面我们看一下当拦截HTTP请求后，RestTemplate将会执行哪些操作。首先，RestTemplate执行HTTP请求，从RestTemplate的实现源码中，不难发现请求最终都会执行到 doExecute 方法中。查看doExecute 的调用链路，我们发现它都会执行到LoadBalancerInterceptor的intercept拦截方法中，代码如下：

我们跟进到Ribbon的执行拦截逻辑， LoadBalancerClient.execute方法的具体代码如下：

从上述代码可知， Ribbon 首先根据服务的 serviceId 调用getLoadBalancer方法得到ILoadBalancer。创建loadBalancer的过程可以理解为组装选取服务的规则、服务集群的列表、检验服务是否存活等特性的过程（加载RibbonClientConfiguration配置类）。这里的核心是 getServer 方法，根据 ILoadBalancer 来选取一个具体的Server，选取的过程会按照服务的负载均衡策略、服务列表、服务存活情况进行筛选判断，对我们自定义的负载均衡策略将执行chooseServer操作，最终根据这些约束选择一个后端的服务实例。