浅谈Spring Cloud Ribbon的原理

墨蓝 2023-01-23 09:53 129阅读 0赞

#  #

这篇文章主要介绍了浅谈Spring Cloud Ribbon的原理，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

Ribbon是Netflix发布的开源项目，主要功能是提供客户端的软件负载均衡算法，将Netflix的中间层服务连接在一起。Ribbon客户端组件提供一系列完善的配置项如连接超时，重试等。简单的说，就是在配置文件中列出Load Balancer（简称LB）后面所有的机器，Ribbon会自动的帮助你基于某种规则（如简单轮询，随即连接等）去连接这些机器。我们也很容易使用Ribbon实现自定义的负载均衡算法。

说起负载均衡一般都会想到服务端的负载均衡，常用产品包括LBS硬件或云服务、Nginx等，都是耳熟能详的产品。

而Spring Cloud提供了让服务调用端具备负载均衡能力的Ribbon，通过和Eureka的紧密结合，不用在服务集群内再架设负载均衡服务，很大程度简化了服务集群内的架构。

具体也不想多写虚的介绍，反正哪里都能看得到相关的介绍。

直接开撸代码，通过代码来看Ribbon是如何实现的。

配置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29yaWNoaXNvbmlj_size_16_color_FFFFFF_t_70][]

详解：

1.RibbonAutoConfiguration配置生成RibbonLoadBalancerClient实例。

代码位置：

spring-cloud-netflix-core-1.3.5.RELEASE.jar

[org.springframework.cloud.netflix.ribbon][]

RibbonAutoConfiguration.class

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> @Configuration @ConditionalOnClass({ IClient.class, RestTemplate.class, AsyncRestTemplate.class, Ribbon.class}) @RibbonClients @AutoConfigureAfter(name = "<a href="http://org.springframework.cloud.netflix.eureka.eurekaclientautoconfiguration/" rel="nofollow">org.springframework.cloud.netflix.eureka.EurekaClientAutoConfiguration</a>") @AutoConfigureBefore({LoadBalancerAutoConfiguration.class, AsyncLoadBalancerAutoConfiguration.class}) @EnableConfigurationProperties(RibbonEagerLoadProperties.class) public class RibbonAutoConfiguration { &nbsp;// 略 &nbsp;@Bean &nbsp;@ConditionalOnMissingBean(LoadBalancerClient.class) &nbsp;public LoadBalancerClient loadBalancerClient() { &nbsp;&nbsp;return new RibbonLoadBalancerClient(springClientFactory()); &nbsp;} &nbsp;&nbsp;// 略 } </td> 
 </tr> 
 </tbody> 
</table>

先看配置条件项，RibbonAutoConfiguration配置必须在LoadBalancerAutoConfiguration配置前执行，因为在LoadBalancerAutoConfiguration配置中会使用RibbonLoadBalancerClient实例。

RibbonLoadBalancerClient继承自LoadBalancerClient接口，是负载均衡客户端，也是负载均衡策略的调用方。

2.LoadBalancerInterceptorConfig配置生成：

1).负载均衡拦截器LoadBalancerInterceptor实例

包含：

LoadBalancerClient实现类的RibbonLoadBalancerClient实例

负载均衡的请求创建工厂LoadBalancerRequestFactory:实例

2).RestTemplate自定义的RestTemplateCustomizer实例

代码位置：

spring-cloud-commons-1.2.4.RELEASE.jar

org.springframework.cloud.client.loadbalancer

LoadBalancerAutoConfiguration.class

先看配置条件项：

要求在项目环境中必须要有RestTemplate类。

要求必须要有LoadBalancerClient接口的实现类的实例，也就是上一步生成的RibbonLoadBalancerClient。

3.通过上面一步创建的RestTemplateCustomizer配置所有RestTemplate实例，就是将负载均衡拦截器设置给RestTemplate实例。

restTemplate.setInterceptors(list)这个地方就是注入负载均衡拦截器的地方LoadBalancerInterceptor。

从这个地方实际上也可以猜出来，RestTemplate可以通过注入的拦截器来构建相应的请求实现负载均衡。

也能看出来可以自定义拦截器实现其他目的。

4.RibbonClientConfiguration配置生成ZoneAwareLoadBalancer实例

代码位置：

spring-cloud-netflix-core-1.3.5.RELEASE.jar

[org.springframework.cloud.netflix.ribbon][]

RibbonClientConfiguration.class

