OpenFeign 服务接口调用

今天药忘吃喽~ 2022-12-29 04:42 174阅读 0赞

--------------------

### OpenFeign 服务接口调用 ###

*  1-OpenFeign 概述
 *   *  1.1-是什么
     *  1.2-能干嘛
 *  2-OpenFeign 使用
 *   *  2.1-配置示例
     *  2.1-配置总结
 *  3-OpenFeign 超时控制
 *   *  3.1-配置示例
     *  3.2-配置总结
 *  3-OpenFeign 日志打印
 *   *  3.1-配置示例

--------------------

# 1-OpenFeign 概述 #

官网：[https://github.com/spring-cloud/spring-cloud-openfeign][https_github.com_spring-cloud_spring-cloud-openfeign]

## 1.1-是什么 ##

官方解释：[https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/\#spring-cloud-openfeign][https_cloud.spring.io_spring-cloud-static_Hoxton.SR1_reference_htmlsingle_spring-cloud-openfeign]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70]  
Feign 是一个**声明式 Web Service 客户端**。使用 Feign 能让编写 Web Service 客户端更加简单，它的**使用方法**是定义一个接口，然后在上面添加注解，同时也支持 JAX-RS 标准的注解。

Feign 也支持可拔插式的编码器和解码器。SpringCloud 对 Feign 进行了封装，使其支持了 SpringMVC 标准注解 和 HttpMessageConverters。

**Feign 可以与 Eureka 和 Ribbon 组合使用以支持负载均衡**。

Feign 是一个声明式的 Web 服务客户端，使得编写 Web 服务客户端变得非常容易，**只需要创建一个接口，然后在上面添加注解即可**。

## 1.2-能干嘛 ##

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

前面在使用 Ribbon + RestTemplate 时，利用 RestTemplate 对 Http 请求的封装处理，形成了一套模版化的调用方法。但是在实际开发中，由于对服务依赖的调用可能不止一处，**往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用**。所以 Feign 在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。

在 Feign 的实现下，**我们只需创建一个接口并使用注解的方式来配置它（以前是 Dao 接口上面标注 Mapper 注解，现在是一个微服务接口上面标注一个 Feign 注解即可）**，即可完成对服务提供方的接口绑定，简化了使用 SpringCloud Ribbon 时，自动封装服务调用客户端的开发量。

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

**Feign 与 OpenFeign 的关系？**

<table> 
 <thead> 
  <tr> 
   <th><strong>Feign</strong></th> 
   <th><strong>OpenFeign</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong>Feign 是 SpringCloud 组件中的一个轻量级 Restful 的 Http 服务客户端</strong>。Feign 内置了 Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务。<strong>Feign 的使用方式是</strong>：使用 Feign 的注解定义接口，调用这个接口，就可以调用服务注册中心的服务。</td> 
   <td><strong>OpenFeign 是 SpringCloud 在 Feign 的基础上支持了 SpringMVC 的注解</strong>，如 @RequesMapping 等。OpenFeign 的 @FeignClient 可以解析 SpringMVC 的 @RequestMapping 注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务。</td> 
  </tr> 
  <tr> 
   <td><img src="https://img-blog.csdnimg.cn/2021011214153911.png" alt="在这里插入图片描述"></td> 
   <td><img src="https://img-blog.csdnimg.cn/2021011214162024.png" alt="在这里插入图片描述"></td> 
  </tr> 
 </tbody> 
</table>

--------------------

# 2-OpenFeign 使用 #

**接口 + 注解（微服务调用接口 + @FeignClient）**

OpenFeign 消费端使用：  
![在这里插入图片描述][20210112143454358.png]

## 2.1-配置示例 ##

**a、右击父工程 mscloud，新建子模块 cloud-consumer-feign-order80**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70 1]  
**b、修改子模块 cloud-consumer-feign-order80 中 pom.xml**

<?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">
        <modelVersion>4.0.0</modelVersion>
    
        <parent>
            <artifactId>cloud2020</artifactId>
            <groupId>com.atguigu.springcloud</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
    
        <artifactId>cloud-consumer-feign-order80</artifactId>
    
        <dependencies>
            <dependency>
                <groupId>com.atguigu.springcloud</groupId>
                <artifactId>cloud-api-commons</artifactId>
                <version>${project.version}</version>
            </dependency>
            <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>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>

**c、修改子模块 cloud-consumer-feign-order80，目录 /src/main/resources 中新建 application.yml**

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

**d、修改子模块 cloud-consumer-feign-order80，目录 /src/main/java 中新建包 com.atguigu.springcloud**

**e、修改子模块 cloud-consumer-feign-order80，包 com.atguigu.springcloud 中新建启动类 OrderFeignMain80.java**  
![在这里插入图片描述][20210112144435739.png]

package com.atguigu.springcloud;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.openfeign.EnableFeignClients;
    
    @SpringBootApplication
    @EnableFeignClients
    public class OrderFeignMain80 {
        public static void main(String[] args) {
            SpringApplication.run(OrderFeignMain80.class, args);
        }
    }

**f、修改子模块 cloud-consumer-feign-order80，目录 /src/main/java 中新建包 com.atguigu.springcloud.service**

**g、修改子模块 cloud-consumer-feign-order80，包 com.atguigu.springcloud.service 中新建类 PaymentFeignService.java**

业务逻辑接口 + @FeignClient 配置调用微服务提供者服务。![在这里插入图片描述][20210112145929692.png]

package com.atguigu.springcloud.service;
    
    import com.atguigu.springcloud.entities.CommonResult;
    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;
    
    @Component
    @FeignClient(value = "CLOUD-PAYMENT-SERVICE")
    public interface PaymentFeignService {
    
        @GetMapping(value = "/payment/get/{id}")
        public CommonResult getPaymentById(@PathVariable("id") Long id);
    }

**h、修改子模块 cloud-consumer-feign-order80，目录 /src/main/java 中新建包 com.atguigu.springcloud.controller**

**i、修改子模块 cloud-consumer-feign-order80，包 com.atguigu.springcloud.controller 中新建类 OrderFeignController.java**

package com.atguigu.springcloud.controller;
    
    import com.atguigu.springcloud.entities.CommonResult;
    import com.atguigu.springcloud.entities.Payment;
    import com.atguigu.springcloud.service.PaymentFeignService;
    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;
    
    @RestController
    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);
        }
    }

