Spring Cloud教程第三弹 Ribbon工作原理

╰半夏微凉° 2022-12-19 13:13 185阅读 0赞

本文只介绍Ribbon的工作原理，关于Ribbon的其它教程请看这篇文章 [Spring Cloud教程 第二弹 客户端负载均衡Ribbon][Spring Cloud_ _ _Ribbon] 因为Ribbon的工作原理我写的有点细，篇幅稍大，所以单独抽出来了，没有将本文糅合在第二弹里。

更多Spring与微服务相关的教程请戳这里 [Spring与微服务教程合集][Spring]

# 1、揭开RestTemplate的神秘面纱 #

我们实际上关心的是，为什么@LoadBalanced注解能赋予RestTemplate负载均衡的能力？

关于Ribbon的核心工作原理，请小伙伴们一定要一步一步耐心往下看。

首先，Ribbon组件在启动时，会自动加载RibbonAutoConfiguration这个配置类，如下图所示

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70][]

可以看到，RibbonAutoConfiguration加载于EurekaClientAutoConfiguration之前，加载于LoadBalancerAutoConfiguration之后

EurekaClientAutoConfiguration不必多说，引入Eureka Client必然会加载这个类

而RibbonAutoConfiguration中声明了这样的一个Bean,如下图所示

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 1][]

RibbonLoadBalancerClient主要为加载LoadBalancerAutoConfiguration服务，没有RibbonLoadBalancerClient这个Bean，后者无法加载，具体细节看下图。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 2][]

下面主要就来看看LoadBalancerAutoConfiguration这个类做了什么事情

首先，LoadBalancerAutoConfiguration有这样一块代码：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 3][]

这块代码表示的含义是：将所有用@LoadBalanced注解标识的RestTemplate类型的Bean注入到List集合中，而恰好我们的确也声明了这样的一个Bean,如下图所示：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 4][]  
   
这不就是我们很熟悉的那块代码嘛

@LoadBalanced注解与@Qualifier注解有关，关于@LoadBalanced注解的原理请看这篇文章 [Ribbon中@LoadBalanced注解的原理][Ribbon_LoadBalanced]

另外，LoadBalancerAutoConfiguration类中还有另外几块重要的代码，为了保持整洁，不重要的我就没有粘贴出来了，如下所示。

public class LoadBalancerAutoConfiguration {
        @Bean
    	public SmartInitializingSingleton loadBalancedRestTemplateInitializerDeprecated(
    			final ObjectProvider<List<RestTemplateCustomizer>> restTemplateCustomizers) {
    		return () -> restTemplateCustomizers.ifAvailable(customizers -> {
                for (RestTemplate restTemplate : LoadBalancerAutoConfiguration.this.restTemplates) {
                    for (RestTemplateCustomizer customizer : customizers) {
                        customizer.customize(restTemplate);
                    }
                }
            });
    	}
    
    
    	@Bean
    	@ConditionalOnMissingBean
    	public LoadBalancerRequestFactory loadBalancerRequestFactory(
    			LoadBalancerClient loadBalancerClient) {
    		return new LoadBalancerRequestFactory(loadBalancerClient, this.transformers);
    	}
    
    	@Configuration(proxyBeanMethods = false)
    	@ConditionalOnMissingClass("org.springframework.retry.support.RetryTemplate")
    	static class LoadBalancerInterceptorConfig {
    
    		@Bean
    		public LoadBalancerInterceptor ribbonInterceptor(
    				LoadBalancerClient loadBalancerClient,
    				LoadBalancerRequestFactory requestFactory) {
    			return new LoadBalancerInterceptor(loadBalancerClient, requestFactory);
    		}
    
    		@Bean
    		@ConditionalOnMissingBean
    		public RestTemplateCustomizer restTemplateCustomizer(
    				final LoadBalancerInterceptor loadBalancerInterceptor) {
    			return restTemplate -> {
    				List<ClientHttpRequestInterceptor> list = new ArrayList<>(
    						restTemplate.getInterceptors());
    				list.add(loadBalancerInterceptor);
    				restTemplate.setInterceptors(list);
    			};
    		}
    
    	}
    
    }

1、loadBalancerRequestFactory方法用于声明一个负载均衡请求生成工厂

2、LoadBalancerInterceptorConfig 这个内部静态类声明了两个Bean:

**     **     2.1、ribbonInterceptor**：**该方法声明了一个负载均衡拦截器的Bean，该方法有两个参数loadBalancerClient、LoadBalancerRequestFactory requestFactory，这两个参数都已经有了。而LoadBalancerInterceptor继承自ClientHttpRequestInterceptor，表明LoadBalancerInterceptor就是spring boot的一个拦截器

2.2、restTemplateCustomizer**：**该方法用于声明一个RestTemplateCustomizer类型的Bean。该bean的目的在于：将RestTemplate与LoadBalancerInterceptor绑定起来，这是RestTemplate具有负载均衡能力的关键

3、loadBalancedRestTemplateInitializerDeprecated方法用于触发RestTemplateCustomizer这个Bean的执行

综上所述，RestTemplate发出的请求最后是被LoadBalancerInterceptor这个拦截器拦截到了，下面看一下LoadBalancerInterceptor的intercept方法主要做了哪些事情：

@Override
    	public ClientHttpResponse intercept(final HttpRequest request, final byte[] body,
    			final ClientHttpRequestExecution execution) throws IOException {
    		final URI originalUri = request.getURI();
    		String serviceName = originalUri.getHost();
    		Assert.state(serviceName != null, "Request URI does not contain a valid hostname: " + originalUri);
    		return this.loadBalancer.execute(serviceName, requestFactory.createRequest(request, body, execution));
    	}

最终的请求交由loadBalancer这个负载均衡器执行，this.loadBalancer的类型是LoadBalancerClient，而LoadBalancerClient的实现为RibbonLoadBalancerClient，LoadBalancerClient继承自ServiceInstanceChooser接口

public interface ServiceInstanceChooser {
        ServiceInstance choose(String serviceId);
    }

通过this.loadBalancer.execute这行代码往里面跟踪，找到最终的执行方法如下（execute-1会调用execute-2）：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 5][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 6][]

**getServer方法的实现细节：**

ILoadBalancer的chooseServer方法会转换为调用IRule的choose方法。ILoadBalancer和IRule是Ribbon中的两个接口，如果想了解更多请看这篇文章 [Spring Cloud教程 第二弹 客户端负载均衡Ribbon][Spring Cloud_ _ _Ribbon]

**request.apply方法的实现细节：**

request对象是在LoadBalancerInterceptor的intercept方法中传过来的，具体如下图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 7][]

点进去看看，如下图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 8][]

最后的execution.execute方法是执行最终的http请求的地方，至此，一次ribbon的生命周期就到此结束了。

# 总结 #

关于Ribbon的工作原理，我写的虽然有点多，但是很详细，耐心看完的话基本没有啥疑问的。当你读懂之后，发现Ribbon似乎不再神秘了

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 9][]

[Spring Cloud_ _ _Ribbon]: https://blog.csdn.net/xl_1803/article/details/109491636
[Spring]: https://blog.csdn.net/xl_1803/article/details/109462842
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70]: /images/20221120/12d6acbe996440b5bf974eddd30151ee.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201107174659172.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201107174848254.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20201107175051367.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20201107175342932.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM=,size_16,color_FFFFFF,t_70
[Ribbon_LoadBalanced]: https://blog.csdn.net/xl_1803/article/details/109547421
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20201107182756541.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20201107182545677.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20201107183536186.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/2020110718362755.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/20210410091522826.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3hsXzE4MDM=,size_16,color_FFFFFF,t_70