🌥️SpringCloud实战-客户端负载均衡之Ribbon

客户端负载均衡组件之Ribbon。

`Ribbon`整体架构

Ribbon是Netflix开源的客户端负载均衡组件，基于HTTP和TCP。Spring Cloud Ribbon基于Ribbon实现，提供轮询、随机等负载均衡策略进行服务调用，也可自定义负载均衡算法。配合Eureka Server使用时的架构图如下：

eureka-ribbon-architecture

使用了Ribbon的Eureka Client服务消费者在发送请求之前，会从Eureka Server注册中心获取服务提供者列表，然后按照配置的负载均衡策略去发起请求，从而实现客户端的负载均衡。

Ribbon本身也会维护一份服务提供者地址列表。如果它发现服务提供者不可用，则会重新从Eureka Server注册中心获取有效的服务提供者地址列表进行更新。

为服务消费者配置`Ribbon`

在IDEA中创建一个名叫ribbon的maven工程，然后在pom.xml中引入以下依赖：

<!-- version -->
<properties>
    <spring.boot.version>2.2.0.RELEASE</spring.boot.version>
    <spring.cloud.version>Hoxton.SR1</spring.cloud.version>
</properties>

<!-- 预定义依赖 -->
<dependencyManagement>
    <dependencies>
        <!-- spring boot -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring.boot.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <!-- spring cloud -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring.cloud.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <!-- eureka-client依赖引入，其中包含了ribbon依赖 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <scope>provided</scope>
    </dependency>
</dependencies>

由于spring-cloud-starter-netflix-eureka-client依赖中已经包含了spring-cloud-starter-netflix-ribbon依赖，所以无需单独引入。

在src/main/resources目录下创建application.yml配置文件，并添加以下配置项：

server:
  port: 9003
spring:
  application:
    name: ribbon-service-consumer
eureka:
  client:
    service-url:
      defaultZone: http://localhost:520/eureka/,http://localhost:521/eureka/

编写启动类RibbonApplication：

package com.sunchaser.sparrow.microservice.springcloud.netflix.ribbon;

import org.springframework.boot.WebApplicationType;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

/**
 * @author sunchaser admin@lilu.org.cn
 * @since JDK8 2021/2/8
 */
@SpringBootApplication
public class RibbonApplication {
    public static void main(String[] args) {
        new SpringApplicationBuilder(RibbonApplication.class)
                .web(WebApplicationType.SERVLET)
                .run(args);
    }

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

与eureka-client-service-consumer微服务相比，我们只需要在RestTemplate上加入@LoadBalanced注解即可开启ribbon的客户端负载均衡功能。

下面我们使用带有负载均衡功能的RestTemplate来消费eureka-client-service-provider提供的服务：

package com.sunchaser.sparrow.microservice.springcloud.netflix.ribbon.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.loadbalancer.LoadBalancerClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

/**
 * @author sunchaser admin@lilu.org.cn
 * @since JDK8 2021/2/6
 */
@RestController
@Slf4j
public class ConsumerController {

    @Autowired
    private RestTemplate restTemplate;

    @Autowired
    private LoadBalancerClient loadBalancerClient;

    @GetMapping("/consumer/{id}")
    public String consume(@PathVariable String id) {
        return restTemplate.getForObject("http://eureka-client-service-provider/provider?id=" + id, String.class);
    }

    @GetMapping("/print/provider/instance")
    public String getProviderInstanceList() {
        ServiceInstance serviceInstance = this.loadBalancerClient.choose("eureka-client-service-provider");
        log.info("service instance:{}", serviceInstance);
        return serviceInstance.toString();
    }
}

运行启动类RibbonApplication，即可将该服务消费者注册至注册中心。

由于我们在consume方法中将http请求的地址指定为了http://eureka-client-service-provider，这意味着我们要将服务提供者的虚拟主机名改为eureka-client-service-provider，当Ribbon和Eureka配合使用时，会自动将虚拟主机名映射成微服务的网络地址。

修改eureka-client-provider微服务的src/main/resources/application.yml文件，添加以下配置项：