微服务负载均衡器Ribbon实战与原理剖析

一、什么是Ribbon

目前主流的负载方案分为以下两种：

• 集中式负载均衡，在消费者和服务提供方中间使用独立的代理方式进行负载，有硬件的（比如 F5），也有软件的（比如 Nginx）。
• 客户端根据自己的请求情况做负载均衡，Ribbon 就属于客户端自己做负载均衡。

Spring Cloud Ribbon是基于Netflix Ribbon 实现的一套客户端的负载均衡工具，Ribbon客户端组件提供一系列的完善的配置，如超时，重试等。通过Load Balancer获取到服务提供的所有机器实例，Ribbon会自动基于某种规则(轮询，随机)去调用这些服务。Ribbon也可以实现我们自己的负载均衡算法。

1.1 客户端的负载均衡

例如spring cloud中的ribbon，客户端会有一个服务器地址列表，在发送请求前通过负载均衡算法选择一个服务器，然后进行访问，这是客户端负载均衡；即在客户端就进行负载均衡算法分配。

1.2 服务端的负载均衡

例如Nginx，通过Nginx进行负载均衡，先发送请求，然后通过负载均衡算法，在多个服务器之间选择一个进行访问；即在服务器端再进行负载均衡算法分配。

1.3 常见负载均衡算法

• 随机，通过随机选择服务进行执行，一般这种方式使用较少;
• 轮训，负载均衡默认实现方式，请求来之后排队处理;
• 加权轮训，通过对服务器性能的分型，给高配置，低负载的服务器分配更高的权重，均衡各个服务器的压力;
• 地址Hash，通过客户端请求的地址的HASH值取模映射进行服务器调度。 ip hash
• 最小连接数，即使请求均衡了，压力不一定会均衡，最小连接数法就是根据服务器的情况，比如请求积压数等参数，将请求分配到当前压力最小的服务器上。
• 最小活跃数

1.4 Ribbon模块

1.5 Ribbon使用

首先我们启动上次的mall-user、mall-order两个微服务。其中mall-order启动两个实例，端口分别为8046、8047。

然后编写一个客户端来调用接口：

import com.google.common.collect.Lists;
import com.netflix.loadbalancer.ILoadBalancer;
import com.netflix.loadbalancer.LoadBalancerBuilder;
import com.netflix.loadbalancer.Server;
import com.netflix.loadbalancer.reactive.LoadBalancerCommand;
import com.netflix.loadbalancer.reactive.ServerOperation;
import rx.Observable;

import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.List;

public class RibbonDemo {

    public static void main(String[] args) {
        // 服务列表(地址写自己本地的mall-order的两个服务地址)
        List<Server> serverList = Lists.newArrayList(
                new Server("localhost", 8046),
                new Server("localhost", 8047));

        // 构建负载实例
        ILoadBalancer loadBalancer = LoadBalancerBuilder.newBuilder()
                .buildFixedServerListLoadBalancer(serverList);

        // 调用 5 次来测试效果
        for (int i = 0; i < 5; i++) {
            LoadBalancerCommand.<String>builder()
                    .withLoadBalancer(loadBalancer).build()
                    .submit(new ServerOperation<String>() {
                        @Override
                        public Observable<String> call(Server server) {
                            String addr = "http://" + server.getHost() + ":"
                                    + server.getPort() + "/order/findOrderByUserId/1";
                            System.out.println("调用地址：" + addr);

                            URL url = null;

                            try {
                                url = new URL(addr);
                                HttpURLConnection conn = (HttpURLConnection) url.openConnection();
                                conn.setRequestMethod("GET");
                                conn.connect();

                                InputStream in = conn.getInputStream();
                                byte[] data = new byte[in.available()];
                                in.read(data);
                                return Observable.just(new String(data));
                            } catch (IOException e) {
                                e.printStackTrace();
                            }
                            return null;
                        }
                    }).toBlocking().first();
        }
    }
}

上述这个例子主要演示了 Ribbon 如何去做负载操作，调用接口用的最底层的 HttpURLConnection。

二、Spring Cloud快速整合Ribbon

2.1 引入依赖

<!--添加ribbon的依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
<dependency>    

注意： nacos-discovery依赖了ribbon，可以不用再引入ribbon依赖。

2.2 添加@LoadBalanced注解