ZoneAwareLoadBalancer继承自ILoadBalancer接口，该接口有一个方法：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> /** &nbsp;* Choose a server from load balancer. &nbsp;* &nbsp;* @param key An object that the load balancer may use to determine which server to return. null if &nbsp;*&nbsp;&nbsp; the load balancer does not use this parameter. &nbsp;* @return server chosen &nbsp;*/ public Server chooseServer(Object key); </td> 
 </tr> 
 </tbody> 
</table>

ZoneAwareLoadBalancer就是一个具体的负载均衡实现类，也是默认的负载均衡类，通过对chooseServer方法的实现选取某个服务实例。

拦截&请求

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29yaWNoaXNvbmlj_size_16_color_FFFFFF_t_70 1][]

1.使用RestTemplate进行Get、Post等各种请求，都是通过doExecute方法实现

代码位置：

spring-web-4.3.12.RELEASE.jar

![20210714100800701.png][]

org.springframework.web.client

RestTemplate.class

支持的各种http请求方法最终都是调用doExecute方法，该方法内调用创建方法创建请求实例，并执行请求得到响应对象。

2.生成请求实例创建工厂

上一步代码中，调用createRequest方法创建请求实例，这个方法是定义在父类中。

先整理出主要的继承关系：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29yaWNoaXNvbmlj_size_16_color_FFFFFF_t_70 2][]

createRequest方法实际是定义在HttpAccessor抽象类中。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> public abstract class HttpAccessor { &nbsp;private ClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory(); &nbsp;public void setRequestFactory(ClientHttpRequestFactory requestFactory) { &nbsp;&nbsp;Assert.notNull(requestFactory, "ClientHttpRequestFactory must not be null"); &nbsp;&nbsp;this.requestFactory = requestFactory; &nbsp;} &nbsp;public ClientHttpRequestFactory getRequestFactory() { &nbsp;&nbsp;return this.requestFactory; &nbsp;} &nbsp;protected ClientHttpRequest createRequest(URI url, HttpMethod method) throws IOException { &nbsp;&nbsp;ClientHttpRequest request = getRequestFactory().createRequest(url, method); &nbsp;&nbsp;if (logger.isDebugEnabled()) { &nbsp;&nbsp;&nbsp;logger.debug("Created " + method.name() + " request for \"" + url + "\""); &nbsp;&nbsp;} &nbsp;&nbsp;return request; &nbsp;} } </td> 
 </tr> 
 </tbody> 
</table>

在createRequest方法中调用getRequestFactory方法获得请求实例创建工厂，实际上getRequestFactory并不是当前HttpAccessor类中定义的，而是在子类InterceptingHttpAccessor中定义的。

在这里做了个小动作，首先还是通过HttpAccessor类创建并获得SimpleClientHttpRequestFactory工厂，这个工厂主要就是在没有拦截器的时候创建基本请求实例。

其次，在有拦截器注入的情况下，创建InterceptingClientHttpRequestFactory工厂，该工厂就是创建带拦截器的请求实例，因为注入了负载均衡拦截器，所以这里就从InterceptingClientHttpRequestFactory工厂创建。

3.通过工厂创建请求实例

创建实例就看工厂的createRequest方法。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 </td> 
 <td> public class InterceptingClientHttpRequestFactory extends AbstractClientHttpRequestFactoryWrapper { &nbsp;private final List&lt;ClientHttpRequestInterceptor&gt; interceptors; &nbsp;public InterceptingClientHttpRequestFactory(ClientHttpRequestFactory requestFactory, &nbsp;&nbsp;&nbsp;List&lt;ClientHttpRequestInterceptor&gt; interceptors) { &nbsp;&nbsp;super(requestFactory); &nbsp;&nbsp;this.interceptors = (interceptors != null ? interceptors : Collections.&lt;ClientHttpRequestInterceptor&gt;emptyList()); &nbsp;} &nbsp;@Override &nbsp;protected ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod, ClientHttpRequestFactory requestFactory) { &nbsp;&nbsp;return new InterceptingClientHttpRequest(requestFactory, this.interceptors, uri, httpMethod); &nbsp;} } </td> 
 </tr> 
 </tbody> 
</table>

就是new了个InterceptingClientHttpRequest实例，并且把拦截器、基本请求实例创建工厂注进去。

4.请求实例调用配置阶段注入的负载均衡拦截器的拦截方法intercept

