OpenFeign

简介

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

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

Feign和OpenFeign的区别：

OpenFeign使用步骤：

1、添加pom依赖：

copy

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

2、主启动类上使用注解：

copy

@EnableFeignClients

3、创建一个接口和服务提供方提供的方法绑定：

copy

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

• @FeignClient 的value 指定了是和注册在Eureka 注册中心的哪个服务绑定
• @Component 是让Spring 扫描该接口配置
• 接口里面的方法名等要和服务提供方（Controller）中对应的方法完全一致

4、客户端直接在Controller 调用刚创建接口里的方法即可，不用再使用RestTemplate

copy

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

参数对应情况如下：

OpenFeign的超时控制:

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

对于某些特殊的请求可能服务端处理时间较长，可以修改配置文件调节OpenFeign 超时控制的时间：

copy

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

这样OpenFeign客户端就不在 1s 收不到响应就报错了。
OpenFeign超时时间设置

OpenFeign 日志打印功能：

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

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

配置日志：
1、新建配置类

copy

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

2、YML文件里需要开启日志的Feign客户端

copy

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

这样就能在后台查看日志的详细信息了。

OpenFeign 集成了Ribbon:

  默认的负载均衡策略仍为轮询，默认开启。如果想要更换负载均衡策略，步骤和使用RestTemplate+Ribbon 时操作基本一样。详情请看我的上篇博文Ribbon 负载均衡。