SpringCloud—OpenFeign服务接口调用

springcloud 携带header springcloud调用接口_java

springcloud 携带header springcloud调用接口_OpenFegin_02

1. 概述

Ⅰ. OpenFeign是什么

OpenFeign官网

Feign是一个声明式WebService客户端，使用Feign能让编写Web Service客户端更加简单（只需创建一个接口并在接口上添加注解即可）

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

Ⅱ. Feign能做什么

Feign能干什么

Feign旨在使编写Java Http客户端变得更容易。

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

Feign集成了Ribbon

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

Ⅲ. Feign和OpenFeign的区别

Feign

OpenFeign

特点

Feign是SpringCloud组件中的一个轻量级RESTful的HTTP服务客户端，Feign内置了Ribbon，用来做客户端的负载均衡，去调用服务注册中心的服务。Feign的使用方式是：使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务。

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

启动器

spring-cloud-starter-feign

spring-cloud-starter-openfeign

Feign已经停止维护，所以我们只需要关注 OpenFeign 的使用即可。

我们现在学习的就是利用 OpenFeign 实现我们之前用的 Ribbon + RestTemplate

2. OpenFeign使用步骤

微服务调用接口 + @FeignClient

  • 建Modulecloud-consumer-feign-order80Feign在消费端使用
  • 改POM
<!--openfeign-->
<dependency>
   <groupId>org.springframework.cloud</groupId>
   <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

springcloud 携带header springcloud调用接口_java_03

  • 写YML
  • 主启动@EnableFeignClients注解
  • 业务类业务逻辑接口 + @FeignClient配置调用provider服务➢ 新建PaymentFeignService接口并新增注解@FeignClient

➢ 控制层Controller

springcloud 携带header springcloud调用接口_Fegin_04

springcloud 携带header springcloud调用接口_java_05

  • 测试http://localhost/consumer/payment/get/31Feign自带负载均衡配置项
  • 总结@EnableFeginClients => 启动@FeginClient => 使用客户端的服务接口使用 @FeignClient

3. OpenFeign超时控制

超时设置 故意设置超时演示出错情况

  • 服务提供方8001故意写暂停程序
  • 服务消费方80添加超时方法PaymentFeignService
  • 服务消费方80添加超时方法OrderFeignController
  • 测试http://localhost/consumer/payment/feign/timeout➢ 错误页面OpenFeign默认等待1秒钟，超过后报错：

默认Feign客户端只等待一秒钟，但是服务端处理需要超过1秒钟，导致Feign客户端不想等待了，直接返回报错。

为了避免这样的情况，有时候我们需要设置Feign客户端的超时控制。

  • OpenFeign默认支持Ribbon
  • YML文件里需要开启OpenFeign客户端超时控制超时控制也由底层的Ribbon进行限制：
  • 测试➢ 可以正常访问

4. OpenFeign日志打印功能

Feign 提供了日志打印功能，我们可以通过配置来调整日志级别，从而了解 Feign 中 Http 请求的细节。

说白了就是对Feign接口的调用情况进行监控和输出。

日志级别

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

开启日志打印功能

  • 配置日志bean
  • YML文件里需要开启日志的Feign客户端
  • 后台日志查看