Spring Cloud-04使用Ribbon实现客户端负载均衡

概述

Spring Cloud-03将微服务注册到Eureka Server上 + 为Eureka Server添加用户认证中遗留的问题还记得吧 ,对,服务消费者调用服务提供者是硬编码的方式,虽然把地址配置到了application.yml中,但是一旦服务端的地址发生改变,那肯定是要修改配置文件的。

如何解决呢? Spring Cloud整合了Ribbon.

Ribbon是Nextflix发布的负载均衡器,为Ribbon配置服务提供者地址后,Ribbon就可以基于某种负载均衡的算法,自动帮助服务消费者请求。

Ribbon支持轮询、随机等负载均衡算法,当然也支持实现自定义的负载均衡算法。

在Spring Cloud中,当Ribbon和Eureka配合使用时,Ribbon可自动从Eureka Server获取服务提供者的地址列表,并基于某种负载均衡算法,请求其中一个服务提供者实例。

Spring Cloud-04使用Ribbon实现客户端负载均衡


Ribbon演示

服务提供者微服务改造为使用MySql数据库

当然了,这一步不是必须的。

Step1 修改pom.xml增加mysql的依赖

<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
</dependency>

Step2: applicaiton.yml中关于数据库的部分调整为

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/artisan?useUnicode=true&characterEncoding=utf-8&useSSL=true
    username: root
    password: root
    driver-class-name: com.mysql.jdbc.Driver

新建服务消费者微服务,配置Ribbon

Step1: 为了方便,我们复制下micorservice-consumer-movie,修改为micorservice-consumer-movie-ribbon
Spring Cloud-04使用Ribbon实现客户端负载均衡


Step2: pom.xml引入ribbon依赖

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

Step3: 为RestTemplate添加@LoadBalanced注解

Spring Cloud-04使用Ribbon实现客户端负载均衡

只需要为RestTemplate添加@LoadBalanced注解,就可以为RestTemlate整合Ribbon,使其具备负载均衡的能力


Step4: 修改Controller层代码,将地址调整为注册在Eureka上的虚拟主机名

package com.artisan.microservice.controller;

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;

import com.artisan.microservice.model.User;

import lombok.extern.slf4j.Slf4j;


@RestController
@Slf4j
public class MovieController {
 
  @Autowired
  private RestTemplate restTemplate;

  
  @Autowired
  LoadBalancerClient loadBalancerClient;
  
  @GetMapping("/movie/{id}")
  public User findById(@PathVariable Long id) {
	 // 调用注册在Eureka上的服务端的地址
    return this.restTemplate.getForObject("http://microservice-provider-user/user/" + id, User.class);
  }
  
  @GetMapping("/callProvider")
  public String callUserInstance() {
	  ServiceInstance serviceInstance = this.loadBalancerClient.choose("microservice-provider-user");
	  // 打印当前选择的哪个节点
	  log.info("serviceId: {} , host: {} ,port: {} ,uri: {}" ,serviceInstance.getServiceId() , serviceInstance.getHost(), serviceInstance.getPort(),serviceInstance.getUri());
	  return serviceInstance.getUri().toString();
  }  
}

我们把地址修改为了http://microservice-provider-user/user , 其中
microservice-provider-user用户微服务的虚拟主机名,是注册在Eureka Server上的名字,也是服务提供者微服务的配置文件中配置的spring.application.nameSpring Cloud-04使用Ribbon实现客户端负载均衡
当Ribbon和Eureka同时使用时,会自动将虚拟主机名映射为微服务的网络地址。

同时为了更加直观的获取当前选择的用户微服务节点,我们新增加了个方法callProvider,待会测试就可以看到效果了。


Step5: 验证Ribbon提供的能力

1.启动Eureka Server
2.启动两个 microservice-provider-user实例 。(在STS中启动一个后,修改下application.yml的端口,再次run as spring boot app 即可启动第二个实例,以此类推)
3.启动microservice-provider-movie-ribbon
4.访问Eureka Server的页面,查看是否注册成功

http://localhost:8761/login

Spring Cloud-04使用Ribbon实现客户端负载均衡

登录后,可以看到2个服务提供者,1个服务消费者都成功的注册到了Eureka Server上。
Spring Cloud-04使用Ribbon实现客户端负载均衡

我们在服务消费者微服务,调用的地址为
Spring Cloud-04使用Ribbon实现客户端负载均衡,对应两个服务提供者的地址。

同时我们在服务消费者微服务工程中,为RestTemplate标注了@LoadBalanced注解,所以会使用Ribbon的负载均衡算法来分发到不同的服务提供者地址

多次访问 http://localhost:7902/movie/1 ,观察控制台每个节点的日志输出情况。

同时访问http://localhost:7902/callProvider

Spring Cloud-04使用Ribbon实现客户端负载均衡
Spring Cloud-04使用Ribbon实现客户端负载均衡


注意事项

  1. 默认情况下,虚拟主机名和服务名称是一致的,也可以通过eureka.instance.virtual-host-name或者eureka.instance.secure-virtual-host-name指定虚拟主机名

  2. 不能将restTemplate.getForObject()和loadBalancerClient写在同一个方法中,两者会冲突,因为RestTemplate实际上是一个Ribbon客户端,本身已经包含了choose的行为

  3. 虚拟主机名不能包含"_"之类的字符,否则Ribbon再调用的时候会抛出异常


源码

https://github.com/yangshangwei/SpringCloudMaster