Spring Cloud（七）：OpenFeign服务接口调用

妖狐艹你老母 2022-10-22 11:52 174阅读 0赞

## 1. 概述 ##

Feign是一个声明式WebService客户端。使用Feign可以让编写WebService客户端更加简单。

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

源码地址：https://github.com/spring-cloud/spring-cloud-openfeign

### 1.1 能干什么 ###

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

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

Feign和OpenFeign两者区别：

<table> 
 <thead> 
  <tr> 
   <th>Feign</th> 
   <th>OpenFeign</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Feign是Spring Cloud组件中的一个轻量级RESTful的HTTP服务客户端，Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务，Feign的使用方法是：使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务</td> 
   <td>OpenFeign是Spring Cloud在Feign的基础上支持了SpringMVC的注解，如@RequestMapping 等等，OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务</td> 
  </tr> 
 </tbody> 
</table>

*  feign:

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

*  openfeign:

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

## 2. OpenFeign使用步骤 ##

### 2.1 接口+注解 ###

微服务调用接口+@FeignClient

### 2.2 新建cloud-consumer-feign-order80 ###

Feign在消费端使用

### 2.3 pom ###

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>spring-cloud-demo</artifactId>
            <groupId>com.lele.springcloud</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>cloud-consumer-feign-order80</artifactId>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-openfeign</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>com.lele.springcloud</groupId>
                <artifactId>cloud-api-commons</artifactId>
                <version>${project.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <scope>runtime</scope>
                <optional>true</optional>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </project>

### 2.4 yml ###

server:
      port: 80
    
    eureka:
      client:
        register-with-eureka: false
        service-url:
          defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

### 2.5 主启动类 ###

package com.lele.springcloud;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.openfeign.EnableFeignClients;
    
    /**
     * @author: lele
     * @date: 2021/3/17 7:27
     * @description:
     */
    @SpringBootApplication
    @EnableFeignClients
    public class OrderFeignMain80 {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(OrderFeignMain80.class, args);
        }
    }

### 2.6 业务类 ###

业务逻辑接口+@FeignClient配置调用provider服务

新建PaymentFeignService接口并新增注解@FeignClient

package com.lele.springcloud.service;
    
    import com.lele.springcloud.entities.CommonResult;
    import com.lele.springcloud.entities.Payment;
    import feign.Param;
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.stereotype.Component;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    
    /**
     * @author: lele
     * @date: 2021/3/17 7:31
     * @description:
     */
    @Component
    @FeignClient(value = "CLOUD-PAYMENT-SERVICE")
    public interface PaymentFeignService {
        
    
        @GetMapping(value = "/payment/get/{id}")
        CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
    }

### 2.7 控制层Controller ###

package com.lele.springcloud.controller;
    
    import com.lele.springcloud.entities.CommonResult;
    import com.lele.springcloud.entities.Payment;
    import com.lele.springcloud.service.PaymentFeignService;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.annotation.Resource;
    
    /**
     * @author: lele
     * @date: 2021/3/17 7:39
     * @description:
     */
    @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);
        }
    }

### 2.8 测试 ###

*  先启动 Eureka 集群 7001、7002
 *  启动 8001、8002
 *  启动 cloud-consumer-feign-order80
 *  访问：http://localhost/consumer/payment/get/1

Feign 自带负载均衡配置项

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70]

## 3. OpenFeign 超时控制 ##

*  8001 PaymentController  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 1]
 *  80 PaymentFeignService  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 2]
 *  80 OrderFeignController  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 3]
 *  启动 7001、7002
 *  启动 8001
 *  启动 feign80  
    访问： http://localhost/consumer/payment/feign/timeout  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 4]

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

yml配置文件中开启：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 5]

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

*  重启 feign80
 *  访问：http://localhost/consumer/payment/feign/timeout  
    ![在这里插入图片描述][20210318215237189.png]

## 4. OpenFeign日志打印功能 ##

### 4.1 是什么 ###

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

### 4.2 日志级别 ###

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

### 4.3 配置日志bean ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 6]

### 4.4 YML文件里需要开启日志的Feign客户端 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 7]

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

访问：http://localhost/consumer/payment/get/1

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 8]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70]: /images/20221022/bda443ccbe3c484bbd7c060879194728.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 1]: /images/20221022/5f56e3bb2b5943ecaf044764df4393dd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 2]: /images/20221022/a96c9238a24f43949bffd979c1583659.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 3]: /images/20221022/2a8062687bbc425b89bee8919c2a24d7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 4]: /images/20221022/5a6de73aa6ca4f8caa250c0b537c832a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 5]: /images/20221022/a6b19cbf1a8e44ecad85674144eb6e46.png
[20210318215237189.png]: /images/20221022/cb79b4694f8043c28847ac988723196e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 6]: /images/20221022/db37345482a048d68786bc1f1b655711.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 7]: /images/20221022/282c371abbf8449aa287340bcf82535b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hvdXdhbmxl_size_16_color_FFFFFF_t_70 8]: /images/20221022/a9bf0f6f8f354959ab87284b6ede3795.png