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

前天,有个前端大佬问了我两个问题:为啥不引入Ribbon依赖就能使用Ribbon?为啥RestTemplate加上@LoadBalanced注解就能负载均衡了?我也表示很疑惑,而我自己其实也真的没去了解过,所以趁着工作不太忙,赶紧去研究一波。

第一个问题比较简单,一般都是其他依赖引入了Ribbon,我这里是Nacos,而他那边也是注册中心Eureka。

Ribbon依赖

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

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去请求时url一定得写服务名,因为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是负载均衡的。

Ribbon负载均衡

(3)、那究竟是谁帮RestTemplate加上这个拦截器的?而且是什么时候加的? ① LoadBalancerAutoConfiguration配置类

关于@LoadBalanced自动生效的配置,我们需要来到这个自动配置类:LoadBalancerAutoConfiguration。

我们可以看到这个配置类上有俩个注解:@ConditionalOnClass({RestTemplate.class}),@ConditionalOnBean({LoadBalancerClient.class}),意思是说:只要有RestTemplate类存在,并且Spring容器中存在LoadBalancerClient类型的Bean,这个配置类才会生效。首先,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来加拦截器

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zwypsd.html