OpenFeign服务接口调用

野性酷女 2023-10-11 20:32 47阅读 0赞

**目录**

一、概述

二、OpenFeign使用步骤

三、OpenFeign超时控制

四、OpenFeign日志打印功能

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

## 一、概述 ##

### OpenFeign是什么 ###

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

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

官网：[Spring Cloud][]

Github：[GitHub - spring-cloud/spring-cloud-openfeign: Support for using OpenFeign in Spring Cloud apps][GitHub - spring-cloud_spring-cloud-openfeign_ Support for using OpenFeign in Spring Cloud apps]

## 二、OpenFeign使用步骤 ##

引入spring-cloud-starter-openfeign

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

**主启动类上要添加@EnableFeignClients注解**

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

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

@Component
    @FeignClient(value = "CLOUD-PAYMENT-SERVICE")
    public interface PaymentFeignService
    {
        //提供者Controller存在的方法
        @GetMapping(value = "/payment/get/{id}")
        CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
    }

控制层Controller

@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);
        }
    }

![bf28b90ba5ee4a9f9e5186eaba9c2385.png][]

![079abe71dc8846338f0da77210d39bb8.png][]

> **Feign自带负载均衡配置项 ，Feign代替了Ribbon+RestTemplate**
> 
> [Feign和Ribbon的区别\_坚持与努力的博客-CSDN博客\_openfeign和ribbon区别][Feign_Ribbon_-CSDN_openfeign_ribbon]

## 三、OpenFeign超时控制 ##

提供者编写一个超时方法供客户端调用演示超时状态

@GetMapping(value = "/payment/feign/timeout")
        public String paymentFeignTimeOut()
        {
            System.out.println("*****paymentFeignTimeOut from port: "+serverPort);
            //暂停几秒钟线程
            try { TimeUnit.SECONDS.sleep(3); } catch (InterruptedException e) { e.printStackTrace(); }
            return serverPort;
        }

客户端Feign接口

@Component
    @FeignClient(value = "cloud-payment-service")
    public interface PaymentFeignService {
    
        @GetMapping("/payment/get/{id}")
        public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
    
        @GetMapping(value = "/payment/feign/timeout")
        public String paymentFeignTimeOut();
    }

客户端Controller

@RestController
    @Slf4j
    public class OrderFeignController {
    
        @Resource
        private PaymentFeignService paymentFeignService;
    
        @GetMapping("/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() {
            //Feign默认一秒后超时
            return paymentFeignService.paymentFeignTimeOut();
        }
    }

OpenFeign默认等待1秒钟，超过后报错 ![d39ff0a048d44bf5b75e97735a9a1459.png][]

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

OpenFeign默认支持Ribbon

![b2950d508f3d412ea58c3fbbbefe494f.png][]

YML文件里需要开启OpenFeign客户端超时控制

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

## 四、OpenFeign日志打印功能 ##

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

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

如何开启更高级别的日志呢？

（一）配置日志bean

@Configuration
    public class FeignConfig
    {
        @Bean
        Logger.Level feignLoggerLevel()
        {
            return Logger.Level.FULL;
        }
    }

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

server:
      port: 80
    
    eureka:
      client:
        register-with-eureka: false
        service-url:
          defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/
    
    #设置feign客户端超时时间
    #springCloud默认开启支持ribbon
    ribbon:
    #指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
      ReadTimeout: 5000
    #指的是建立连接后从服务器读取到可用资源所用的时间
      ConnectTimeout: 5000
    
    logging:
      level:
        # feign日志以什么级别监控哪个接口
        com.atguigu.springcloud.service.PaymentFeignService: debug

（三）后台日志查看

![820ad844931c4798bbea5701faafb00d.png][]

[Spring Cloud]: https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign
[GitHub - spring-cloud_spring-cloud-openfeign_ Support for using OpenFeign in Spring Cloud apps]: https://github.com/spring-cloud/spring-cloud-openfeign
[bf28b90ba5ee4a9f9e5186eaba9c2385.png]: https://img-blog.csdnimg.cn/bf28b90ba5ee4a9f9e5186eaba9c2385.png
[079abe71dc8846338f0da77210d39bb8.png]: https://img-blog.csdnimg.cn/079abe71dc8846338f0da77210d39bb8.png
[Feign_Ribbon_-CSDN_openfeign_ribbon]: https://blog.csdn.net/a984171281/article/details/118087438
[d39ff0a048d44bf5b75e97735a9a1459.png]: https://img-blog.csdnimg.cn/d39ff0a048d44bf5b75e97735a9a1459.png
[b2950d508f3d412ea58c3fbbbefe494f.png]: https://img-blog.csdnimg.cn/b2950d508f3d412ea58c3fbbbefe494f.png
[820ad844931c4798bbea5701faafb00d.png]: https://img-blog.csdnimg.cn/820ad844931c4798bbea5701faafb00d.png