笔记：OpenFeign

openFeign是什么？

Feign是个声明式的webservice客户端，使用Feign能让编写webservice客户端更加简单。

使用方法是定义一个服务接口然后在上面添加注解，Feign也支持可插拔的编码器与解码器，SpringCloud对Feign进行了封装，使其支持了SpringMVC标注注解和HttpMessageConverters。也可以与Eureka和Ribbon组合使用以支持负载均衡。

面向微服务接口编程

Feign已被OpenFeign取代

Feign与OpenFeign两者有什么区别？

Feign是SpringCloud组件中的一个轻量级RESTful的服务客户端，内置Ribbon用来做负载均衡。

OpenFeign是SpringCloud 在Feign的基础上支持了SpringMVC注解，OpenFeign的@FeignClient注解可以解析SpringMVC下的接口，并通过动态代理方式产生实现类，实现类中做负载均衡并调用其它服务。

如何使用OpenFeign?

1. 引入maven依赖

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

2. 主启动类添加注解 @EnableFeignClients

3. 添加服务调用接口

   @Component
   @FeignClient(value = "CLOUD-PAYMENT-SERVICE")
   public interface PaymentFeignService {
   
       @PostMapping("/create")
       CommonResult create(@RequestBody Payment payment);
   
       @GetMapping("/payment/get/{id}")
       CommonResult queryPaymentById(@PathVariable("id") Long id);
   }
   

   @FeignClient 使用OpenFeign，value与注册中心服务名保持一致。

   @Mapping注解与对应服务url保持一致。

OpenFeign的超时控制

消费侧调用服务侧一定会存在一种情况：超时

默认OpenFeign客户端只等待一秒钟，超过一秒钟报错read timeout

OpenFeign集成了Ribbon所以支持负载均衡，它的超时控制也由Ribbon进行控制。

解决方法，application.yml添加配置：

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

OpenFeign日志打印功能

OpenFeign提供了日志打印功能，可以通过调整日志输出级别，从而了解OpenFeign中Http请求细节。

实现对Feign接口的调用情况进行监控与输出。

日志级别：

• NONE：不显示任何日志。（默认）
• BASIC：仅记录请求方法、URL、响应状态码及执行时间。
• HEADERS：包括BASIC信息，还有请求与响应头信息。
• FULL：包括HEADERS信息，还有请求与响应正文及元数据。

实现日志监控：

1. 新增配置类

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

2. application.yml添加配置

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

---

踩坑记录

在普通类上定义@PatnVariable注解时value值可以不用声明，直接写值就好，但是在Feign接口下使用该注解，则需要声明value：

@FeignClient(name = "TUZI")
public interface TuziClientService{
    @GetMapping("/demo/get/{id}")
    Tuzi get(@PathVariable(value="id") int id);//value需要显式声明，否则报错
}