SpringCloud学习笔记(四)----服务调用Ribbon、OpenFeign

Ribbon负载均衡服务调用

Ribbon概述

1.是什么

SpringCloudRibbon是基于Netflix Ribbon实现的一套客户端负载均衡的工具。
简单的说，Ribbon是Netflix发布的开源项目，主要功能是提供客户端的软件负载均衡算法和服务调用。Ribbon客户端组件提供一系列完善的配置项如连接超时，重试等。简单的说，就是在配置文件中列出Load Balancer(简称LB)后面所有的机器，Ribbon会自动的帮助你基于某种规则(如简单轮询，随机连接等)去连接这些机器。可以很容易使用Ribbon实现自定义的负载均衡算法。

2.能干嘛

LB(负载均衡)

1.LB负载均衡(Load Balance)是什么
简单的说就是将用户的请求平摊的分配到多个服务上，从而达到系统的HA(高可用)。
常见的负载均衡有软件Nginx、LVS、硬件F5等。

2.Ribbon本地负载均衡客户端VS Nginx服务端负载均衡区别

Nginx是服务器负载均衡，客户端所有请求都会交给nginx，然后由nginx实现转发请求。即负载均衡是由服务端实现的。

Ribbon本地负载均衡，在调用微服务接口时候，会在注册中心上获取注册信息服务列表之后缓存到JVM本地，从而在本地实现RPC远程服务调用技术。

集中式LB

即在服务的消费方和提供方之间使用独立的LB设施(可以是硬件，如F5，也可以是软件，如nginx)，由该设施负责把访问请求通过某种策略转发至服务的提供方。

进程内LB

将LB逻辑集成到消费方，消费方从服务注册中心获知有哪些地址可用，然后自己再从这些地址中选择出一个合适的服务器。
Ribbon就属于进程内LB，它只是一个类库，集成于消费方进程，消费方通过它来获取服务提供方的地址。

总结一句话来说就是：负载均衡+RestTemplate调用

Ribbon负载均衡演示

1.架构说明

Ribbon在工作时分成两步:

1. 第一步先选择EurekaServer，它优先选择在同一个区域内负载较少的server。
2. 第二步再根据用户指定的策略，在从server取到的服务注册列表中选择一个地址。
3. 其中Ribbon提供了多种策略：比如轮询、随机和根据响应时间加权。

总结：Ribbon其实就是一个软负载均衡的客户端组件，它可以和其他所需请求的客户端结合使用，和eureka结合只是其中的一个实例。

POM

RestTemplate的使用

get/postForObject 和 get/postForEntity的使用

在消费者80模块 controller中编写代码如下:

@RestController
@Slf4j
public class OrderController {
     

//    public  static  final String PAYMENT_URL="http://localhost:8001";
    public  static  final String PAYMENT_URL="http://CLOUD-PAYMENT-SERVICE";

    @Autowired
    private RestTemplate restTemplate;

    @GetMapping("/consumer/payment/create")
    public CommonResult<Payment> create(Payment payment){
     
        //参数1：支付模块的请求地址
        //参数2: 传给支付模块的参数
        //参数3：返回给客户端消费者的结果 是个.class字节码文件
        return  restTemplate.postForObject(PAYMENT_URL+"/payment/create",payment,CommonResult.class);
    }


    @GetMapping("/consumer/payment/get/{id}")
    public  CommonResult<Payment> getPayment(@PathVariable("id") Long id){
     
        //参数1：支付模块的请求地址
        //参数2：返回给客户端消费者的结果 是个.class字节码文件
        return  restTemplate.getForObject(PAYMENT_URL+"/payment/get/"+id,CommonResult.class);
    }


    @GetMapping("/consumer/payment/ForEntity/{id}")
    public  CommonResult<Payment> getForEntity(@PathVariable("id") Long id){
     
        ResponseEntity<CommonResult> entity = restTemplate.getForEntity(PAYMENT_URL+"/payment/get/"+id,CommonResult.class);
        if(entity.getStatusCode().is2xxSuccessful()){
     
            return  entity.getBody();
        }else{
     
            return  new CommonResult(444,"操作失败");
        }
    }
}

测试：可以发现Ribbion通过轮询的策略，负载均衡到每一台服务器上。

get/postForObject和 get/postForEntity的区别

• get/postForObject：返回对象为响应体中数据转化成的对象，基本上可以理解为Json
• get/postForEntity：返回对象为ResponseEntity对象，包含了响应中的一些重要信息，比如响应头、响应状态码、响应体等。

Ribbon核心组件IRule

IRule：根据特定算法从服务列表中选取一个要访问的服务。有如下七种算法:

