SpringCloud学习笔记之OpenFeign进行服务调用

前言

Feign是一个声明式的Web服务客户端，是面向接口编程的。也就是说使用Feign，只需要创建一个接口并使用注解方式配置它，就可以完成对微服务提供方的接口绑定。

在使用RestTemplate时，每次调用服务都需要指定服务的具体路径，当在多个地方同时使用时要写多次，显得代码冗余也难以维护，而openfeign就可以避免这种操作。

1、OpenFeign

1.1、OpenFeign概述

1. 是什么？

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

源码地址

2. 能干嘛？

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

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

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

3. Feign和OpenFeign的区别

1.2、OpenFeign的使用步骤

1. 建Module

Module的名称为cloud-consumer-feign-order80。

2. 改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>cloud02</artifactId>
       <groupId>com.xiao</groupId>
       <version>1.0-SNAPSHOT</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>

<artifactId>cloud-consumer-feign-order80</artifactId>

<!--openfeign-->
   <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.xiao</groupId>
           <artifactId>cloud-api-commons</artifactId>
           <version>1.0-SNAPSHOT</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>

3. 改YML

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

4. 主启动

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableFeignClients //开启OpenFeign
public class OrderFeignMain80 {
   public static void main(String[] args) {
       SpringApplication.run(OrderFeignMain80.class,args);
   }
}

@EnableFeignClients开启OpenFeign

5. PaymentFeignService接口

import com.xiao.cloud.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")  // 使用OpenFeign
public interface PaymentFeignService {

@GetMapping("/payment/get/{id}")
   public CommonResult getPaymentById(@PathVariable("id") Long id);
}

@FeignClient(value = "CLOUD-PAYMENT-SERVICE")使用OpenFeign。

6. Controller类

import com.xiao.cloud.entities.CommonResult;
import com.xiao.cloud.entities.Payment;
import com.xiao.cloud.service.PaymentFeignService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class PaymentFeignController {

@Autowired
   private PaymentFeignService paymentFeignService;

@GetMapping("/consumer/payment/get/{id}")
   public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
       return paymentFeignService.getPaymentById(id);
   }
}

7. 测试结果

当我们多次点击刷新时，端口在8001和8002之间依次变化。

8. 小总结

1.3、超时控制

1.3.1、是什么？

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

在yml文件中开启配置。

1.3.2、修改代码设置超时错误

1. 修改支付模块8001的Controller

添加以下代码

@GetMapping(value = "/payment/feign/timeout")
   public String timeOUt(){
       try {
           Thread.sleep(3000);
       } catch (InterruptedException e) {
           e.printStackTrace();
       }
       return ServerPort;
   }

2. 修改订单模块的PaymentFeignService

添加以下代码

@GetMapping(value = "/payment/feign/timeout")
   public String timeOUt();

3. 修改订单模块的OrderFeignController

添加以下代码

@GetMapping(value = "/consumer/payment/feign/timeout")
   public String timeOUt(){
       return paymentFeignService.timeOUt();
   }

4. 测试结果

直接对支付模块8001的暴露的服务接口进行调用，测验通过。

如果通过订单模块进行调用，那么就会报超时错误。

1.3.3、进行超时配置

在订单模块的YML文件中添加以下代码

ribbon:
 ReadTimeout:  8000
 ConnectTimeout: 8000

1. 测试结果

自测通过。

1.4、日志打印

1.4.1、是什么？

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

1.4.2、日志级别

1. NONE：默认的，不显示任何日志

2. BASIC：仅记录请求方法、URL、响应状态码及执行时间

3. HEADERS：除了BASIC中定义的信息之外，还有请求和响应的头信息

4. FULL：除了HEADERS中定义的信息之外，还有请求和响应的正文及元数据。

1.4.3、如何开启日志打印

1. 编写日志配置类

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

2. 在YML文件中进行相关配置

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

ribbon:
 ReadTimeout:  8000
 ConnectTimeout: 8000

logging:
 level:
   com.atguigu.springcloud.service.PaymentFeignService: debug

3. 测试结果

4. 包结构图示

总结 

来源：https://blog.csdn.net/weixin_56727438/article/details/122376151