**j、测试 OpenFeign 使用**

*  启动 Eureka 集群（子模块 cloud-eureka-server7001、cloud-eureka-server7002）
 *  启动微服务集群（子模块 cloud-provider-payment8001、cloud-provider-payment8002）
 *  启动子模块 cloud-consumer-feign-order80
 *  [http://localhost/consumer/payment/get/31][http_localhost_consumer_payment_get_31]
    
    Feign 自带负载均衡配置  
    ![在这里插入图片描述][20210112151152494.png]  
    ![在这里插入图片描述][20210112151222254.png]

## 2.1-配置总结 ##

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

--------------------

# 3-OpenFeign 超时控制 #

超时设置（故意设置超时），演示出错情况。

## 3.1-配置示例 ##

**a、修改子模块 cloud-provider-payment8001、cloud-provider-payment8002，包 com.atguigu.springcloud.controller 中 PaymentController.java**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70 3]

package com.atguigu.springcloud.controller;
    
    import com.atguigu.springcloud.entities.CommonResult;
    import com.atguigu.springcloud.entities.Payment;
    import com.atguigu.springcloud.service.PaymentService;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.client.ServiceInstance;
    import org.springframework.cloud.client.discovery.DiscoveryClient;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.annotation.Resource;
    import java.util.List;
    import java.util.concurrent.TimeUnit;
    
    @RestController
    @Slf4j
    public class PaymentController {
        @Resource
        private PaymentService paymentService;
        @Resource
        private DiscoveryClient discoveryClient;
        @Value("${server.port}")
        private String serverPort;
    
        @PostMapping(value = "/payment/create")
        public CommonResult create(Payment payment) {
            int result = paymentService.create(payment);
            log.info("*****插入结果：" + result);
            if (result > 0) {  //成功
                return new CommonResult(200, "插入数据库成功,serverPort: " + serverPort, result);
            } else {
                return new CommonResult(444, "插入数据库失败", null);
            }
        }
    
        @GetMapping(value = "/payment/get/{id}")
        public CommonResult getPaymentById(@PathVariable("id") Long id) {
            Payment payment = paymentService.getPaymentById(id);
            log.info("*****查询结果：" + payment);
            if (payment != null) {  //说明有数据，能查询成功
                return new CommonResult(200, "查询成功,serverPort:  " + serverPort, payment);
            } else {
                return new CommonResult(444, "没有对应记录，查询ID：" + id, null);
            }
        }
    
        @GetMapping(value = "/payment/discovery")
        public Object discovery() {
            List<String> services = discoveryClient.getServices();
            for (String element : services) {
                log.info("***** element:" + element);
            }
            List<ServiceInstance> instances = discoveryClient.getInstances("CLOUD-PAYMENT-SERVICE");
            for (ServiceInstance instance : instances) {
                log.info(instance.getServiceId() + "\t" + instance.getHost() + "\t"
                        + instance.getPort() + "\t" + instance.getUri());
            }
            return this.discoveryClient;
        }
    
        @GetMapping(value = "/payment/lb")
        public String getPaymentLB() {
            return serverPort;
        }
    
        @GetMapping(value = "/payment/feign/timeout")
        public String paymentFeignTimeout() {
            try {
                TimeUnit.SECONDS.sleep(3);
            } catch (Exception e) {
                e.printStackTrace();
            }
            return serverPort;
        }
    }