@Configuration
public class RestConfig {
    
    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    } 
}    

2.3 修改controller

@Autowired
private RestTemplate restTemplate;

// version2
@GetMapping("/findOrderByUserId/{userId}")
public R findOrderByUserId(@PathVariable("userId") Integer userId) {
    String url = "http://mall-order/order/findOrderByUserId/" + userId;
    // import com.baomidou.mybatisplus.extension.api.R;
    R result = restTemplate.getForObject(url, R.class);
    return result;
}

此时的restTemplate已经具备了自动获取服务列表并根据负载均衡算法确定出要调用服务的能力。我们只需要根据服务名称调用服务即可，不再需要关心服务具体的url以及调用哪个服务。

三、Ribbon内核原理

其实关于请求调用，Spring提供有一个扩展点拦截器：ClientHttpRequestInterceptor。

Ribbon中使用LoadBalancerInterceptor实现了这个拦截器，会拦截请求，根据负载均衡算法，将原始URL中中的"mall-order"替换成服务实例ip:port，然后再进行最终调用。

3.1.1 模拟ribbon实现

@Slf4j
@RestController
@RequestMapping("/user2")
public class UserController2 {

    @Autowired
    private DiscoveryClient discoveryClient;

    @Autowired
    private RestTemplate restTemplate;

    private AtomicInteger nextIndex = new AtomicInteger(0);

    @RequestMapping(value = "/findOrderByUserId/{id}")
    public R findOrderByUserId(@PathVariable("id") Integer id) {
        List<ServiceInstance> serverList = discoveryClient.getInstances("mall-order");
        for (ServiceInstance serviceInstance : serverList) {
            System.out.println("serviceInstance:" + serviceInstance.getHost() + serviceInstance.getPort());
        }

        //模拟ribbon实现
        String url = getUri("mall-order") + "/order/findOrderByUserId/" + id;
        R result = restTemplate.getForObject(url, R.class);
        return result;
    }


    public String getUri(String serviceName) {
        List<ServiceInstance> serviceInstances = discoveryClient.getInstances(serviceName);
        if (serviceInstances == null || serviceInstances.isEmpty()) {
            return null;
        }
        int serviceSize = serviceInstances.size();
        // 负载均衡算法：轮询
        int indexServer = incrementAndGetModulo(serviceSize);
        return serviceInstances.get(indexServer).getUri().toString();
    }

    private int incrementAndGetModulo(int modulo) {
        for (; ; ) {
            int current = nextIndex.get();
            int next = (current + 1) % modulo;
            if (nextIndex.compareAndSet(current, next) && current < modulo) {
                return current;
            }
        }
    }
}

3.1.2 @LoadBalanced 注解原理

参考源码： org.springframework.cloud.client.loadbalancer.LoadBalancerAutoConfiguration

@LoadBalanced利用@Qualifier作为restTemplates注入的筛选条件，筛选出具有负载均衡标识的RestTemplate。

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({RestTemplate.class})
@ConditionalOnBean({LoadBalancerClient.class})
@EnableConfigurationProperties({LoadBalancerRetryProperties.class})
public class LoadBalancerAutoConfiguration {
	
	//  @LoadBalanced只是一个表示，这里会找到所有加了@LoadBalanced注解的restTemplate bean，然后将其放入这个List中。
    @LoadBalanced
    @Autowired(required = false)
    // 注意，如果注入的是一个List或者Map，会将容器中所有该类型的bean注入到List或者Map（key为String,是bean名称）中
    private List<RestTemplate> restTemplates = Collections.emptyList();

---

@Autowired还可以注入List和Map。

比如我定义两个Bean:

@Bean("user1")
User user1() {
return new User("1", "a");
}

@Bean("user2"))
User user2() {
return new User("2", "b");
}

然后有如下注入：

@Autowired(required = false)
private List<User> users = Collections.emptyList();

@Autowired(required = false)
private Map<String,User> userMap = new HashMap<>();

此时就可以自动将两个bean注入进来，当注入map的时候，map的key必须是String类型，然后bean name将作为map的key,本例，map中将有两个key分别为user1和user2,value分别为对应的User Bean实例。

然后我们给user1和user2分别打上@Qualifier修饰符:

@Bean("user1")
@Qualifier("valid")
User user1() {
return new User("1", "a");
}

