微服务+springcloud+springcloud alibaba学习笔记【OpenFeign的使用】(5/9)
上章中提到Ribbon停更不停用了，OpenFeign是对Ribbon进一步的简化和封装（接口+注解）
1、OpenFeign简介
1.1、Feign及OpenFeign概念和作用
Feign是一个声明式的web客户端,只需要创建一个接口,添加注解即可完成微服务之间的调用；使用Feign能让编写web service客户端更加简单。
它的作用方法是定义一个服务接口，然后在上面添加注解。feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装，使其支持了Spring MVC标准注解和Http MessageConverters。Feign可以在与Eureka和Ribbon组合使用来支持负载均衡。
Feign集成了Ribbon、RestTemplate实现了负载均衡的执行Http调用，只不过对原有的方式（Ribbon+RestTemplate）进行了封装，开发者不必手动使用RestTemplate调服务，而是定义一个接口，在这个接口中标注一个注解即可完成服务调用，这样更加符合面向接口编程的宗旨，简化了开发。
就是A要调用B,Feign就是在A中创建一个一模一样的B对外提供服务的的接口,我们调用这个接口,就可以服务到B
1.2、Feign和OpenFeign区别
2、OpenFeign使用步骤
2.1、创建Feign消费端微服务
项目模块名称为：Cloud-order-feign80
2.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>springcloud2023</artifactId>
<groupId>com.tigerhhzz.springcloud</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>Cloud-order-feign80</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.uclass.springcloud</groupId>
<artifactId>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>
</project>
查看项目依赖，可以看到：openfeign天生就继承了ribbon，也具备了ribbon的负载均衡能力。
2.3、编写yml配置文件
server:
port: 80
spring:
application:
name: Cloud-consumer-feign-order80
eureka:
client:
register-with-eureka: true
fetch-registry: true
service-url:
# defaultZone: http://localhost:7001/eureka/ #单机版
defaultZone: http://localhost:7001/eureka/,http://localhost:7002/eureka/ #集群版
2.4、编写主启动类
类上添加 @EnableFeignClients 注解，表示 Feign 客户端
package com.tigerhhzz.springcloud;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;
@Slf4j
@EnableFeignClients //激活对Feign的使用
@SpringBootApplication
public class OrderFeignMain80 {
public static void main(String[] args) {
SpringApplication.run(OrderFeignMain80.class, args);
log.info("OrderFeignMain80启动成功~~~~~~~~~~~~~~~~~~~");
}
}
2.5、编写业务类
业务逻辑接口+@FeignClient注解配置调用provider8001或者8002服务。
2.5.1、编写 service 层接口，用于服务提供者接口的远程调用
service层：注意添加 @FeignClient(value = “cloud-payment-service”) 注解，其中value值表示需要远程调用的微服务名称。
package com.tigerhhzz.springcloud.service;
import com.tigerhhzz.springcloud.entities.CommonResult;
import com.tigerhhzz.springcloud.entities.Payment;
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 tigerhhzz
* @date 2023/4/11 15:27
*/
@Component
@FeignClient(value = "cloud-provider-service") //需要寻找的微服务名称
public interface PaymentFeignService {
@GetMapping(value = "/payment/{id}")
public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
}
2.5.2、编写 controller 层，用于url映射和service调用
package com.tigerhhzz.springcloud.controller;
import com.tigerhhzz.springcloud.entities.CommonResult;
import com.tigerhhzz.springcloud.entities.Payment;
import com.tigerhhzz.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;
@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);
}
}
说明：80模块启动后，客户端访问地址是/consumer/payment/get/{id}，首先找自己的访问接口层 2.5.1中写的PaymentFeignService 接口，通过注解@FeignClient(value = “cloud-provider-service”)去Eureka注册中心中找服务名称为"cloud-provider-service"的微服务接口，它的调用接口是8001模块提供对外暴露出来的@GetMapping(value = “/payment/{id}”)接口；中间隔了一层openfeign接口。
2.6、测试
访问接口，并测试openfeign带有负载均衡的功能。
- 先启动2个Eureka集群7001/7002
- 再启动2个微服务8001/8002
- 启动OpenFeign模块OrderFeignMain80
- 访问地址：http://localhost/consumer/payment/get/1
Feign默认使用ribbon实现负载均衡，得到结果（Feign自带负载均衡配置项）
3、OpenFeign超时机制
3.1、超时情况
OpenFeign默认等待时间是1秒,超过1秒,直接报错
3.2、设置超时时间
application.yaml 配置文件中，设置超时时长：
#设置feign客户端超时时间（OpenFeign默认支持ribbon）
ribbon:
# 表示建立连接后从服务器读取到可用资源，所用时间
ReadTimeout: 5000
# 表示建立连接时间，适用于网络正常的情况下，两端连接所用时间
ConnectTimeout: 5000
因为OpenFeign的底层是ribbon进行负载均衡,所以它的超时时间是由ribbon控制。
4、OpenFeign 日志打印
对 Feign 接口的调用情况进行监控和输出，通过配置，调整日志级别，从而了解 Feign 中 Http 请求的细节。
4.1、日志级别
- NONE：默认的，不显示任何日志
- BASIC：仅记录请求方法、URL、响应状态码及执行时间
- HEADERS：除了 BASIC 中定义的信息外，还有请求和响应的头信息
- FULL：除了 HEADERS 中定义的信息外，还有请求和响应的正文及元数据
4.2、使用OpenFeign的日志:
实现在配置类中添加OpenFeign的日志类
注意：Logger 引入的是 import feign.Logger 包下的
@Configuration
public class FeignConfig {
@Bean
Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
}
4.3、为指定类设置日志级别
YML文件里需要开启日志的Feign客户端
logging:
level:
#feign日志以什么级别监控哪个接口
com.uclass.springcloud.service.PaymentFeignService: debug