02_ribbon使用及扩展点

什么是Ribbon:

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

可以实现我们自己的负载均衡算法。

Ribbon快速开始:

引入ribbon依赖

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

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

RestTemplate 添加@LoadBalanced注解，让RestTemplate在请求时拥有客户端负载均衡的能力：

    @Bean
    @LoadBalanced  // 微服务名替换为具体的ip:port
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

测试，使用微服务名发起调用：

    @RequestMapping(value = "/findOrderByUserId/{id}")
    public R findOrderByUserId(@PathVariable("id") Integer id) {
        log.info("根据userId:" + id + "查询订单信息");
        // ribbon实现，restTemplate需要添加@LoadBalanced注解
        // mall-order  ip:port
        String url = "http://mall-order/order/findOrderByUserId/" + id;
        return restTemplate.getForObject(url, R.class);
    }

Ribbon内核原理

自定义负载均衡策略模拟ribbon实现：

　　@Autowired
　　private DiscoveryClient discoveryClient;
　　private final AtomicInteger nextIndex = new AtomicInteger(0);

　　@RequestMapping(value = "/findOrderByUserId/{id}")
    public R findOrderByUserId(@PathVariable("id") Integer id) {
        //模拟ribbon实现
        String url = getUri("mall-order") + "/order/findOrderByUserId/" + id;
        return restTemplate.getForObject(url, R.class);
    }

    /**
     * 根据服务名称从nacos获取服务列表选择调用服务实例
     */
    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;
            }
        }
    }

@LoadBalanced 注解原理

参考源码： LoadBalancerAutoConfiguration。 

@LoadBalanced使用了@Qualifier，spring中@Qualifier用于筛选限定注入Bean。

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

为所有添加了@LoadBalanced注解的RestTemplate的bean添加loadBalancerInterceptor拦截器：

注意： SmartInitializingSingleton是在所有的bean都实例化完成之后才会调用的，所以在bean的实例化期间使用@LoadBalanced修饰的restTemplate是不具备负载均衡作用的。 

若有在实例化过程中远程调用restTemplate的需求，在不使用@LoadBalanced注解，也可以通过添加LoadBalancerInterceptor拦截器让restTemplate起到负载均衡器的作用：

@Bean
    public RestTemplate restTemplate(LoadBalancerInterceptor loadBalancerInterceptor) {
        RestTemplate restTemplate = new RestTemplate();
        //注入loadBalancerInterceptor拦截器
        List<ClientHttpRequestInterceptor> interceptors = restTemplate.getInterceptors();
        interceptors.add(loadBalancerInterceptor);
        restTemplate.setInterceptors(interceptors);
        return restTemplate;
    }

模拟@LoadBalanced注解实现对所有RestTemplate实例的bean添加定制拦截器

添加自定义注解：

@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Qualifier  // 限定符,用于筛选限定注入的Bean
public @interface MyLoadBalanced {
}

添加自定义拦截器Interceptor：

@Slf4j
public class MyLoadBalancerInterceptor implements ClientHttpRequestInterceptor {

    private final LoadBalancerClient loadBalancer;
    private final LoadBalancerRequestFactory requestFactory;

    public MyLoadBalancerInterceptor(LoadBalancerClient loadBalancer, LoadBalancerRequestFactory requestFactory) {
        this.loadBalancer = loadBalancer;
        this.requestFactory = requestFactory;
    }

    public MyLoadBalancerInterceptor(LoadBalancerClient loadBalancer) {
        this(loadBalancer, new LoadBalancerRequestFactory(loadBalancer));
    }

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        final URI originalUri = request.getURI();
        String serviceName = originalUri.getHost();
        log.info("进入自定义的请求拦截器中" + serviceName);
        Assert.state(serviceName != null, "Request URI does not contain a valid hostname: " + originalUri);
        return this.loadBalancer.execute(serviceName, requestFactory.createRequest(request, body, execution));
    }
}

RestTemplate的bean上添加自定义注解@MyLoadBalanced注解：

    @Bean
    @MyLoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

配置类中为有自定义注解@MyLoadBalanced的RestTemplate的bean添加自定义拦截器：