@Bean("user2")
@Qualifier("invalid")
User user2() {
return new User("2", "b");
}

然后将user list 和user map分别也打上@Qualifier修饰符:

@Autowired(required = false)
@Qualifier("valid")
private List<User> users = Collections.emptyList();

@Autowired(required = false)
@Qualifier("invalid")
private Map<String,User> userMap = new HashMap<>();

那么所有标注了@Qualifier(“valid”)的user bean都会自动注入到List users中去(本例是user1)，所有标注了@Qualifier(“invalid”)的user bean都会自动注入到Map userMap中去（本例是user2）。

看到这里我们可以理解@LoadBalanced的用处了，其实就是一个修饰符，和@Qualifier一样，比如我们给user1打上@LoadBalanced:

@Bean("user1")
@LoadBalanced
User user1() {
return new User("1", "a");
}

@Bean("user2")
User user2() {
return new User("2", "b");
}

然后controller中给List users打上@LoadBalanced注解：

@Autowired(required = false)
@LoadBalanced
private List<User> users = Collections.emptyList();

和@Qualifier注解效果一样，只有user1被注入进了List，user2没有修饰符，没有被注入进去。
另外当spring容器中有多个相同类型的bean的时候，可以通过@Qualifier来进行区分，以便在注入的时候明确表明你要注入具体的哪个bean,消除歧义。

本段示例来自文章：https://www.cnblogs.com/miracle77hp/p/10106633.html

---

被@LoadBalanced注解的restTemplate会被定制，添加LoadBalancerInterceptor拦截器。

@Configuration(
        proxyBeanMethods = false
    )
@ConditionalOnMissingClass({"org.springframework.retry.support.RetryTemplate"})
static class LoadBalancerInterceptorConfig {
    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());
            // 给加了@LoadBalanced注解的restTemplate添加拦截器，使其就别服务列表拉取和负载均衡确定唯一服务的能力
            list.add(loadBalancerInterceptor);
            restTemplate.setInterceptors(list);
        };
    }
}

3.1.3 Ribbon相关接口

参考： org.springframework.cloud.netflix.ribbon.RibbonClientConfiguration

• IClientConfig：Ribbon的客户端配置，默认采用DefaultClientConfigImpl实现。
• IRule：Ribbon的负载均衡策略，默认采用ZoneAvoidanceRule实现，该策略能够在多区域环境下选出最佳区域的实例进行访问。
• IPing：Ribbon的实例检查策略，默认采用DummyPing实现，该检查策略是一个特殊的实现，实际上它并不会检查实例是否可用，而是始终返回true，默认认为所有服务实例都是可用的。
• ServerList：服务实例清单的维护机制，默认采用ConfigurationBasedServerList实现。
• ServerListFilter：服务实例清单过滤机制，默认采ZonePreferenceServerListFilter，该策略能够优先过滤出与请求方处于同区域的服务实例。
• ILoadBalancer：负载均衡器，默认采用ZoneAwareLoadBalancer实现，它具备了区域感知的能力。

3.2 Ribbon负载均衡策略

• RandomRule： 随机选择一个Server。
• RetryRule：对选定的负载均衡策略机上重试机制，在一个配置时间段内当选择Server不成功，则一直尝试使用subRule的方式选择一个可用的server。
• RoundRobinRule： 轮询选择， 轮询index，选择index对应位置的Server。
• AvailabilityFilteringRule： 过滤掉一直连接失败的被标记为circuit tripped的后端Server，并过滤掉那些高并发的后端Server或者使用一个AvailabilityPredicate来包含过滤server的逻辑，其实就是检查status里记录的各个Server的运行状态。
• BestAvailableRule：选择一个最小的并发请求的Server，逐个考察Server，如果Server被tripped了，则跳过。
• WeightedResponseTimeRule： 根据响应时间加权，响应时间越长，权重越小，被选中的可能性越低。
• ZoneAvoidanceRule：默认的负载均衡策略，即复合判断Server所在区域的性能和Server的可用性选择Server，在没有区域的环境下，类似于轮询(RandomRule)
• NacosRule: 同集群优先调用

3.2.1 修改默认负载均衡策略

修改全局配置：调用其他微服务，一律使用指定的负载均衡算法

@Configuration
public class RibbonConfig {