1. com.netflix.loadbalancer.RoundRobinRule：轮询
2. com.netflix.loadbalancer.RandomRule：随机
3. com.netflix.loadbalancer.RetryRule：先按照RoundRobinRule的策略获取服务，如果获取服务失败则在指定时间内会进行重试。
4. WeightedResponseTimeRule ：对RoundRobinRule的扩展，响应速度越快的实例选择权重越大，越容易被选择。
5. BestAvailableRule ：会先过滤掉由于多次访问故障而处于断路器跳匝状态的服务，然后选择一个并发量最小的服务。
6. AvailabilityFilteringRule ：先过滤掉故障实例，再选择并发较小的实例。
7. ZoneAvoidanceRule：默认规则，复合判断server所在区域的性能和server的可用性选择服务器。

替换算法

注意配置细节

官方文档明确给出了警告：
这个自定义配置类不能放在@ComponentScan所扫描的当前包下以及子包下，否则我们自定义的这个配置类就会被所有的Ribbon客户端所共享，达不到特殊化定制的目的了。

总结一句话说，不能和主启动类在同一个包下。 目录结构如下:

新建MySelfRule规则类

@Configuration
public class MySelfRule {
     

    @Bean
    public IRule myRule(){
     
        return  new RandomRule(); //定义为随机
    }
}

主启动类添加@RibbonClient

@SpringBootApplication
@EnableEurekaClient
//name是服务注册中心提供者的名字，configuration是定义Ribbon负载均衡策略配置类
@RibbonClient(name = "CLOUD-PAYMENT-SERVICE",configuration = MySelfRule.class)
public class OrderMain80 {
     
    public static void main(String[] args) {
     
        SpringApplication.run(OrderMain80.class,args);
    }
}

Ribbon负载均衡算法

原理

负载均衡算法：rest接口第几次请求数%服务器集群总数量 = 实际调用服务器位置下标，每次服务重启动后rest接口技术从1开始。

可以通过下列代码，获取集群的列表，是一个List集合

List<ServiceInstance> instances = discoveryClient.getInstances("CLOUD-PAYMENT-SERVICE");

如： List[0] instances = 127.0.0.1:8002
	 List[1] instances = 127.0.0.1:8001

8001+8002组合成为集群，它们共计2台机器，集群总数为2，按照轮询算法原理：

• 当总请求数为1时：1%2=1 对应下标位置为1，则获得服务地址为127.0.0.1:8001
• 当总请求数为2时：2%2=0 对应下标位置为0，则获得服务地址为127.0.0.1:8002
• 当总请求数为3时：3%2=1 对应下标位置为1，则获得服务地址为127.0.0.1:8001
• 当总请求数为4时：4%2=0 对应下标位置为0，则获得服务地址为127.0.0.1:8002
• 如此类推…

手写一个负载的算法

CAS+自旋锁

1.7001/7002集群启动
2.在8001/8002controller加上下面这行代码

 @GetMapping(value = "/payment/lb")
    public String getPaymentLB(){
     
        return serverPort;
    }

3.80订单服务改造
3.1在ApplicationContextBean去掉@LoadBalanced

  @Bean
//    @LoadBalanced //使用@LoadBalanced注解赋予RestTemplate负载均衡的能力
    public RestTemplate getRestTemplate(){
     
        return  new RestTemplate();
    }

3.2编写LoadBalancer接口

public interface LoadBalancer {
     

    //收集服务器总共有多少台能够提供服务的集群，并放到List里面
    ServiceInstance instance(List<ServiceInstance> serviceInstances);
}

3.3编写接口的实现类MyLB

@Component
public class MyLB implements LoadBalancer {
     
    private AtomicInteger atomicInteger = new AtomicInteger(0);

    //下标
    private  final int getAndIncrement(){
     
        int current;
        int next;
        do {
     
            current = this.atomicInteger.get();
            next = current >= 2147483647 ?0:current+1;
        }while (!this.atomicInteger.compareAndSet(current,next));
        System.out.println("第几次访问，次数next："+next);
        return  next;
    }

    @Override
    public ServiceInstance instance(List<ServiceInstance> serviceInstances) {
      //得到机器的列表
        int index = getAndIncrement()%serviceInstances.size();  //得到服务器的下标位置
        return serviceInstances.get(index);
    }
}

3.4OrderController类中添加

 	@Autowired
    private RestTemplate restTemplate;

    @Autowired
    private LoadBalancer loadBalancer;

    @Autowired
    private DiscoveryClient discoveryClient;
    
  	@GetMapping(value = "/consumer/payment/lb")
    public  String getPaymentLB(){
     
        List<ServiceInstance> instances = discoveryClient.getInstances("CLOUD-PAYMENT-SERVICE");
        //如果获取的机器列表为空，或者数量小于0 直接返回null
        if(instances==null || instances.size()<=0){
     
            return  null;
        }
        //自定义的轮询算法，获取处理的机器
        ServiceInstance serviceInstance = loadBalancer.instance(instances);
        URI uri = serviceInstance.getUri();
        return  restTemplate.getForObject(uri+"/payment/lb",String.class);
    }

