OpenFeign学习及快速使用

1.是什么

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

2.能干嘛

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

3.OpenFeign使用步骤

一.导入OpenFeign的相关依赖构建服务，并注册到Eureka注册中心

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

server:
  port: 8000

spring:
  application:
    name: cloud-openfeign-order

eureka:
  client:
    register-with-eureka: true
    service-url:
      defaultZone: http://localhost:7001/eureka

二.主启动类添加@EnableFeignClients注解开启Feign

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients //启动Feign
public class OrderFeignMain8000 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain8000.class,args);
    }
}

三.编写业务逻辑接口+@FeignClient注解调用服务提供者
服务提供者

/**
*服务提供者
*/
@Controller
@ResponseBody
@Slf4j
public class PaymentController {

    @Autowired
    private PaymentService paymentService;

    @Value("${server.port}")
    private String serverPort;

    @GetMapping("/payment/get/{id}")
    public CommonResult<Payment> get(@PathVariable("id") Long id) {
        Payment payment = paymentService.getById(id);
        log.info("插入结果" + payment);
        if (payment != null) {
            return new CommonResult(200, "查询成功" + serverPort, payment);
        } else {
            return new CommonResult(444, "没有对应记录");
        }
    }
 }

服务消费者

/**服务消费者调用服务提供者业务逻辑
 */
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")//指定被调用服务的名称
public interface PaymentFeignService {

	/**
	 *远程调用原理：
	 * 1.PaymentFeignService.get(id)当调用这个方法时
	 * 找到CLOUD-PAYMENT-SERVICE服务，给/payment/get/{id}发送请求
	*/
    @GetMapping("/payment/get/{id}")//指定调用服务提供者的哪个接口
    CommonResult get(@PathVariable("id") Long id);
}

/**
 *服务消费者
 * 使用openfeign做服务调用
 */
@RestController
@Slf4j
public class OrderFeignController {

    @Autowired
    private PaymentFeignService paymentFeignService;

    @GetMapping("/consumer/payment/get/{id}")
    public CommonResult<Payment> get(@PathVariable("id") Long id){
        return paymentFeignService.get(id);
    }
}

Feign自带负载均衡配置项（可构建多个服务提供者测试）

4.OpenFeign超时控制

OpenFeign默认等待一秒钟，超过后报错。

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

#feign:
#  client:
#    config:
#      default:
#        connect-timeout: 5000
#        read-timeout: 5000
#设置Feign客户端超时时间（OpenFeign默认支持Ribbon）也可在feign中配置
ribbon:
  #指的是建立连接所用的时间，适用于网络状况正常的情况，两端连接所用时间
  ReadTimeout: 5000
  #指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

5.OpenFeign日志打印

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

配置OpenFeign的日志打印
一.配置日志bean

/**
 *
 * 配置feign的日志打印
 */
@Configuration
public class FeignConfig {

    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

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

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

查看控制台打印