【Spring Cloud 源码解读】之 【这也太神奇了，RestTemplate加上一个@LoadBalanced注解就能实现负载均衡！】

前提概要：

前天，有个前端大佬问了我两个问题：为啥不引入

Ribbon

Ribbon

RestTemplate

@LoadBalanced

第一个问题比较简单，一般都是其他依赖引入了

Ribbon

Nacos

Eureka

第二个问题由于有一点深度，所以需要好好的研究一番。

1、准备：启动两个服务提供者实例，然后启动一个服务消费者实例

2、开始搞起来

1、准备两个RestTemplate:

一个启动负载均衡，一个不启动负载均衡

@Configuration
public class MyConfiguration {

// 启动负载均衡
@LoadBalanced
@Bean
RestTemplate loadBalanced() {
return new RestTemplate();
}

// 不启动负载均衡
@Bean
RestTemplate restTemplate() {
return new RestTemplate();
}
}

2、负载均衡探索：

@Autowired
private RestTemplate loadBalanced;

@GetMapping("restTemplate-hello")
public String sayHello(){
return loadBalanced.getForObject("http://cloud-nacos-discovery-server/hello",String.class);
}

注意：使用负载均衡的

RestTemplate

Ribbon

[serviceId]

IP:Port

java.lang.IllegalStateException: No instances available for 10.172.29.666

(1)、为何带上@LoadBalanced就能负载均衡？

之所以标记了

@LoadBalanced

RestTemplate

RestTemplate

LoadBalancerInterceptor

loadBalanced

LoadBalancerInterceptor

(2)、拦截器是如何进行负载均衡的？

RestTemplate

Ribbon

public ClientHttpResponse intercept(final HttpRequest request, final byte[] body, final ClientHttpRequestExecution execution) throws IOException {
URI originalUri = request.getURI();
String serviceName = originalUri.getHost();
Assert.state(serviceName != null, "Request URI does not contain a valid hostname: " + originalUri);
//这里是使用负载均衡，而这里的loadBalancer就是Spring Cloud提供的LoadBalancerClient接口的实现类。
return (ClientHttpResponse)this.loadBalancer.execute(serviceName, this.requestFactory.createRequest(request, body, execution));
}

我们也看到，最后是通过

(ClientHttpResponse)this.loadBalancer.execute(serviceName, this.requestFactory.createRequest(request, body, execution))

RestTemplate

loadBanalcer

RibbonLoadBalancerClient

Ribbon

(3)、那究竟是谁帮RestTemplate加上这个拦截器的？而且是什么时候加的？

① LoadBalancerAutoConfiguration配置类

关于

@LoadBalanced

LoadBalancerAutoConfiguration

我们可以看到这个配置类上有俩个注解：

@ConditionalOnClass({RestTemplate.class})

@ConditionalOnBean({LoadBalancerClient.class})

RestTemplate

Spring

LoadBalancerClient

Spring

web

RestTemplate

Ribbon

LoadBalancerClient

@Configuration
@ConditionalOnClass({RestTemplate.class})
@ConditionalOnBean({LoadBalancerClient.class})
@EnableConfigurationProperties({LoadBalancerRetryProperties.class})
public class LoadBalancerAutoConfiguration {

② 一个关键的成员变量

我们可以看到

LoadBalancerAutoConfiguration

//拿到Spring容器内所有的标注有@LoadBalanced注解的RestTemplate们。 注意：是带有@LoadBalanced注解的
@LoadBalanced
@Autowired(required = false)
private List<RestTemplate> restTemplates = Collections.emptyList();

③ RestTemplateCustomizer来加拦截器

我们会先找拦截器相关的代码，因为此时我们都知道负载均衡主要靠的是拦截器，所以，上代码：

@Bean
@ConditionalOnMissingBean
public RestTemplateCustomizer restTemplateCustomizer(final LoadBalancerInterceptor loadBalancerInterceptor) {
return (restTemplate) -> {
// 我们可以看到，如果我们没有自己实现`RestTemplateCustomizer`，就会执行下面的逻辑，而最突兀的就是，它给每一个`RestTemplate`添加了`LoadBalancerInterceptor`，也就是实现负载均衡的重点所在。
List<ClientHttpRequestInterceptor> list = new ArrayList(restTemplate.getInterceptors());
list.add(loadBalancerInterceptor);
restTemplate.setInterceptors(list);
};
}

④ 何时利用RestTemplateCustomizer来给RestTemplate加拦截器

还有另外一段很重要的代码，需要来解读一下：

首先我们得先了解

SmartInitializingSingleton

afterSingletonsInstantiated()

public interface SmartInitializingSingleton {
void afterSingletonsInstantiated();
}

那么我们就知道了，接下来要解读的代码就是为了处理一个个带有

@LoadBalanced

RestTemplate

RestTemplateCustomizer

RestTemplate

LoadBalancerInterceptor

@Bean
public SmartInitializingSingleton loadBalancedRestTemplateInitializerDeprecated(final ObjectProvider<List<RestTemplateCustomizer>> restTemplateCustomizers) {
return () -> {
restTemplateCustomizers.ifAvailable((customizers) -> {
// 遍历上面提及的成员变量，带@LoadBalanced的RestTemplate们
Iterator var2 = this.restTemplates.iterator();

while(var2.hasNext()) {
RestTemplate restTemplate = (RestTemplate)var2.next();
Iterator var4 = customizers.iterator();

while(var4.hasNext()) {
// 利用上面的RestTemplateCustomizer给RestTemplate们加拦截器
RestTemplateCustomizer customizer = (RestTemplateCustomizer)var4.next();
customizer.customize(restTemplate);
}
}

});
};
}

所以最后，我们可以给第三个问题一个答案：在带有

@LoadBalanced

RestTemplate

RestTemplateCustomizer

RestTemplate

LoadBalancerInterceptor

3、非负载均衡探索

@Autowrite
private RestTemplate restTemplate;

@GetMapping("restTemplate-hello")
public String sayHello(){
return myRestTemplate.getForObject("http://10.172.29.666:8887/hello",String.class);
}

首先可以看到，RestTemplate不再带有拦截器

而且，我们可以看到，最后接口走的是

SimpleBufferingClientHttpRequest

RibbonLoadBalancerClient

到此，关于为什么添加了

@LoadBalanced

Ribbon