可从第1步看出，创建完请求实例后，通过执行请求实例的execute方法执行请求。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> ClientHttpRequest request = createRequest(url, method); if (requestCallback != null) { &nbsp;requestCallback.doWithRequest(request); } response = request.execute(); </td> 
 </tr> 
 </tbody> 
</table>

实际请求实例是InterceptingClientHttpRequest，execute实际是在它的父类中。

类定义位置：

spring-web-4.3.12.RELEASE.jar

org.springframework.http.client

InterceptingClientHttpRequest.class

看一下它们的继承关系。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29yaWNoaXNvbmlj_size_16_color_FFFFFF_t_70 3][]

在execute方法中实际调用了子类实现的executeInternal方法。

其实就是InterceptingClientHttpRequest类的executeInternal方法，其中，又调用了一个执行器InterceptingRequestExecution的execute，通关判断如果有拦截器注入进来过，就调用拦截器的intercept方法。

这里的拦截器实际上就是在配置阶段注入进RestTemplate实例的负载均衡拦截器LoadBalancerInterceptor实例，可参考上面配置阶段的第2步。

5.负载均衡拦截器调用负载均衡客户端

在负载均衡拦截器LoadBalancerInterceptor类的intercept方法中，又调用了负载均衡客户端LoadBalancerClient实现类的execute方法。

在配置阶段的第1步，可以看到实现类是RibbonLoadBalancerClient。

6.负载均衡客户端调用负载均衡策略选取目标服务实例并发起请求

在RibbonLoadBalancerClient的第一个execute方法以及getServer方法中可以看到，实际上是通过ILoadBalancer的负载均衡器实现类作的chooseServer方法选取一个服务，交给接下来的请求对象发起一个请求。

这里的负载均衡实现类默认是ZoneAwareLoadBalancer区域感知负载均衡器实例，其内部通过均衡策略选择一个服务。

ZoneAwareLoadBalancer的创建可以参考配置阶段的第4步。

