Spring Cloud_OpenFeign服务接口调用

本是古典何须时尚 2024-03-27 09:26 72阅读 0赞

#### 目录 ####

*  一、概述
 *   *  1.OpenFeign是什么
     *  2.能干嘛
 *  二、OpenFeign使用步骤
 *   *  1.接口+注解
     *  2.新建Module
     *  3.POM
     *  4.YML
     *  5.主启动类
     *  6.业务类
     *  7.测试
     *  8.小总结
 *  三、OpenFeign超时控制
 *   *  1.超时设置，故意设置超时演示出错情况
     *  2.是什么
     *  3.YML中需要开启OpenFeign客户端超时控制
 *  四、OpenFeign日志打印功能
 *   *  1.是什么
     *  2.日志级别
     *  3.配置日志bean
     *  4.YML文件里需要开启日志的Feign客户端
     *  5.后台日志查看

代码链接  
[https://github.com/lidonglin-bit/cloud][https_github.com_lidonglin-bit_cloud]

## 一、概述 ##

### 1.OpenFeign是什么 ###

*  Feign是一个声明式的web服务客户端，让编写web服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可
 *  SpringCloud对Feign进行了封装，使其支持了SpringMVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。  
    [https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/\#spring-cloud-openfeign][https_cloud.spring.io_spring-cloud-static_Hoxton.SR1_reference_htmlsingle_spring-cloud-openfeign]  
    [https://github.com/spring-cloud/spring-cloud-openfeign][https_github.com_spring-cloud_spring-cloud-openfeign]

### 2.能干嘛 ###

*  Feign能干什么？

Feign旨在使用编写Java Http客户端变得更容易。

前面在使用Ribbon+RestTemplate时，利用RestTemplate对Http请求的封装处理，形成了一套模板化的调用方法。

但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务端额调用。所以，Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。

在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它（以前是DAO接口上面标注Mapper注解，现在是一个微服务接口上面标注一个Feign注解即可），即可完成对服务提供方的接口绑定，简化了使用Spring Cloud Ribbon时，自动封装服务调用客户端的开发量。

*  **Feign集成了 Ribbon**

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

*  Feign和OpenFeign两者区别  
    ![在这里插入图片描述][da52688734e94efab749fa0bb1e6ea2b.png]

## 二、OpenFeign使用步骤 ##

![在这里插入图片描述][a7595da17c584d3bbda79f969302cf67.png]

### 1.接口+注解 ###

微服务调用接口+@FeignClient

### 2.新建Module ###

cloud-consumer-feign-order80

### 3.POM ###

注意：openFeign也是自带bibbon

<?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>cloud</artifactId>
            <groupId>com.donglin</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>cloud-consumer-feign-order80</artifactId>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
    
        <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.donglin.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>

### 4.YML ###

server:
      port: 80
    spring:
      application:
        name: cloud-consumer-feign-order80
    eureka:
      client:
        register-with-eureka: true
        fetch-registry: true
        service-url:
          defaultZone: http://localhost:7001/eureka

### 5.主启动类 ###

package com.donglin.springcloud;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    import org.springframework.cloud.openfeign.EnableFeignClients;
    
    @SpringBootApplication
    @EnableEurekaClient
    @EnableFeignClients
    public class OrderFeignMain80 {
        
        public static void main(String[] args) {
        
            SpringApplication.run(OrderFeignMain80.class,args);
        }
    }

### 6.业务类 ###

1.业务逻辑接口+@FeignClient配置调用provider服务  
2.新建PaymentFeignService接口并新增注解@FeignClient

package com.donglin.springcloud.service;
    
    import com.donglin.springcloud.entities.CommonResult;
    import com.donglin.springcloud.entities.Payment;
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.stereotype.Component;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    
    @Component
    @FeignClient(value = "CLOUD-PAYMENT-SERVICE")
    public interface PaymentFeignService {
        
        @GetMapping(value = "/payment/get/{id}")
        public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
    }

3.控制层Controller

package com.donglin.springcloud.controller;
    
    import com.donglin.springcloud.entities.CommonResult;
    import com.donglin.springcloud.entities.Payment;
    import com.donglin.springcloud.service.PaymentFeignService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RestController;
    
    @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);
        }
    }

### 7.测试 ###

1.先启动Eureka7001  
2.再启动2个微服务8001/8002  
3.启动OpenFeign微服务：cloud-consumer-feign-order80  
4.http://localhost/consumer/payment/get/31  
5.Feign自带负载均衡配置项

### 8.小总结 ###

![在这里插入图片描述][a1f202448aa7400395950c89467e9e22.png]

## 三、OpenFeign超时控制 ##

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

1.服务提供方8001故意写暂停程序

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

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

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

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

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

4.测试  
http://localhost/consumer/payment/feign/timeout  
错误页面，**OpenFeign默认等待一秒钟**，超过后报错  
![在这里插入图片描述][ad2882faf0c3492bbda91d9a50c7d307.png]