@Configuration
public class MyLoadBalancerAutoConfiguration {

    @MyLoadBalanced
    @Autowired(required = false) // 限定注入到list的RestTemplate
    private final List<RestTemplate> restTemplates = Collections.emptyList();

    @Bean
    public MyLoadBalancerInterceptor myLoadBalancerInterceptor(LoadBalancerClient loadBalancerClient) {
        return new MyLoadBalancerInterceptor(loadBalancerClient);
    }

    @Bean
    public SmartInitializingSingleton myLoadBalancedRestTemplateInitializer(MyLoadBalancerInterceptor myLoadBalancerInterceptor) {
        //  spring的扩展点
        return () -> {
            for (RestTemplate restTemplate : MyLoadBalancerAutoConfiguration.this.restTemplates) {
                List<ClientHttpRequestInterceptor> list = new ArrayList<>(restTemplate.getInterceptors());
                // 填充拦截器
                list.add(myLoadBalancerInterceptor);
                restTemplate.setInterceptors(list);
            }
        };
    }
}

Ribbon扩展功能

Ribbon相关接口：

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

IClientConfig：Ribbon的客户端配置，默认采用DefaultClientConfigImpl实现。

IRule：Ribbon的负载均衡策略，默认采用ZoneAvoidanceRule实现，该策略能够在多区域环境下选出最佳区域的实例进行访问。

IPing：Ribbon的实例检查策略，默认采用DummyPing实现，该检查策略是一个特殊的实现，实际上它并不会检查实例是否可用，而是始终返回true，默认认为所有服务实例都是可用的。

ServerList：服务实例清单的维护机制，默认采用ConfigurationBasedServerList实现。

ServerListFilter：服务实例清单过滤机制，默认采ZonePreferenceServerListFilter，该策略能够优先过滤出与请求方处于同区域的服务实例。

ILoadBalancer：负载均衡器，默认采用ZoneAwareLoadBalancer实现，它具备了区域感知的能力。 

Ribbon负载均衡策略：

1. RandomRule： 随机选择一个Server。

2. RetryRule： 对选定的负载均衡策略机上重试机制，在一个配置时间段内当选择Server不成功，则一直尝试使用subRule的方式选择一个可用的server。

3. RoundRobinRule： 轮询选择， 轮询index，选择index对应位置的Server。

4. AvailabilityFilteringRule： 过滤掉一直连接失败的被标记为circuit tripped的后端Server，并过滤掉那些高并发的后端Server或者使用一个AvailabilityPredicate来包含过滤server的逻辑，其实就是检查status里记录的各个Server的运行状态。

5. BestAvailableRule： 选择一个最小的并发请求的Server，逐个考察Server，如果Server被tripped了，则跳过。

6. WeightedResponseTimeRule： 根据响应时间加权，响应时间越长，权重越小，被选中的可能性越低。

7. ZoneAvoidanceRule： 默认的负载均衡策略，即复合判断Server所在区域的性能和Server的可用性选择Server，在没有区域的环境下，类似于轮询

8. NacosRule: 优先调用同一集群的实例，基于随机权重

修改默认负载均衡策略：

全局配置：调用的微服务，一律使用指定的负载均衡策略

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

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

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

测试nacosRule，启动两个集群SH和BJ:

 调用端口配置集群为SH，查看请求是否都落在SH集群的机器上。

自定义负载均衡策略：

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

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

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);
            log.info(instance.getIp() + ":" + instance.getPort());
            return new NacosServer(instance);
        } catch (NacosException e) {
            log.error("获取服务实例异常：{}", e.getMessage());
            e.printStackTrace();
        }

        return null;
    }

    @Override
    public void initWithNiwsConfig(IClientConfig clientConfig) {

    }
}

配置自定义的策略：

全局配置：

    /**
     * 自定义负载均衡策略-全局配置
     * 指定负载均衡策略
     */
    @Bean
    public IRule ribbonRule() {
        return new NacosRandomWithWeightRule();
    }

局部配置：修改application.yml

# 被调用的微服务名  当需要使用局部配置的时候推荐使用这种方式
mall-order:
  ribbon:
