SpringCloud 学习笔记 —— 六、Ribbon：负载均衡(基于客户端)

六、Ribbon：负载均衡(基于客户端)

6.1 负载均衡以及Ribbon

Ribbon是什么？

Spring Cloud Ribbon 是基于Netflix Ribbon 实现的一套++客户端负载均衡的工具++。
简单的说，Ribbon 是 Netflix 发布的开源项目，主要功能是提供客户端的软件负载均衡算法，将 Netflix 的中间层服务连接在一起。Ribbon 的客户端组件提供一系列完整的配置项，如：连接超时、重试等。简单的说，就是在配置文件中列出 LoadBalancer (简称LB：负载均衡) 后面所有的机器，Ribbon 会自动的帮助你基于某种规则 (如简单轮询，随机连接等等) 去连接这些机器。我们也容易使用 Ribbon 实现自定义的负载均衡算法！

Ribbon能干嘛？

LB，即负载均衡 (LoadBalancer) ，在微服务或分布式集群中经常用的一种应用。
负载均衡简单的说就是将用户的请求平摊的分配到多个服务上，从而达到系统的HA (高用)。
常见的负载均衡软件有 Nginx、Lvs 等等。
Dubbo、SpringCloud 中均给我们提供了负载均衡，SpringCloud 的负载均衡算法可以自定义。
负载均衡简单分类：
- 集中式LB
  - 即在服务的提供方和消费方之间使用独立的LB设施，如Nginx(反向代理服务器)，由该设施负责把访问请求通过某种策略转发至服务的提供方！
- 进程式 LB
  - 将LB逻辑集成到消费方，消费方从服务注册中心获知有哪些地址可用，然后自己再从这些地址中选出一个合适的服务器。
  - Ribbon 就属于进程内LB，它只是一个类库，集成于消费方进程，消费方通过它来获取到服务提供方的地址！

6.2 集成Ribbon

springcloud-consumer-dept-80向pom.xml中添加Ribbon和Eureka依赖

xml 复制代码

<!--        Ribbon-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
        </dependency>
<!--        Eureka: Ribbon 需要从 Eureka 服务中心获取什么-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

在application.yml文件中配置Eureka

yml 复制代码

server:
  port: 80
# Eureka 配置
eureka:
  client:
    register-with-eureka: false # 不向 Eureka 注册自己
    service-url: # 从三个注册中心随机去一个去访问
      defaultZone: http://eureka7001.com:7001/eureka/, http://eureka7002.com:7002/eureka/, http://eureka7003.com:7003/eureka/

主启动类加上@EnableEurekaClient注解，开启Eureka

java 复制代码

// Ribbon 和 Eureka 整合以后，客户端可以直接调用，不用关心 IP 地址和端口号
@SpringBootApplication
@EnableEurekaClient // 开启 Eureka 客户端
public class DeptConsumer_80 {
    public static void main(String[] args) {
        SpringApplication.run(DeptConsumer_80.class, args);
    }
}

自定义Spring配置类：ConfigBean.java 配置负载均衡实现RestTemplate

java 复制代码

@Configuration
public class ConfigBean { // @Configuration == spring applicationContext.xml

    @Bean
    @LoadBalanced // 配置负载均衡实现 RestTemplate
    public RestTemplate getRestTemplate(){
        return new RestTemplate();
    }

}

修改conroller：DeptConsumerController.java

java 复制代码

//    Ribbon: 我们这里的地址，应该是一个变量，通过服务名来访问
//    private static final String REST_URL_PREFIX = "http://localhost:8001";
    private static final String REST_URL_PREFIX = "http://SPRINGCLOUD-PROVIDER-DEPT";

6.3 使用Ribbon实现负载均衡

流程图：

0.新建两个数据库 db02, db03

1.新建两个服务提供者Moudle：springcloud-provider-dept-8003、springcloud-provider-dept-8002

2.参照springcloud-provider-dept-8001 依次为另外两个Moudle添加pom.xml依赖、resourece下的mybatis和application.yml配置，Java代码

三个服务名称一致

3.启动所有服务测试(根据自身电脑配置决定启动服务的个数)，访问http://eureka7001.com:7001/ 查看结果：

测试访问http://localhost/consumer/dept/list 这时候随机访问的是服务提供者8001

再次访问http://localhost/consumer/dept/list 这时候随机的是服务提供者8003, F5 --> 8002

以上这种每次访问 http://localhost/consumer/dept/list 随机访问集群中某个服务提供者，这种情况叫做轮询，轮询算法在SpringCloud中可以自定义。

访问http://eureka7001.com/consumer/dept/list或者http://eureka7002.com/consumer/dept/list或者http://eureka7002.com/consumer/dept/list都是同样的效果，即使只启动了一台 Eureka 服务器

如何切换或者自定义规则呢？

在springcloud-provider-dept-80模块下的ConfigBean中进行配置，切换使用不同的规则

java 复制代码

@Configuration
public class ConfigBean {
    //@Configuration -- spring  applicationContext.xml
    /**
     * IRule:
     * RoundRobinRule 轮询策略
     * RandomRule 随机策略
     * AvailabilityFilteringRule ： 会先过滤掉，跳闸，访问故障的服务~，对剩下的进行轮询~
     * RetryRule ： 会先按照轮询获取服务~，如果服务获取失败，则会在指定的时间内进行，重试
     */
    @Bean
    public IRule myRule() {
        return new RandomRule();//使用随机策略
        //return new RoundRobinRule();//使用轮询策略
        //return new AvailabilityFilteringRule();//使用轮询策略
        //return new RetryRule();//使用轮询策略
    }
}