  /**
    * 全局配置
    * 指定负载均衡策略
    * @return
    */
   @Bean
   public IRule() {
       // 指定使用Nacos提供的负载均衡策略（优先调用同一集群的实例，基于随机权重）
       return new NacosRule();
   }
}  

修改局部配置：调用指定微服务提供的服务时，使用对应的负载均衡算法
修改application.yml：

# 被调用的微服务名
mall-order:
  ribbon:
    # 指定使用Nacos提供的负载均衡策略（优先调用同一集群的实例，基于随机&权重）
    NFLoadBalancerRuleClassName: com.alibaba.cloud.nacos.ribbon.NacosRule

3.2.2 自定义负载均衡策略

通过实现IRule接口可以自定义负载策略，主要的选择服务逻辑在 choose 方法中。

1）实现基于Nacos权重的负载均衡策略

@Slf4j
public class NacosRandomWithWeightRule extends AbstractLoadBalancerRule {

    @Autowired
    private NacosDiscoveryProperties nacosDiscoveryProperties;

    @Override
    public Server choose(Object key) {
        DynamicServerListLoadBalancer loadBalancer = (DynamicServerListLoadBalancer) getLoadBalancer();
        String serviceName = loadBalancer.getName();
        NamingService namingService = nacosDiscoveryProperties.namingServiceInstance();
        try {
            //nacos基于权重的算法
            Instance instance = namingService.selectOneHealthyInstance(serviceName);
            return new NacosServer(instance);
        } catch (NacosException e) {
            log.error("获取服务实例异常：{}", e.getMessage());
            e.printStackTrace();
        }
        return null;
    }
    @Override
    public void initWithNiwsConfig(IClientConfig clientConfig) {

    }
}    

2) 配置自定义的策略

2.1）局部配置
修改application.yml：

# 被调用的微服务名
mall-order:
  ribbon:
    # 自定义的负载均衡策略（基于随机&权重）
    NFLoadBalancerRuleClassName: com.tuling.mall.ribbondemo.rule.NacosRandomWithWeightRule

2.2）全局配置

@Bean
public IRule ribbonRule() {
    return new NacosRandomWithWeightRule();
}

3）局部配置第二种方式
可以利用@RibbonClient指定微服务及其负载均衡策略。

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class, DruidDataSourceAutoConfigure.class})
//@RibbonClient(name = "mall-order", configuration = RibbonConfig.class)
//配置多个   RibbonConfig不能被@SpringbootApplication的@CompentScan扫描到，否则就是全局配置的效果
@RibbonClients(value = {
    // 在SpringBoot主程序扫描的包外定义配置类
    @RibbonClient(name = "mall-order", configuration = RibbonConfig.class),
    @RibbonClient(name = "mall-account", configuration = RibbonConfig.class)    
})
public class MallUserRibbonDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(MallUserRibbonDemoApplication.class, args);
    }
}

注意：此处有坑。不能写在@SpringbootApplication注解的@CompentScan扫描得到的地方，否则自定义的配置类就会被所有的RibbonClients共享。不建议这么使用，推荐yml方式。

3.3 饥饿加载

在进行服务调用的时候，如果网络情况不好，第一次调用会超时。

Ribbon默认懒加载，意味着只有在发起调用的时候才会创建客户端。

开启饥饿加载，解决第一次调用慢的问题：

ribbon:
  eager-load:
    # 开启ribbon饥饿加载
    enabled: true
    # 配置mall-user使用ribbon饥饿加载，多个使用逗号分隔
    clients: mall-order

源码对应属性配置类：RibbonEagerLoadProperties

测试：

3.4 负载均衡器扩展点

SpringCloud中提供了接口org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser：

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

还提供有一个org.springframework.cloud.client.loadbalancer.LoadBalancerClient接口，继承了ServiceInstanceChooser：

public interface LoadBalancerClient extends ServiceInstanceChooser {
    <T> T execute(String serviceId, LoadBalancerRequest<T> request) throws IOException;

    <T> T execute(String serviceId, ServiceInstance serviceInstance, LoadBalancerRequest<T> request) throws IOException;

    URI reconstructURI(ServiceInstance instance, URI original);
}

也就是说，只要实现了这个LoadBalancerClient接口，我们就可以定义自己的负载均衡器了。其实Ribbon中也是使用org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient类实现了LoadBalancerClient接口。