Ribbon 学习(一)：脱离 Eureka 使用 Ribbon

快来打我* 2022-11-27 12:28 302阅读 0赞

# 说明 #

在之前的博文中，我介绍了OpenFeign 的使用及 Spring Cloud 集成 OpenFeign 后的使用和配置原理，并没有涉及到其他如负载均衡，服务降级等内容。在本篇博文中，我将简单介绍 Ribbon 的使用方式，通常 Ribbon 的使用都是在 Spring Cloud 体系中通过 Spring Cloud OpenFeign 集成 Ribbon 和 Eureka，实现了服务发现和负载均衡的无感使用。本篇博文将脱离 Eureka，手动配置服务列表来演示 Ribbon 的简单使用。

# 正文 #

## 引入依赖 ##

创建 web 服务，引入以下依赖：

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

## @LoadBalanced 注解 ##

这里使用 Spring 自带的 RestTemplaate 进行请求，创建 RestTemplate 并使用 @LoadBalanced 注解，告诉 Spring Cloud 我们需要进行负载均衡：

@LoadBalanced
    @Bean
    RestTemplate getRestTemplate() {
    	return new RestTemplate();
    }

## 创建 RibbonClient 及配置 ##

### RibbonClient ###

创建 Controller，使用 @RibbonClient 注解，在注解中指定 name 参数值，配置 RibbonClient 的名称，并且通过指定 configuration 参数值来进行自定配置：

@RestController
    @RibbonClient(name = "test-server", configuration = RibbonConfiguration.class)
    public class HelloClient {
    
        @Autowired
        RestTemplate restTemplate;
    
        @RequestMapping("/hello/{name}")
        public String hello(@PathVariable(name = "name") String name) {
            return this.restTemplate.getForObject("http://test-server/hello/" + name, String.class);
        }
    }

在以上代码中，我指定该 client 的名称为 test-server, 并指定了自定义配置类 RibbonConfiguration.class。通过之前创建配置的 RestTemplate 来请求 http://test-server/hello/。

### 自定义配置类 ###

在 @RabbionClient 注解中，通过 configuration 可以为某个 Client 进行配置，也可以在 @RibbonClients 注解中，通过 defaultConfiguration 为所有的 client 设置默认配置。

public class RibbonConfiguration {
    
        @Autowired
        IClientConfig ribbonClientConfig;
    
        @Bean
        public IPing ribbonPing(IClientConfig clientConfig) {
            return new PingUrl();
        }
    
        @Bean
        public IRule ribbonRule(IClientConfig clientConfig) {
            return new AvailabilityFilteringRule();
        }
    }

在以上代码中，我为名为 test-server 的 RibbonClient 配置了 IPing 和 IRule。**注意，虽然是配置类，但是并没有使用 @Configuration 注解，如果使用了 @Configuration 注解，并且该类可以被启动类的 @ComponentScan 扫描到，那么该配置类就会作为所有 RibbonClients 的默认配置。**

在该类中，注入 IClientConfig，配置了 PingUrl 和 AvailabilityFilteringRule，我们可以简单了解下这些类的作用，在之后文章中会进行详细说明。

*  IClientConfig 为一个 client 或 load balancer 存储对应的配置，默认实现类为 DefaultClientConfigImpl。
 *  IPing 使用该类对服务进行状态检测，默认配置为 DummyPing。
 *  IRule 该类指定了负载均衡的策略，默认配置为 ZoneAvoidanceRule。

这里使用 PingUrl 替换 DummyPing，该类会进行真实 ping 检测，使用 AvailabilityFilteringRule 替换 ZoneAvoidanceRule，该策略会根据服务的状态，主动剔除故障服务地址进行负载均衡，主要是使用 Ribbon 内置的断路器来过滤处于 open-circuit 状态的服务器。

## 配置服务地址列表 ##

spring:
      application:
        name: ribbon-test
    
    server:
      port: 8080
    
    test-server:
      ribbon:
        eureka:
          enabled: false
        listOfServers: localhost:8088,localhost:8083
        ServerListRefreshInterval: 5000
    
    logging:
      level:
        com.netflix.loadbalancer.BaseLoadBalancer: debug

在 application.yml 配置文件中，对 test-server 进行了配置，因为是在脱离 Eureka 的情况下使用 Ribbon，需要将 ribbon.eureka.enabled 值设置为false，同时通过 listOfServers 配置服务地址，通过 ServerListRefreshInterval 指定多长时间间隔刷新服务地址列表，单位为 ms。

在配置文件中，也可以为 RibbonClient 配置 IRule IPing 等属性值：

test-server:
      ribbon:
        NFLoadBalancerRuleClassName: com.netflix.loadbalancer.AvailabilityFilteringRule
        NFLoadBalancerPingClassName: com.netflix.loadbalancer.PingUrl

**在配置文件中配置的属性值优先级高于在 @RibbonClient 配置值和 Spring Cloud Netflix 提供的默认值。**

## 测试 ##

启动两个 web 服务，端口分别为 8088 和 8083，创建测试用的接口，注意这里要创建检测用的接口，否则在使用时会报空指针异常。

检测接口

@RequestMapping("/")
    public String monitor() {
        return "ok";
    }

启动 ribbon 服务后，访问 http://localhost:8080/hello/tom 可以看到两个服务进行轮询负载  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70_pic_center]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70_pic_center 1]

并且在关停一个服务后，经过几次失败，调用会一直负载到正常的服务，这就是 AvailabilityFilteringRule 的作用。

同时，通过 Debug 日志，可以看到 PingUrl 在定时检测服务状态  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70_pic_center 2]

## 总结 ##

在不使用 Eureka 的情况下，使用 @LoadBalanced 标注的 RestTemplate, 使用 @RabbionClient 创建 RibbonClient，并通过配置文件配置的服务器列表，我们可以实现服务的负载均衡，同时通过 @RabbionClient 注解的 configuration ，我们可以为不同的 Client 进行自定义配置，配置不同 IPing，IRule 服务的负载功能也会随之发生变化。

至此，Ribbon 在脱离 Eureka 时的简单使用已经介绍完毕，接下来我将通过源码来解析 Spring Cloud 是如何自动装配 Ribbon，通过 @LoadBalanced  
标注的 RestTemplate 发出的请求为什么能实现负载。

## 参考资料 ##

https://cloud.spring.io/spring-cloud-netflix/multi/multi\_spring-cloud-ribbon.html

https://spring.io/guides/gs/client-side-load-balancing/

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70_pic_center]: /images/20221124/cc86272841e84f40b4fad0552a12d44e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221124/643d1b012c014eb2b21ee548c0168cfc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221124/85974c19e5c64e2e89aa4bee2569fed3.png