Spring Cloud：使用Ribbon实现负载均衡详解（下）

为了保证篇幅，在引用源码时，会将不必须的包名和注释删除

自定义 Ribbon 负载均衡策略

前面讲了如何使用Ribbon以及其内置的几种负载均衡策略(IRULE).
通常情况下，内置的负载均衡策略已经能满足我们的需要，但是为解决某些特殊情况就需要我们自定义负载均衡策略。

下面来简单实现一下自定义策略

1. 继承AbstractLoadBalancerRule

通过前面的讲解中，可以得出AbstractLoadBalancerRule实现了IRule 中的 setLoadBalancer 和 getLoadBalancer，通过继承 AbstractLoadBalancerRule 我们就不需要在自己实现这两个方法，而是把关注点放在choose方法上，即只关注如何进行服务的负载上

**回顾一下**`IRule.java`

public interface IRule{
    /*
     * choose one alive server from lb.allServers or
     * lb.upServers according to key
     * 
     * @return choosen Server object. NULL is returned if none
     *  server is available 
     */
    public Server choose(Object key);
    
    public void setLoadBalancer(ILoadBalancer lb);
    
    public ILoadBalancer getLoadBalancer();    
}

回顾一下AbstractLoadBalancerRule.java

public abstract class AbstractLoadBalancerRule implements IRule, IClientConfigAware {

    private ILoadBalancer lb;
        
    @Override
    public void setLoadBalancer(ILoadBalancer lb){
        this.lb = lb;
    }
    
    @Override
    public ILoadBalancer getLoadBalancer(){
        return lb;
    }      
}

2. 重写 choose 方法

这里实现一个简单的规则，取可用服务的第一个

public class CustomRule extends AbstractLoadBalancerRule {
    @Override
    public void initWithNiwsConfig(IClientConfig iClientConfig) {}

    @Override
    public Server choose(Object o) {
        ILoadBalancer lb = getLoadBalancer();
        if (lb == null) {
            return null;
        }
        // 通过 ILoadBalancer 获取可用的服务列表
        List<Server> reachableServers = lb.getReachableServers();
        if (CollectionUtils.isEmpty(reachableServers)) {
            return null;
        }
        return reachableServers.get(0);
    }
}

使用

针对某个服务使用

1. 主启动类处理
   在启动类上加上 @RibbonClient(name = "server-name", configuration = CustomRule.class)

2. 修改配置文件

<clientName>.ribbon.NFLoadBalancerRuleClassName: <className>

其中clientName 为具体的服务名称，className 为实现IRule接口的全类名
例如

users:
  ribbon:
    NFLoadBalancerRuleClassName: com.zyndev.demo.config.CustomRule

针对全部应用

1. 使用默认配置
   在启动类上 @RibbonClients(defaultConfiguration = DefaultRibbonConfig.class)

@Configuration
class DefaultRibbonConfig {

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

经测试即使不在启动类上加`RibbonClients`注解，对于全局配置也是有效的

解决实际问题

在Spring Cloud的日常开发中，经常会遇到环境问题，例如开发人员A在本地自测的时候，将自己的开发ProjectA项目的dev/a分支注册到了开发统一使用的consul上，另一个开发B将开发ProjectA项目的dev/b分支的注册到了开发统一使用的consul上，这是就会出现不同的配置的不同逻辑的相同项目注册到同一个consul,在测试时候出现莫名其妙的错误，同时开发一个项目的人数越多，问题愈加明显，这时如果每个开发人员都在自己环境中搭建一整套环境是不现实的，同时大部分开发人员的笔记本也是不允许的，这是是否可以通过自定义负载均衡策略实现呢？

无论在使用eureka还是consul时，在配置时都提供了元数据的功能，在eureka是metadata,在 consul 是 tags, 下面已consul 为例进行试验

假设项目名为 ms-user-server, 环境为 dev, dev2, dev3(这里可以换成要测试的分支名称)，通过在配置consul时加上tags: profile=${spring.profiles.active} 来保证，服务在注册时候带上我们需要的元数据

1. 配置文件

spring:
  application:
    name: ms-user-server
  profiles:
    active: dev
  cloud:
    consul:
      discovery:
        enabled: true
        instanceId: ${spring.application.name}:${server.port}
        healthCheckInterval: 15s
        serviceName: ${spring.application.name}
        prefer-ip-address: true
        health-check-timeout: 10s
        tags: profile=${spring.profiles.active}

分别启动 dev, dev2 如下

2. 编写策略

public class CustomRule extends AbstractLoadBalancerRule {
	// 获取对应tag的profile，这里可以使用其他属性定义
    @Value("${spring.profiles.active}")
    private String profiles;

    @Override
    public void initWithNiwsConfig(IClientConfig iClientConfig) {}

    @Override
    public Server choose(Object o) {
        ILoadBalancer lb = getLoadBalancer();
        if (lb == null) {
            return null;
        }
        List<Server> reachableServers = lb.getReachableServers();
        if (CollectionUtils.isEmpty(reachableServers)) {
            return null;
        }
        // 找到与 profile 相同的数据，这里的metadata即为tags的数据
        List<Server> serverList = reachableServers.stream().filter(server -> {
        	// 因为这里使用 consul,所以可以直接进行强转
        	// 如果使用的eureka,需要转换成对应的EurekaServer
            ConsulServer consulServer = (ConsulServer) server;
            Map<String, String> metadata = consulServer.getMetadata();
            return profiles.equals(metadata.get("profile"));
        }).collect(Collectors.toList());
        if (CollectionUtils.isEmpty(serverList)) {
            return null;
        }
        // 这里对可用的serverList进行了重新随机排序
        Collections.shuffle(serverList);
        return serverList.get(0);
    }
}

通过使用元数据+自定义负载策略的方式在不增加硬件成本的前提下实现逻辑上的环境隔离，更加灵活的进行开发测试

参考

• https://cloud.spring.io/spring-cloud-netflix/multi/multi_spring-cloud-ribbon.html