Spring Cloud之Ribbon源码分析
Ribbon源码要从自动配置的依赖包说起。
环境初始化
RibbonAutoConfiguration
spring-cloud-netflix-ribbon.pngRibbonAutoConfiguration作用:
1、@Autowired注入一些属性值
List<RibbonClientSpecification> configurations。
这个实现原理是@RibbonClients注解中@Import(RibbonClientConfigurationRegistrar.class)类,在注册到registry时,是当前name加上.RibbonClientSpecification后缀实现的。一共有两个,RibbonAutoConfiguration和EurekaRibbonClientConfiguration
configurations.png
2、@Bean创建一些Bean到spring容器中
SpringClientFactory、LoadBalancerClient等
在创建SpringClientFactory类时,会把RibbonClientConfiguration类赋值给NamedContextFactory#defaultConfigType属性,在子容器初始化之前会注册当前类
SpringClientFactory.png
3、自动配置LoadBalancerAutoConfiguration
这个类AutoConfigureBefore之前还会导入LoadBalancerAutoConfiguration类
另一个也是通过自动配置依赖包注入的。
LoadBalancerAutoConfiguration注解类
restTemplates.png
对于加了@LoadBalanced注解的RestTemplate类加入到restTemplates集合中
LoadBalancerInterceptor.png
对restTemplate添加过滤器LoadBalancerInterceptor,所以当我们程序调用restTemplate的微服务调用时,会先调用这个过滤器对象。
RibbonEurekaAutoConfiguration
会加入到List<RibbonClientSpecification> configurations集合
spring-cloud-netflix-eureka-client.png
RibbonEurekaAutoConfiguration
RibbonEurekaAutoConfiguration.png
创建并注入到spring的IPing和ServerList的Bean
image.png
restTemplate.getForObject调用过程
1、intercept
获取调用的URI和调用服务名
org.springframework.cloud.client.loadbalancer.LoadBalancerInterceptor#intercept
intercept.png
2、execute
通过调用LoadBalancerClient类的execute方法
org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient#execute
RibbonLoadBalancerClient.png
org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient#execute
execute.png
这个方法是ribbon执行的关键代码,就是如何从微服务名字user最终获取到具体的调用服务ip地址和端口的。以及在这里面是通过怎么负载均衡选择服务的通过什么IRule算法实现的。这个方法的主要步骤是getLoadBalancer()和getServer()
负载均衡器ILoadBalancer
1、getLoadBalancer
从SpringClientFactory工厂获取name是serviceId的ILoadBalancer实现类
org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient#getLoadBalancer
image.png
2、getLoadBalancer
org.springframework.cloud.netflix.ribbon.SpringClientFactory#getLoadBalancer
image.png
3、getInstance
org.springframework.cloud.netflix.ribbon.SpringClientFactory#getInstance
image.png
4、getInstance
通过调用父类方法getInstance()获取IloadBanlancer类
org.springframework.cloud.context.named.NamedContextFactory#getInstance
image.png
通过创建一个子容器context,实现了容器的隔离,在容器内获取IloadBanlancer实例
5、getContext
获取调用微服务名字的spring容器
org.springframework.cloud.context.named.NamedContextFactory#getContext
image.png
查看是否包含当前调用微服务名字的子容器,如果不存在则创建
6、createContext
创建子容器
org.springframework.cloud.context.named.NamedContextFactory#createContext
createContext.png
调用过程:
①、首先对之前注入的List<RibbonClientSpecification> configurations集合进行遍历,查看配置集合中是否包含了当前调用微服务名字
②、对configurations集合遍历是否包含configuration,然后注册到当前spring容器中。RibbonEurekaAutoConfiguration包含了默认配置EurekaRibbonClientConfiguration类。
image.png
③、对context环境对RibbonClientConfiguration类的注册,defaultConfigType=org.springframework.cloud.netflix.ribbon.RibbonClientConfiguration
④、环境的添加,键是ribbon.client.name的属性添加
⑤、最重要的是设置context的父容器是当前正在调用spring容器,实现容器隔离。父容器不能调用子容器的Bean对象
⑥、设置displayName
⑦、调用容器刷新方法refresh()
完成spring bean创建Bean的生命周期。
7、getInstance
从spring容器中得到的对象类型是DynamicServerListLoadBalancer
org.springframework.cloud.netflix.ribbon.SpringClientFactory#getInstance
image.png
方法得到对象DynamicServerListLoadBalancer已经含有微服务的地址和端口号,所以对于如何得到IloadBanlancer类,需要分析DynamicServerListLoadBalancer类的调用过程
DynamicServerListLoadBalancer类的继承关系图(绿色实线)
DynamicServerListLoadBalancer.png
8、DynamicServerListLoadBalancer
com.netflix.loadbalancer.DynamicServerListLoadBalancer#DynamicServerListLoadBalancer
DynamicServerListLoadBalancer.png
首先调用父类方法,进行初始化
image.png
com.netflix.loadbalancer.BaseLoadBalancer#initWithConfig
image.png
对当前类属性值进行初始化IClientConfig(DefaultClientConfigImpl)、IRule(ZoneAvoidanceRule RoundRobinRule)、IPing(NIWSDiscoveryPing)、pingIntervalSeconds(30s)、maxTotalPingTimeSeconds(2)等属性值
9、restOfInit
这个方法是开启定时调度器任务更新服务列表和直接更新服务列表
com.netflix.loadbalancer.DynamicServerListLoadBalancer#restOfInit
restOfInit.png
enableAndInitLearnNewServersFeature开启定时刷新服务列表
enableAndInitLearnNewServersFeature.png
开启定时调度器
com.netflix.loadbalancer.PollingServerListUpdater#start
start.png
定时调度器会调用到updateAction.doUpdate()方法,这个方法内是updateListOfServers方法
com.netflix.loadbalancer.ServerListUpdater.UpdateAction
image.png
调度器调用updateListOfServers方法,refreshIntervalMs=30s,initialDelayMs=1s
在restOfInit方法内也会调用updateListOfServers()方法
image.png
10、updateListOfServers
updateListOfServers.png
这个方法有三步:
①、getUpdatedListOfServers获取服务列表
org.springframework.cloud.netflix.ribbon.eureka.DomainExtractingServerList#getUpdatedListOfServers
getUpdatedListOfServers.png
com.netflix.niws.loadbalancer.DiscoveryEnabledNIWSServerList#getUpdatedListOfServers
getUpdatedListOfServers.png
com.netflix.niws.loadbalancer.DiscoveryEnabledNIWSServerList#obtainServersViaDiscovery
obtainServersViaDiscovery.png
通过eurekaClient的jdk动态代理类,从当前Eurek客户端获取vipaddress是user的实例信息
得到List<T> servers集合对象后,然后通过ZonePreferenceServerListFilter进行区域过滤
②、getFilteredListOfServers方法通过ZonePreferenceServerListFilter过滤器过滤符合当前区域servers集合
getFilteredListOfServers.png
③、updateAllServerList更新所有服务状态通过IPing的实现类NIWSDiscoveryPing,判断是否是UP存活状态
com.netflix.loadbalancer.DynamicServerListLoadBalancer#updateAllServerList
image.png
com.netflix.loadbalancer.BaseLoadBalancer#forceQuickPing
image.png
com.netflix.loadbalancer.BaseLoadBalancer.Pinger#runPinger
image.png
com.netflix.loadbalancer.BaseLoadBalancer.SerialPingStrategy#pingServers
image.png
com.netflix.niws.loadbalancer.NIWSDiscoveryPing#isAlive
isAlive.png
判断实例信息的status是否是up状态
获取Server
通过getLoadBalancer方法调用,已经得到了ILoadBalancer的实现类DynamicServerListLoadBalancer,这里面已经包含调用微服务的服务ip和端口的list集合,接下来就是如何选取哪一个服务调用的问题。这里便用到了IRule实现类的算法调用
org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient#execute
getLoadBalancer.png
1、getServer
org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient#getServer
getServer.png
在ILoadBalancer的实现类DynamicServerListLoadBalancer选择服务
2、chooseServer
com.netflix.loadbalancer.ZoneAwareLoadBalancer#chooseServer
chooseServer.png
3、chooseServer
com.netflix.loadbalancer.BaseLoadBalancer#chooseServer
chooseServer.png
image.png
4、incrementAndGetModulo
com.netflix.loadbalancer.AbstractServerPredicate#incrementAndGetModulo
incrementAndGetModulo.png
默认情况下是使用轮询规则获取一个。通过nextIndex值获取,并对下一次nextIndex属性值进行CAS赋值操作,然后下次通过List<Server>集合的下标current得到,并再次赋值。
接下来便是封装RibbonServer对象,执行http请求
IRule实现类
IRule是Ribbon负载均衡的接口,默认实现
1、RoundRobinRule 轮训
2、RandomRule 随机
3、AvailabilityFilteringRule
会先过滤掉由于多次访问故障而处于断路器跳闸状态的服务,还有并发的连接数量超过阈值的服务,然后对剩余的服务列表按照轮询策略进行选取
4、WeightedResponseTimeRule
根据平均响应时间计算所有服务的权重,响应时间越快的服务权重越大,刚启动时,如果统计信息不足,则使用RoundRobinRule 策略,等统计信息足够厚,会切换到WeightedResponseTimeRule
5、RetryRule
先按照RoundRobinRule 策略获取服务,如果获取服务失败则在指定的时间内重试,再获取不到则会放弃
6、BestAvailableRule
会先过滤掉由于多次访问故障而处于断路器跳闸状态的服务,然后选择一个并发量最小的服务
7、ZoneAvoidanceRule
默认规则,判断Server所在的区域的性能和可用选择服务器
总结:
实现原理:通过RestTemplate类的调用,然后在当前Eureka客户端拉取符合调用服务的服务IP和端口的服务集合,然后通过IRule规则实现的算法调用服务最后通过Http请求调用服务过程。