八、Spring cloud负载均衡（Ribbon）之源码解析-摩杜云开发者社区

涉及到的内容有：

Spring Cloud Netflix Ribbon 核心接口
Netflix Ribbon 自动装配
Netflix Ribbon 配置化组件

（一）Demo构建

1、新建一个工程
三个模块：

user-api：公用API
user-ribbon-client：客户端应用
user-service-provider：服务端应用

2、实现 user-ribbon-client

配置信息
application.properties

#用户 Ribbon 客户端应用
spring.application.name=spring-cloud-user-ribbon-client

#服务端口
server.port=8080

#关闭 Eureka Client，显示地通过配置方式注册 Ribbon 服务地址（未配置 Eureka 时使用）
eureka.client.enabled=false

#服务提供方名称
service.provider-name=user-service-provider
service.provider.host=localhost
service.provider.port=9090

#定义 user-service-provider Ribbon 的服务器地址
#为 RibbonLoadBalancerClient 提供服务列表
user-service-provider.ribbon.listOfServers=http://${service.provider.host}:${service.provider.port}

业务逻辑

/**
 * 用户 Ribbon Controller
 * @author 咸鱼
 * @date 2018/11/11 17:59
 */
@RestController
public class UserRibbonController {
    @Value("${service.provider-name}")
    private String serviceProviderName;
    /**
     * 负载均衡客户端
     */
    private LoadBalancerClient loadBalancerClient;
    @Autowired
    public UserRibbonController(LoadBalancerClient loadBalancerClient) {
        this.loadBalancerClient = loadBalancerClient;
    }
    @GetMapping("/index")
    private String index() throws IOException {
        User user = new User();
        user.setId(1L);
        user.setName("张三");

        //选择指定的 ServiceId
        ServiceInstance serviceInstance = loadBalancerClient.choose(serviceProviderName);
        
        //参数一：ServiceId  参数二：服务实例  参数三：负载均衡请求（这里使用lambda表达式实现）
        return loadBalancerClient.execute(serviceProviderName, serviceInstance, (instance -> {
            //服务器实例，获取 主机名（Host） 和 端口(IP)
            String host = instance.getHost();
            int port = instance.getPort();
            String url = "http://" + host + ":" + port + "/user/save";
            RestTemplate restTemplate = new RestTemplate();

            //参数一：服务提供方url  参数二：请求参数  参数三：返回值的类型
            return restTemplate.postForObject(url, user, String.class);
        }));
    }
}

编写引导类

/**
 * 注解 @RibbonClient：激活 Ribbon
 * @author 咸鱼
 * @date 2018/11/11 18:05
 */
@SpringBootApplication
@RibbonClient("user-service-provider")//指定目标应用名称
public class UserRibbonClientApplication {
    public static void main(String[] args) {
        SpringApplication.run(UserRibbonClientApplication.class, args);
    }
}

3、实现 user-service-provider

配置信息
application.properties

#用户服务提供方应用信息
spring.application.name=user-service-provider

#服务端口
server.port=9090

#关闭 Eureka Client，显示地通过配置方式注册 Ribbon 服务地址（这里只是为了演示效果，一般用 Eureka）
eureka.client.enabled=false

实现 UserService

/**
 * 内存实现{@link UserService}
 * @author 咸鱼
 * @date 2018/11/11 16:39
 */
@Service
public class InMemoryUserServiceImpl implements UserService {
    private Map<Long, User> userMap = new HashMap<>();
    @Override
    public boolean saveUser(User user) {
        return userMap.put(user.getId(), user) == null;
    }

    @Override
    public List<User> findAll() {
        return new ArrayList(userMap.values());
    }
}

实现 Web 服务

/**
 * 用户服务提供方 Controller
 * @author 咸鱼
 * @date 2018/11/12 18:42
 */
@RestController
public class UserServiceProviderController {
    
    private UserService userService;

    @Autowired
    public UserServiceProviderController(UserService userService) {
        this.userService = userService;
    }
    
    @PostMapping("/user/save")
    public boolean user(@RequestBody User user){
        return userService.saveUser(user);
    }
}

编写引导类

/**
 * @author 咸鱼
 * @date 2018/11/12 18:44
 */
@SpringBootApplication
public class UserServiceProviderApplication {
    public static void main(String[] args) {
        SpringApplication.run(UserServiceProviderApplication.class, args);
    }
}

4、分析 Ribbon 调动链路
主要是分析 Ribbon 在负载均衡时如何选择服务器：
LoadBalancerClient（RibbonLoadBalancerClient） ->
ILoadBalancer（ZoneAwareLoadBalancer） ->
IRule（ZoneAvoidanceRule）

5、自定义实现 IRule

因为是客户端类负载均衡，所以该类创建在 user-ribbon-client 模块中。
（1）扩展 AbstractLoadBalancerRule：MyRule

/**
 * 自定义{@link IRule}实现
 * @author 咸鱼
 * @date 2018/11/12 19:03
 */
public class MyRule extends AbstractLoadBalancerRule {
    @Override
    public void initWithNiwsConfig(IClientConfig clientConfig) {

    }

    @Override
    public Server choose(Object key) {
        //获取负载均衡器
        ILoadBalancer loadBalancer = getLoadBalancer();
        
        //获取所有可达服务器列表
        List<Server> servers = loadBalancer.getReachableServers();
        
        if (servers.isEmpty()){
            return null;
        }
        
        //自定义选择服务器的规则
        
        //eg：永远选择最后一台服务器
        Server targetServer = servers.get(servers.size() - 1);
        return targetServer;
    }
}