测试：可以发现，每刷新一次都是在轮询调用的服务提供者。,并且访问的次数在不断的增加，如下图所示：

OpenFeign服务接口调用

概述

OpenFeign是什么

Feign是一个声明式WebService客户端。使用Feign能让编写Web Service客户端更加简单。 它的使用方法是定义一个服务接口然后在上面添加注解。Feign也支持可拔插式的编码器和解码器。SpringCloud 对Fegin进行了封装，使其支持了SpringMVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。

总结来说:Feign是一个声明式的web服务客户端，让编写web服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可。

能干嘛

Feign使用编写Java Http客户端变得更容易。
前面在使用Ribbon+RestTemplate时，利用RestTemplate对http请求的封装处理，形成了一套模板化的调用方法。但在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端来包装这些依赖服务的调用。所以，Fegin在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解，现在是一个微服务接口上面标注一个Feign注解即可) ，即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。

Feign集成了Ribbon
利用Ribbon维护了Payment的服务列表信息，并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是，通过feign只需要定义服务绑定接口且以声明式的方法，优雅而简单的实现了服务调用。

就是A要调用B,Feign就是在A中创建一个一模一样的B对外提供服务的的接口,我们调用这个接口,就可以服务到B。

Feign和OpenFeign的区别

OpenFeign使用步骤

使用接口+注解的方式：微服务调用接口+@FeignClient

1.新建cloud-consumer-feign-order80

Feign在消费端使用。

2.POM.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>cloud123</artifactId>
        <groupId>com.atguigu.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-consumer-feign-order80</artifactId>

    <!--openfeign-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>com.atguigu.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${
     project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

3.application.yml

server:
  port: 80
eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka

4.主启动类

在主启动类上加@EnableFeignClients注解

@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain80 {
     
    public static void main(String[] args) {
     
        SpringApplication.run(OrderFeignMain80.class,args);
    }
}

5.业务类

业务逻辑接口+@FeignClient配置调用provider服务。

5.1PaymentFeignService接口

@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE") //对应注册在Eureka 服务名称
public interface PaymentFeignService {
     

    @GetMapping(value = "/payment/get/{id}") //对应服务提供者controller层的方法
    CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
}

5.2controller

@RestController
public class OrderFeignController {
     

    @Autowired
    private PaymentFeignService paymentFeignService;

    @GetMapping(value = "/consumer/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
     
        return  paymentFeignService.getPaymentById(id);
    }
}

测试： 访问http://localhost/consumer/payment/get/31，可以发现Feign自带负载均衡配置项。

OpenFeign超时控制

超时设置，故意设置超时演示出错情况

1.服务提供方8001故意写暂停程序
在controller添加下列代码

@GetMapping(value = "/payment/feign/timeout")
    public  String paymentFeignTimeout(){
     
        try {
     
            TimeUnit.SECONDS.sleep(3);
        }catch (Exception e){
     

        }
        return  serverPort;
    }

2.服务消费方80PaymentFeignService接口中添加添加超时方法

@GetMapping(value = "/payment/feign/timeout")
    public String paymentFeignTimeout();

3.服务消费方80OrderFeignController中添加超时方法

@GetMapping(value = "/consumer/payment/feign/timeout")
    public String paymentFeignTimeout(){
     
        return paymentFeignService.paymentFeignTimeout();
    }

运行结果如下图所示:

OpenFeign默认等待一秒钟，超过后就会报错。

默认Feign客户端只等待一秒钟，但是服务端处理需要超过1秒钟，导致Feign客户端不想等待了，直接返回报错。为了避免这样的情况，我们可以设置设置Feign客户端的超时控制。

4.80模块中YML文件里开启OpenFeign客户端超时控制

#设置feign客户端超时时间(OpenFeign默认支持ribbon)
ribbon:
#指的是建立连接所用的时间，适用于网络状况正常的情况下，两端连接所用的时间
  ReadTimeout:  5000
  #指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

OpenFeign日志打印功能

Feign提供了日志打印功能，我们可以通过配置来调子日志级别，从而了解Feign中Http请求的细节。
说白了就是对Feign接口的调用情况进行监控和输出。

日志级别

• NONE：默认的，不显示任何日志。
• BASIC：仅记录请求方法、URL、响应状态码及执行时间；
• HEADERS：除了BASIC中定义的信息之外，还有请求和响应的头信息。
• FULL：除了HEADERS中定义的信息之外，还有请求和响应的正文及元数据。

配置日志bean

再80模块创建FeignConfig.java

@Configuration
public class FeignConfig {
     
    @Bean
    Logger.Level feignLoggerLever(){
     
        return  Logger.Level.FULL;
    }
}

YML文件里开启日志的Feign客户端

logging:
  level:
    #feign日志以什么级别监控哪个接口
    com.donggua.springclou.service.PaymentFeignService:debug