SpringCloud系列--OpenFeign入门

1、OpenFeign基础知识

1.1、Feign简介

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

1.2、Feign能干什么

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

1.3、Feign集成了Ribbon

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

2、OpenFeign的使用

OpenFeign提供了两个重要注解@FeignClient和@EnableFeignClients：
@FeignClient注解用于声明Feign客户端可访问的Web服务。
@EnableFeignClients标注用于修饰Spring Boot应用的入口类，以通知Spring Boot启动应用时，扫描应用中声明的Feign客户端可访问的Web服务。

1. pom.xml

主要的依赖：

 
  <dependency>
      <groupId>org.springframework.cloudgroupId>
      <artifactId>spring-cloud-starter-openfeignartifactId>
  dependency>

2. application.yml

server:
  port: 80

eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/
#设置feign客户端超时时间(OpenFeign默认支持ribbon)
ribbon:
#指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
  ReadTimeout: 5000
#指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

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

3. 主程序类

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

主程序类添加@EnableFeignClients注解，以通知Spring Boot启动应用时，扫描应用中声明的Feign客户端可访问的Web服务。

4. 定义服务接口

定义Fegin需要调用其他的服务的接口

@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService
{
    @GetMapping(value = "/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
    
    @GetMapping(value = "/payment/feign/timeout")
    public String paymentFeignTimeout();
}

@FeignClient的value参数指定这个接口对应要调用的微服务的服务名称。

5. controller

定义访问Web服务的REST控制器类：

@RestController
@Slf4j
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);
    }

    @GetMapping(value = "/consumer/payment/feign/timeout")
    public String paymentFeignTimeout()
    {
        // OpenFeign客户端一般默认等待1秒钟
        return paymentFeignService.paymentFeignTimeout();
    }
}

6. Feign配置类

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

启动当前Feign模块需要访问的服务后，再启动当前的order模块即可进行测试。
Feign默认使用ribbon实现负载均衡
OpenFeign超时机制:
OpenFeign默认等待时间是1秒,超过1秒,直接报错。