# 自定义的负载均衡策略（基于随机&权重）
    NFLoadBalancerRuleClassName: NacosRandomWithWeightRule

饥饿加载

在进行服务调用的时候，如果网络情况不好，第一次调用会超时。Ribbon默认懒加载，意味着只有在发起调用的时候才会创建客户端。

ribbon:
  eager-load:
    # 开启ribbon的饥饿加载模式
    enabled: true
    # 指定需要饥饿加载的服务名，也就是你需要调用的服务，如果有多个服务，则用逗号隔开
    clients: mall-order

LoadBalancer介绍：

Spring Cloud LoadBalancer是Spring Cloud官方自己提供的客户端负载均衡器, 用来替代Ribbon。

Spring官方提供了两种客户端都可以使用loadbalancer：

RestTemplate：

RestTemplate是Spring提供的用于访问Rest服务的客户端，RestTemplate提供了多种便捷访问远程Http服务的方法，能够大大提高客户端的编写效率。默认情况下，RestTemplate默认依赖jdk的HTTP连接工具。

WebClient：

WebClient是从Spring WebFlux 5.0版本开始提供的一个非阻塞的基于响应式编程的进行Http请求的客户端工具。它的响应式编程的基于Reactor的。WebClient中提供了标准Http请求方式对应的get、post、put、delete等方法，可以用来发起相应的请求。

RestTemplate整合LoadBalancer：

引入依赖：

<!-- nacos服务注册与发现 -->
        <!--  nacos服务注册与发现 移除ribbon支持 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring‐cloud‐starter‐netflix‐ribbon</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <!-- LoadBalancer -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>

注意： nacos-discovery中引入了ribbon，需要移除ribbon的包如果不移除，也可以在yml中配置不使用ribbon。默认情况下，如果同时拥有RibbonLoadBalancerClient和BlockingLoadBalancerClient，为了保持向后兼容性，将使用RibbonLoadBalancerClient。要覆盖它，可以设置spring.cloud.loadbalancer.ribbon.enabled属性为false。

spring:
  application:
    name: mall-user-loadbalancer-demo  #微服务名称
  #配置nacos注册中心地址
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.3.100:8848,192.168.3.101:8848,192.168.3.102:8848
    # 不使用ribbon，使用loadbalancer
    loadbalancer:
      ribbon:
        enabled: false

使用@LoadBalanced注解修饰RestTemplate，开启客户端负载均衡功能

@Configuration
public class RestConfig {

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

}

使用：

    @RequestMapping(value = "/findOrderByUserId/{id}")
    public R  findOrderByUserId(@PathVariable("id") Integer id) {

        //restTemplate需要添加@LoadBalanced注解
        String url = "http://mall-order/order/findOrderByUserId/"+id;

        return restTemplate.getForObject(url,R.class);
    }

WebClient整合LoadBalancer 

引入依赖：

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>

配置WebClient作为负载均衡器的client：

@Configuration
public class WebClientConfig {

  @LoadBalanced
  @Bean
  WebClient.Builder webClientBuilder() {
    return WebClient.builder();
  }


  @Bean
  WebClient webClient() {
    return webClientBuilder().build();
  }

}

使用：

@Autowired
    private WebClient webClient;

    @Autowired
    private ReactorLoadBalancerExchangeFilterFunction lbFunction;

    @RequestMapping(value = "/findOrderByUserId2/{id}")
    public Mono<R> findOrderByUserIdWithWebClient(@PathVariable("id") Integer id) {

        String url = "http://mall-order/order/findOrderByUserId/"+id;
        //基于WebClient
        return webClient.get().uri(url).retrieve().bodyToMono(R.class);
    }
    
    @RequestMapping(value = "/findOrderByUserId3/{id}")
    public Mono<R> findOrderByUserIdWithWebFlux(@PathVariable("id") Integer id) {

        String url = "http://mall-order/order/findOrderByUserId/"+id;
        //基于WebClient+webFlux
        Mono<R> result = WebClient.builder()
                .filter(lbFunction)
                .build()
                .get()
                .uri(url)
                .retrieve()
                .bodyToMono(R.class);
        return result;
    }

原理： 底层会使用ReactiveLoadBalancer