（2）将 MyRule 暴露成 Bean

通过学习 RibbonClientConfiguration 源码：

@Bean
  @ConditionalOnMissingBean
  public IRule ribbonRule(IClientConfig config) {
    if (this.propertiesFactory.isSet(IRule.class, name)) {
      return this.propertiesFactory.get(IRule.class, config, name);
    }
    ZoneAvoidanceRule rule = new ZoneAvoidanceRule();
    rule.initWithNiwsConfig(config);
    return rule;
  }

由 @ConditionalOnMissingBean 可知，若我们自定义实现 IRule，那么将会覆盖框架默认的 IRule 实现

/**
     * 将 {@link MyRule} 暴露成 {@link Bean}
     * @return {@link MyRule}
     */
    @Bean
    public IRule myRule(){
        return new MyRule();
    }

6、配置化实现组件
组件主要包括：

IClientConfig
IRule
IPing
ServerList<Server>
ServerListFilter<Server>
ILoadBalancer
ServerListUpdater

通过源码学习 PropertiesFactory ：

public PropertiesFactory() {
    classToProperty.put(ILoadBalancer.class, "NFLoadBalancerClassName");
    classToProperty.put(IPing.class, "NFLoadBalancerPingClassName");
    classToProperty.put(IRule.class, "NFLoadBalancerRuleClassName");
    classToProperty.put(ServerList.class, "NIWSServerListClassName");
    classToProperty.put(ServerListFilter.class, "NIWSServerListFilterClassName");
  }

可知 “NFLoadBalancerClassName” 等是可以配置的

（1）自定义 IPing ：MyPing

/**
 * 实现 {@link IPing} 接口：检查对象 /actuator/health 是否正常状态码：200
 * @author 咸鱼
 * @date 2018/11/12 19:51
 */
public class MyPing implements IPing {
    @Override
    public boolean isAlive(Server server) {
        String host = server.getHost();
        int port = server.getPort();
        // /health endpoint
        //通过 Spring 组件实现 URL 拼装
        UriComponentsBuilder builder = UriComponentsBuilder.newInstance();
        builder.scheme("http");
        builder.host(host);
        builder.port(port);
        builder.path("/actuator/health");
        URI uri = builder.build().toUri();

        RestTemplate restTemplate = new RestTemplate();

        //因为getForEntity()方法返回的ResponseEntity<String>对象，含有状态码
        ResponseEntity<String> responseEntity = restTemplate.getForEntity(uri, String.class);

        //当响应状态码等于 200 时，返回 true, 否则返回 false
        return HttpStatus.OK.equals(responseEntity.getStatusCode());
    }
}

（2）暴露 MyPing 为 Bean
方式一：
增加配置 application.properties

#扩展 IPing 实现
user-service-provider.ribbon.NFLoadBalancerPingClassName=org.pc.ping.MyPing

方式二：

/**
     * 将 {@link MyPing} 暴露成 {@link Bean}
     * @return {@link MyPing}
     */
    @Bean
    public MyPing myPing(){
        return new MyPing();
    }

（二）Spring Cloud Netflix Ribbon 核心接口

1、LoadBalancerClient 负载均衡器客户端

（1）主要职责

转化URI：将含应用名称URI转化成具体主机+端口的形式
选择服务实例：通过负载算法，xuanze选择指定服务中的一台机器实例
请求执行回调：针对选择后服务实例，执行具体的请求回调操作

（2）默认实现
RibbonLoadBalancerClient

（3）自动装配源
RibbonAutoConfiguration#loadBalancerClient()

2、LoadBalancerContext 负载均衡上下文

（1）主要职责

转化URI：将含应用名称URI转化成具体主机+端口的形式
组件关联：关联 RetryHandler、ILoadBalancer 等
记录服务统计信息：记录请求响应时间、错误数量等

（2）默认实现
RibbonLoadBalancerContext

（3）自动装配源
RibbonClientConfiguration#ribbonLoadBalancerContext()

3、ILoadBalancer 负载均衡器

（1）主要职责

增加服务器
获取服务器：通过关联 Key 获取、获取所有服务列表、获取可用服务器列表
服务器状态：标记服务器宕机

（2）默认实现
ZoneAwareLoadBalancer

（3）自动装配源
RibbonClientConfiguration#ribbonLoadBalancer()

4、IRule 规则接口

（1）主要职责

选择服务器：根据负载均衡器以及关联 key 获取候选的服务器

（2）默认实现
ZoneAvoidanceRule

（3）自动装配源
RibbonClientConfiguration#ribbonRule()

5、IPing PING 策略

（1）主要职责

活动检测：根据指定服务器，检测其是否活动

（2）默认实现
DummyPing

（3）自动装配源
RibbonClientConfiguration#ribbonPing()

6、ServerList 服务器列表

（1）主要职责

获取初始化服务器列表
获取更新服务器列表

（2）默认实现
ConfigurationBasedServerList 或 DiscoveryEnabledNIWServerList

（3）自动装配源
RibbonClientConfiguration

（三）Netflix Ribbon 自动装配

1、RibbonAutoConfiguration

loadBalancerClient()
propertiesFactory()

2、LoadBalancerAutoConfiguration

@LoadBalanced
RestTemplate