【详解】Spring Cloud之OpenFeign 的功能与配置

一、什么是 OpenFeign

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

二、OpenFeign 能干嘛

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

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

三、OpenFeign 与 Feign 的区别

四、OpenFeign 的使用步骤

1、在 当前服务消费者的 pom.xml 文件中加入 OpenFeign 的依赖

<!--openfeign-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2、创建微服务接口并加上 @FeignClient 注解（我这里是选择在 服务消费者 的 service 包下创建）

/**
 * @Author Herz
 * @Date 2021/12/30 17:08
 */
@Component
// value 值表示暴露的哪个服务提供者的服务接口
@FeignClient(value = "CLOUD-PROVIDER-PAYMENT")
public interface PaymentFeignService {
    @GetMapping("/payment/get/{id}")
    CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
}

3、在当前 服务消费者 的主启动类上添加注解 @EnableFeignClients 来开启 Feign 功能

/**
 * @Author Herz
 * @Date 2021/12/30 16:07
 */
@SpringBootApplication
// 开启 OpenFeign 功能
@EnableFeignClients
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class, args);
    }
}

4、在服务消费端 的 controller 中调用暴露的接口

/**
 * @Author Herz
 * @Date 2021/12/30 17:14
 */
@RestController
@Slf4j
public class OrderController {

    @Autowired
    private PaymentFeignService paymentFeignService;


    @GetMapping("/consumer/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id) {

        return paymentFeignService.getPaymentById(id);
    }
}

五、OpenFeign 的超时控制

1、演示 OpenFeign 超时的效果

1）在服务提供者的 controller 中故意写一个暂停的 请求控制

@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeOut() {
    System.out.println("*****paymentFeignTimeOut from port: " + serverPort);
    //暂停几秒钟线程
    try {
        TimeUnit.SECONDS.sleep(3);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
    return serverPort.toString();
}

2）在服务暴露接口中添加 要暴露的相应的 controller

/**
 * @Author Herz
 * @Date 2021/12/30 17:08
 */
@Component
@FeignClient(value = "CLOUD-PROVIDER-PAYMENT")
public interface PaymentFeignService {

    @GetMapping(value = "/payment/feign/timeout")
    String paymentFeignTimeOut();
}

3）在服务消费者 的 controller 中调用暴露的服务提供者的服务接口的 controller

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

4）测试 OpenFeign 远程调用超时，启动 注册中心、服务提供者、服务消费者，在浏览器输入地址：http://localhost/consumer/payment/feign/timeout（我的服务消费者的端口号为 80 ，所以可以省略端口号）

看到此错误，说明 OpenFeign 调用超时。（默认的客户端远程调用服务端的时长为 1 s）

2、如何开启 OpenFeign 客户端超时控制

在 yml 文件中添加以下内容

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

六、OpenFeign 日志打印功能

1、OpenFeign 的日志打印功能是什么

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

2、OpenFeign 的日志级别

NONE：默认的，不显示任何日志；

BASIC：仅记录请求方法、URL、响应状态码及执行时间；

HEADERS：除了 BASIC 中定义的信息之外，还有请求和响应的头信息；

FULL：除了 HEADERS 中定义的信息之外，还有请求和响应的正文及元数据。

3、如何使用 OpenFeign 的日志打印功能

• 1）配置日志 bean（在服务消费者的模块中新建包 config 并创建配置类 FeignConfig）

  package com.tianfei.springcloud.config;
  
  import feign.Logger;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  
  /**
   * @Author Herz
   * @Date 2022/1/3 17:11
   */
  @Configuration
  public class FeignConfig {
  
      @Bean
      Logger.Level feignLoggerLevel(){
  
          return Logger.Level.FULL;
      }
  }
  

• 2）在对应的服务消费者的 YML 文件中开启日志打印的 Feign 的客户端

  logging:
    level:
      # feign日志以什么级别监控哪个接口
      com.tianfei.springcloud.service.PaymentFeignService: debug  
      # com.tianfei.springcloud.service.PaymentFeignService 这个是暴露服务提供者接口的类名