<table> 
 <tbody> 
 <tr> 
 <td> 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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 </td> 
 <td> public class RibbonLoadBalancerClient implements LoadBalancerClient { &nbsp;@Override &nbsp;public &lt;T&gt; T execute(String serviceId, LoadBalancerRequest&lt;T&gt; request) throws IOException { &nbsp;&nbsp;ILoadBalancer loadBalancer = getLoadBalancer(serviceId); &nbsp;&nbsp;Server server = getServer(loadBalancer); &nbsp;&nbsp;if (server == null) { &nbsp;&nbsp;&nbsp;throw new IllegalStateException("No instances available for " + serviceId); &nbsp;&nbsp;} &nbsp;&nbsp;RibbonServer ribbonServer = new RibbonServer(serviceId, server, isSecure(server, &nbsp;&nbsp;&nbsp;&nbsp;serviceId), serverIntrospector(serviceId).getMetadata(server)); &nbsp;&nbsp;return execute(serviceId, ribbonServer, request); &nbsp;} &nbsp;@Override &nbsp;public &lt;T&gt; T execute(String serviceId, ServiceInstance serviceInstance, LoadBalancerRequest&lt;T&gt; request) throws IOException { &nbsp;&nbsp;Server server = null; &nbsp;&nbsp;if(serviceInstance instanceof RibbonServer) { &nbsp;&nbsp;&nbsp;server = ((RibbonServer)serviceInstance).getServer(); &nbsp;&nbsp;} &nbsp;&nbsp;if (server == null) { &nbsp;&nbsp;&nbsp;throw new IllegalStateException("No instances available for " + serviceId); &nbsp;&nbsp;} &nbsp;&nbsp;RibbonLoadBalancerContext context = this.clientFactory &nbsp;&nbsp;&nbsp;&nbsp;.getLoadBalancerContext(serviceId); &nbsp;&nbsp;RibbonStatsRecorder statsRecorder = new RibbonStatsRecorder(context, server); &nbsp;&nbsp;try { &nbsp;&nbsp;&nbsp;T returnVal = request.apply(serviceInstance); &nbsp;&nbsp;&nbsp;statsRecorder.recordStats(returnVal); &nbsp;&nbsp;&nbsp;return returnVal; &nbsp;&nbsp;} &nbsp;&nbsp;// catch IOException and rethrow so RestTemplate behaves correctly &nbsp;&nbsp;catch (IOException ex) { &nbsp;&nbsp;&nbsp;statsRecorder.recordStats(ex); &nbsp;&nbsp;&nbsp;throw ex; &nbsp;&nbsp;} &nbsp;&nbsp;catch (Exception ex) { &nbsp;&nbsp;&nbsp;statsRecorder.recordStats(ex); &nbsp;&nbsp;&nbsp;ReflectionUtils.rethrowRuntimeException(ex); &nbsp;&nbsp;} &nbsp;&nbsp;return null; &nbsp;} &nbsp;&nbsp;&nbsp; &nbsp;// 略 &nbsp;protected Server getServer(ILoadBalancer loadBalancer) { &nbsp;&nbsp;if (loadBalancer == null) { &nbsp;&nbsp;&nbsp;return null; &nbsp;&nbsp;} &nbsp;&nbsp;return loadBalancer.chooseServer("default"); // TODO: better handling of key &nbsp;} &nbsp;protected ILoadBalancer getLoadBalancer(String serviceId) { &nbsp;&nbsp;return this.clientFactory.getLoadBalancer(serviceId); &nbsp;} &nbsp;public static class RibbonServer implements ServiceInstance { &nbsp;&nbsp;private final String serviceId; &nbsp;&nbsp;private final Server server; &nbsp;&nbsp;private final boolean secure; &nbsp;&nbsp;private Map&lt;String, String&gt; metadata; &nbsp;&nbsp;public RibbonServer(String serviceId, Server server) { &nbsp;&nbsp;&nbsp;this(serviceId, server, false, Collections.&lt;String, String&gt; emptyMap()); &nbsp;&nbsp;} &nbsp;&nbsp;public RibbonServer(String serviceId, Server server, boolean secure, &nbsp;&nbsp;&nbsp;&nbsp;Map&lt;String, String&gt; metadata) { &nbsp;&nbsp;&nbsp;this.serviceId = serviceId; &nbsp;&nbsp;&nbsp;this.server = server; &nbsp;&nbsp;&nbsp;this.secure = secure; &nbsp;&nbsp;&nbsp;this.metadata = metadata; &nbsp;&nbsp;} &nbsp;&nbsp;// 略 &nbsp;} } </td> 
 </tr> 
 </tbody> 
</table>

代码撸完，总结下。

普通使用RestTemplate请求其他服务时，内部使用的就是常规的http请求实例发送请求。

为RestTemplate增加了@LoanBalanced 注解后，实际上通过配置，为RestTemplate注入负载均衡拦截器，让负载均衡器选择根据其对应的策略选择合适的服务后，再发送请求。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

*  [Spring Cloud Ribbon的踩坑记录与原理详析][Spring Cloud Ribbon]
 *  [Spring Cloud EureKa Ribbon 服务注册发现与调用][Spring Cloud EureKa Ribbon]
 *  [spring cloud 之 客户端负载均衡Ribbon深入理解][spring cloud _ _Ribbon]
 *  [解决Spring Cloud中Feign/Ribbon第一次请求失败的方法][Spring Cloud_Feign_Ribbon]
 *  [深入学习Spring Cloud-Ribbon][Spring Cloud-Ribbon]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29yaWNoaXNvbmlj_size_16_color_FFFFFF_t_70]: /images/20221004/57d63e92daf746ee8e4f51368c4daa20.png
[org.springframework.cloud.netflix.ribbon]: http://org.springframework.cloud.netflix.ribbon/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29yaWNoaXNvbmlj_size_16_color_FFFFFF_t_70 1]: /images/20221004/cef1208421324b36afbbc62acad32e58.png
[20210714100800701.png]: /images/20221004/a10dd72b2c4e40d2bb1f2f58fdd95ee5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29yaWNoaXNvbmlj_size_16_color_FFFFFF_t_70 2]: /images/20221004/2cca242fb7ac4e84874276ebd41f97c4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L29yaWNoaXNvbmlj_size_16_color_FFFFFF_t_70 3]: /images/20221004/5ed967bef48244afa1794629fced2175.png
[Spring Cloud Ribbon]: https://www.jb51.net/article/149226.htm
[Spring Cloud EureKa Ribbon]: https://www.jb51.net/article/135465.htm
[spring cloud _ _Ribbon]: https://www.jb51.net/article/115969.htm
[Spring Cloud_Feign_Ribbon]: https://www.jb51.net/article/106944.htm
[Spring Cloud-Ribbon]: https://www.jb51.net/article/206724.htm