微服务架构 | 4.2 基于 Feign 与 OpenFeign 的服务接口调用

2021-12-29 02:32:23

前言

参考资料：
《Spring Microservices in Action》
《Spring Cloud Alibaba 微服务原理与实战》
《B站 尚硅谷 SpringCloud 框架开发教程 周阳》

Feign 是一个声明式的Web服务客户端，让编写 Web 服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可；

1. OpenFeign 基本知识

1.1 Feign 是什么

  • Feign 是一个声明式的 Web 服务客户端，让编写 Web 服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可；
  • Feign 旨在使编写 Java HTTP 客户端变得更容易；

1.2 Feign 的出现解决了什么问题

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

1.3 Feign 与 OpenFeign 的区别与对比

Feign OpenFeign
Feign 是 Spring Cloud 组件中的一个轻量级 RESTful 的 HTTP 服务客户端。Feign 内置了 Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务。Feign 的使用方式是：使用 Feign 的注解定义接口，调用这个接口，就可以调用服务注册中心的服务； OpenFeign 是 Spring Cloud 在 Feign 的基础上支持了 SpringMVC 的注解，如 @RequesMapping 等。OpenFeign 的 @FeignClient 可以解析 SpringMVC 的 @RequestMapping 注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务；
2018年以前的项目在使用feign springcloud F 及 F 版本以上基本上使用 openfeign，openfeign 从框架结构上可以看做是2019年 feign 停更后出现版本，可以说大多数新项目在用 openfeign
spring-cloud-starter-feign spring-cloud-starter-openfeign
  • Feign 与 OpenFeign 最大的区别是：前者不支持对 SpringMVC 的注解，而后者支持；
  • Feign 默认支持 Ribbon 负载均衡，而 OpenFeign 又是在 Feign 的基础上发展而来的；
  • 详情可以参考下面：《2.3 在业务接口上添加注解》与《3.3 在业务接口上添加注解》；


2. 在服务消费者端开启 Feign 支持

消费者对 Feign 客户端的支持示例同《微服务架构 | 4.1 基于 Ribbon 的负载均衡详解》一篇中：2.4 使用 Netflix Feign 客户端调用服务部分；

2.1 引入 pom.xml 依赖

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

2.2 在主程序类上添加注解

@EnableFeignClients：表示开启并使用 Feign 客户端；

2.3 在业务接口上添加注解

@FeignClient("provider-instance-name") //标识服务为 feign 的客户端
public interface ProviderFeignClient {
    //定义端点的路径和动作
    @RequestMapping( 
            method= RequestMethod.GET,
            value="/providers/{providerId}",
            consumes="application/json")
    //定义传入端点的参数，该方法可以由客户端调用以触发组织服务        
    Provider getProvider(@PathVariable("providerId") String providerId);
}
  • 注意：Feign 不支持对 SpringMVC 注解的支持（与 OpenFeign 的最大区别）；
  • 接下来完成对业务接口的实现，将接口自动注入 Controller 层并调用接口方法即可；

2.4 在 controller 层调用接口

@RestController
public class ConsumerFeignController{
    @Resource
    private ProviderFeignClient providerFeignClient;

    @GetMapping(value = "/provider/get/{id}")
    public Provider getProviderById(@PathVariable("id") Long id){
        return providerFeignClient.getProviderById(id);
    }
}


3. 在服务消费者端开启 OpenFeign 支持

3.1 引入 pom.xml 依赖

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

3.2 在主程序类上添加注解

@EnableFeignClients：表示开启并使用 Feign 客户端（同 Feign）；

3.3 在业务接口上添加注解

@FeignClient：表示开启并使用 Feign 客户端；

@Component
@FeignClient(value = "provider-instance-name")
public interface ProviderFeignClient {
    @GetMapping(value = "/providers/{providerId}")
    Provider getProvider(@PathVariable("providerId") String providerId);
}
  • 注意：可以从这里看到 OpenFeign 对 SpringMVC 注解的支持（与 Feign 的最大区别）；
  • 接下来的步骤同 Feign，也是：完成对业务接口的实现，将接口自动注入 Controller 层并调用接口方法即可；
  • 同《2.4 在 controller 层调用接口》；


4. OpenFeign 的超时控制

  • 当客户端请求超过 1s 是，会报如下错误：

微服务架构 | 4.2 基于 Feign 与 OpenFeign 的服务接口调用

  • 这是因为 Feign 客户端默认只等待一秒钟，当请求时间超过 1s 时，Feign 会给我们返回请求超时页面；
  • 只需修改 yml 文件即可修改默认超时控制；
#设置 feign/openFeign 客户端超时时间
ribbon:
  #指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
  ReadTimeout: 5000
  #指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000


5. OpenFeign 的日志打印功能

5.1 日志与日志级别

  • Feign 提供了日志打印功能，可以通过配置来调整日志级别，从而了解 Feign 中 Http 请求的细节；
  • 也即：对 Feign 接口的调用情况进行监控和输出；
级别 说明
NONE 默认的，不显示任何日志
BASIC 仅记录请求方法、URL、响应状态码及执行时间
HEADERS 除了 BASIC 中定义的信息之外，还有请求和响应的头信息
FULL 除了 HEADERS 中定义的信息之外，还有请求和响应的正文及元数据

5.2 编写配置类设置日志级别

在 config 包下；
@Configuration
public class FeignConfig{
    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

5.3 在 yml 文件里配置需要开启日志功能的提供者 Feign 客户端

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

5.4 在控制台上查看日志信息

微服务架构 | 4.2 基于 Feign 与 OpenFeign 的服务接口调用


上一篇：JavaWeb-JDBC


下一篇：微服务架构 | 11. 分布式事务