### 2.是什么 ###

默认Feign客户端只等待一秒钟，但是，服务端处理需要超过1秒钟，导致Feign客户端不想等待了，直接报错。  
为了避免这样的情况，有时候我们需要设置Feign客户端的超时控制，也即Ribbon的超时时间，因为Feign集成了Ribbon进行负载均衡。

### 3.YML中需要开启OpenFeign客户端超时控制 ###

Feign设置超时时间  
使用Feign调用接口分两层，ribbon的调用和hystrix的调用，所以ribbon的超时时间和Hystrix的超时时间的结合就是Feign的超时时间

#设置Feign客户端超时时间（openfeign默认支持ribbon）
    ribbon:
      ReadTimeout:  6000
      ConnectTimeout: 6000
      MaxAutoRetries: 1 #同一台实例最大重试次数,不包括首次调用
      MaxAutoRetriesNextServer: 1 #重试负载均衡其他的实例最大重试次数,不包括首次调用
      OkToRetryOnAllOperations: false  #是否所有操作都重试
    #hystrix的超时时间
    hystrix:
      command:
        default:
          execution:
            timeout:
              enabled: true
            isolation:
              thread:
                timeoutInMilliseconds: 9000

一般情况下 都是 ribbon 的超时时间（<）hystrix的超时时间（因为涉及到ribbon的重试机制）  
**因为ribbon的重试机制和Feign的重试机制有冲突，所以源码中默认关闭Feign的重试机制，源码如下**  
![在这里插入图片描述][39491e037e8b43ca87b97da0c707c9a3.png]  
要开启Feign的重试机制如下：（Feign默认重试五次 源码中有）

@Bean
    Retryer feignRetryer() {
        
            return  new Retryer.Default();
    }

根据上面的参数计算重试的次数：MaxAutoRetries+MaxAutoRetriesNextServer+(MaxAutoRetries \*MaxAutoRetriesNextServer) 即重试3次 则一共产生4次调用  
如果在重试期间，时间超过了hystrix的超时时间，便会立即执行熔断，fallback。所以要根据上面配置的参数计算hystrix的超时时间，使得在重试期间不能达到hystrix的超时时间，不然重试机制就会没有意义  
hystrix超时时间的计算： (1 + MaxAutoRetries + MaxAutoRetriesNextServer) \* ReadTimeout 即按照以上的配置 hystrix的超时时间应该配置为 （1+1+1）\*3=9秒  
当ribbon超时后且hystrix没有超时，便会采取重试机制。当OkToRetryOnAllOperations设置为false时，只会对get请求进行重试。如果设置为true，便会对所有的请求进行重试，如果是put或post等写操作，如果服务器接口没做幂等性，会产生不好的结果，所以OkToRetryOnAllOperations慎用。  
如果不配置ribbon的重试次数，默认会重试一次  
注意：  
默认情况下,GET方式请求无论是连接异常还是读取异常,都会进行重试  
非GET方式请求,只有连接异常时,才会进行重试

## 四、OpenFeign日志打印功能 ##

### 1.是什么 ###

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

### 2.日志级别 ###

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

### 3.配置日志bean ###

package com.donglin.springcloud.config;
    
    import feign.Logger;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    public class FeignConfig {
        
    
        @Bean
        public Logger.Level feignLoggerLevel(){
        
            return Logger.Level.FULL;
        }
    }

### 4.YML文件里需要开启日志的Feign客户端 ###

logging:
      level:
        com.donglin.springcloud.service.PaymentFeignService: debug

### 5.后台日志查看 ###

http://localhost/consumer/payment/get/31  
![在这里插入图片描述][748451271f7a41f98a03ee281ba46f1a.png]

[https_github.com_lidonglin-bit_cloud]: https://github.com/lidonglin-bit/cloud
[https_cloud.spring.io_spring-cloud-static_Hoxton.SR1_reference_htmlsingle_spring-cloud-openfeign]: https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign
[https_github.com_spring-cloud_spring-cloud-openfeign]: https://github.com/spring-cloud/spring-cloud-openfeign
[da52688734e94efab749fa0bb1e6ea2b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/2016db6e00f840f78b57b235045e8100.png
[a7595da17c584d3bbda79f969302cf67.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/57f6e677240644dabb468eb5847f9519.png
[a1f202448aa7400395950c89467e9e22.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/7fa6448537764d5293aea6621b9b60c5.png
[ad2882faf0c3492bbda91d9a50c7d307.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/7096b62f242d4beba5d02f108959c125.png
[39491e037e8b43ca87b97da0c707c9a3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/212074aa1bcc4365b4e3cec9c9d80d0e.png
[748451271f7a41f98a03ee281ba46f1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/c6e7448a86fb49c895b6c60eaa38ed8a.png