**b、修改子模块 cloud-consumer-feign-order80，包 com.atguigu.springcloud.service 中类 PaymentFeignService.java**  
![在这里插入图片描述][20210112152013197.png]

**c、修改子模块 cloud-consumer-feign-order80，包 com.atguigu.springcloud.controller 中类 OrderFeignController.java**  
![在这里插入图片描述][20210112152217420.png]

package com.atguigu.springcloud.controller;
    
    import com.atguigu.springcloud.entities.CommonResult;
    import com.atguigu.springcloud.entities.Payment;
    import com.atguigu.springcloud.service.PaymentFeignService;
    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;
    
    @RestController
    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() {
            return paymentFeignService.paymentFeignTimeout();
        }
    }

**d、测试 OpenFeign 超时控制**

*  启动 Eureka 集群（子模块 cloud-eureka-server7001、cloud-eureka-server7002）
 *  启动微服务集群（子模块 cloud-provider-payment8001、cloud-provider-payment8002）
 *  启动子模块 cloud-consumer-feign-order80
 *  [http://localhost/consumer/payment/feign/timeout][http_localhost_consumer_payment_feign_timeout]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70 4]

## 3.2-配置总结 ##

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

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

**OpenFeign 默认支持 Ribbon**。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70 5]  
修改子模块 cloud-consumer-feign-order80，目录 /src/main/resources 中新建 application.yml

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

--------------------

# 3-OpenFeign 日志打印 #

**日志打印功能是什么？**

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

**日志级别：**

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

## 3.1-配置示例 ##

**a、修改子模块 cloud-consumer-feign-order80，目录 /src/main/java 中新建包 com.atguigu.springcloud.config**

**b、修改子模块 cloud-consumer-feign-order80，包 com.atguigu.springcloud.config 中新建类 FeignConfig.java**

package com.atguigu.springcloud.config;
    
    import feign.Logger;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    public class FeignConfig {
    
        @Bean
        Logger.Level feignLoggerLevel() {
            return Logger.Level.FULL;
        }
    }

**c、修改子模块 cloud-consumer-feign-order80，目录 /src/main/resources 中新建 application.yml**  
YML文件里需要开启日志的Feign客户端

**d、测试 OpenFeign 日志打印**

--------------------

[https_github.com_spring-cloud_spring-cloud-openfeign]: https://github.com/spring-cloud/spring-cloud-openfeign
[https_cloud.spring.io_spring-cloud-static_Hoxton.SR1_reference_htmlsingle_spring-cloud-openfeign]: https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70]: /images/20221120/3adf6cae65894d689ce5a7ad4fc1fcaf.png
[20210112143454358.png]: /images/20221120/e13fbe1a29f24ab985ebff1ec191d5bf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70 1]: /images/20221120/b38501e4880542d18fc5411058b14c4e.png
[20210112144435739.png]: /images/20221120/9fef6b7cd74b4be2be3f8a5dfbdc10bd.png
[20210112145929692.png]: /images/20221120/c910a57ee9064021accd02b0d622b8e3.png
[http_localhost_consumer_payment_get_31]: http://localhost/consumer/payment/get/31
[20210112151152494.png]: /images/20221120/c8168f164a2b45a5b396818bea10ae34.png
[20210112151222254.png]: /images/20221120/aefdf80f8f104b68af5504568534564c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70 2]: /images/20221120/ebe94083f343491494bafab76c3f8143.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70 3]: /images/20221120/1126282d5c3f4c49bf2204f3951a6bd5.png
[20210112152013197.png]: /images/20221120/407ed1b7a31e47f2b88653253c31840e.png
[20210112152217420.png]: /images/20221120/ce86774eec72499eaca5225af2550cb5.png
[http_localhost_consumer_payment_feign_timeout]: http://localhost/consumer/payment/feign/timeout
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70 4]: /images/20221120/74f7b5d2638a4b3fbf94f0fd1cfafbca.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3loajE5OTIwNDE3_size_16_color_FFFFFF_t_70 5]: /images/20221120/b95626d213b84cecade8e3e9f00ca5e0.png