也可以自定义规则，在myRule包下自定义一个配置类MyRule.java，注意：该包不要和主启动类所在的包同级，要跟启动类所在包同级：

警告	`FooConfiguration`必须是`@Configuration`，但请注意，它不在主应用程序上下文的`@ComponentScan`中，否则将由所有`@RibbonClients`共享。如果您使用`@ComponentScan`（或`@SpringBootApplication`），则需要采取措施避免包含（例如将其放在一个单独的，不重叠的包中，或者指定要在`@ComponentScan`）。

即如果在与主启动类同级的包中，定义了与默认提供的负载均衡策略同名，则前者会将后者覆盖掉，而这可能会导致混淆，所以约定避免这么干。

MyRule.java

java 复制代码

@Configuration
public class MyRule {
    /**
     * IRule :
     * 1) RoundRobinRule: 轮询策略
     * 2) RandomRule: 随机策略
     * 3) AvailabilityFilteringRule：过滤掉访问故障的服务，余下服务再轮询
     * 4) RetryRule: 轮询获取服务，如果服务获取失败则会在指定时间内重试
     */
    @Bean
    public IRule myRule(){
        return new RandomRule();
    }
}

报异常：org.springframework.beans.factory.BeanDefinitionStoreException: Invalid bean definition with name 'myRule' defined in com.lin.rule.MyRule: Bean name derived from @Bean method 'myRule' clashes with bean name for containing configuration class; please make those names unique!，

翻译过来就是org.springframework.beans.factory.BeanDefinitionStoreException：com.lin.rule.MyRule 中定义的名称"myRule"的 bean 定义无效：从 @Bean 方法"myRule"派生的 Bean 名称与包含配置类的 bean 名称冲突；请使这些名称独一无二！，

意思是MyRule 类被标记为 @Configuration，并且定义了一个名为 myRule 的 bean 方法。然而，由于 MyRule 类本身也被视为一个 bean，并且默认的 bean 名称是根据类名推断的，所以在这里发生了 bean 名称冲突。

解决方法：

将 MyRule 类的名称修改为与其 bean 方法的名称不同的名称，以确保唯一性。
java 复制代码
@Configuration
public class MyRuleConfiguration {
    @Bean
    public IRule myRule(){
        return new FishRule();
    }
}
如果 MyRule 类的名称不能修改，你可以在 @Configuration 注解中显式指定 bean 的名称。
java 复制代码
@Configuration("myRuleConfiguration")
public class MyRule {
    @Bean
    public IRule myRule(){
        return new FishRule();
    }
}

主启动类开启负载均衡并指定自定义的MyRule配置类

java 复制代码

// Ribbon 和 Eureka 整合以后，客户端可以直接调用，不用关心 IP 地址和端口号
@SpringBootApplication
@EnableEurekaClient // 开启 Eureka 客户端
// 在微服务启动时就能加载自定义的 Ribbon 类（自定义的规则会覆盖原有默认的规则）
@RibbonClient(name = "SPRINGCLOUD-PROVIDER-DEPT", configuration = MyRule.class) // 开启负载均衡，并指定自定义的规则
public class DeptConsumer_80 {
    public static void main(String[] args) {
        SpringApplication.run(DeptConsumer_80.class, args);
    }
}

自定义的规则(这里我们参考Ribbon中默认的规则代码自己稍微改动)：MyRandomRule.java

java 复制代码

public class MyRandomRule extends AbstractLoadBalancerRule {
    /**
     * 每个服务访问5次则换下一个服务(总共3个服务)
     * <p>
     * total=0,默认=0,如果=5,指向下一个服务节点
     * index=0,默认=0,如果total=5,index+1
     */
    private int total = 0;//被调用的次数
    private int currentIndex = 0;//当前是谁在提供服务
    //@edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE")
    public Server choose(ILoadBalancer lb, Object key) {
        if (lb == null) {
            return null;
        }
        Server server = null;
        while (server == null) {
            if (Thread.interrupted()) {
                return null;
            }
            List<Server> upList = lb.getReachableServers();//获得当前活着的服务
            List<Server> allList = lb.getAllServers();//获取所有的服务
            int serverCount = allList.size();
            if (serverCount == 0) {
                /*
                 * No servers. End regardless of pass, because subsequent passes
                 * only get more restrictive.
                 */
                return null;
            }
            //int index = chooseRandomInt(serverCount);//生成区间随机数
            //server = upList.get(index);//从或活着的服务中,随机获取一个
            //=====================自定义代码=========================
            if (total < 5) {
                server = upList.get(currentIndex);
                total++;
            } else {
                total = 0;
                currentIndex++;
                if (currentIndex > upList.size()) {
                    currentIndex = 0;
                }
                server = upList.get(currentIndex);//从活着的服务中,获取指定的服务来进行操作
            }
            //======================================================
            if (server == null) {
                /*
                 * The only time this should happen is if the server list were
                 * somehow trimmed. This is a transient condition. Retry after
                 * yielding.
                 */
                Thread.yield();
                continue;
            }
            if (server.isAlive()) {
                return (server);
            }
            // Shouldn't actually happen.. but must be transient or a bug.
            server = null;
            Thread.yield();
        }
        return server;
    }
    protected int chooseRandomInt(int serverCount) {
        return ThreadLocalRandom.current().nextInt(serverCount);
    }
    @Override
    public Server choose(Object key) {
        return choose(getLoadBalancer(), key);
    }
    @Override
    public void initWithNiwsConfig(IClientConfig clientConfig) {
        // TODO Auto-generated method stub
    }
}

参考

【狂神说Java】SpringCloud最新教程IDEA版