6_OpenFeign实现服务调用
????写在前面:
- 前面我们使用 Eureka 注册中心注册服务,在服务端使用 Ribbon + RestTemplate模板进行服务调用,但是如果想要调取服务提供者提供的多个服务,一个一个进行方法调用岂不是比较麻烦 ?
- Feign 使用在客户端还是服务端 ?
- 为什么说Feign只需要一个接口一个注解就可实现服务调用 ?
- Feign 和 OpenFeign 有什么不一样 ?
- 使用了OpenFeign 会不会出现调取不到服务的情况 ?
- 如果想要查看 OpenFeign 的详细调用情况,该怎么办 ?
关于Feign的停更,目前已经使用OpenFeign进行替换!!!
6_OpenFeign实现服务调用
概述
Feign 是一个声明式 WebService 客户端。使用 Feign 能让编写WebService 客户端更加简单。
它的使用方法是定义一个服务接口然后在上面添加注解。Feign 也支持可插拔式的编码和解码器。Spring Cloud 对 feign 进行了封装,使其支持了 Spring MVC 标准注解和HttpMessageConverters。Feign 可以与 Eureka 和 Ribbon 组合使用以支持负载均衡。
Feign的作用
Feign旨在使编写Java Http客户端变得更容易。
前面在使用 Ribbon + RestTemplate 时,利用 RestTemplate 对 http 请求的封装处理,形成了一套模板化的调用方法。但是在实际开发中,由于对服务依赖的调用可能不止一处,往往一个接口会被多处调用,所以通常都会针对每个微服务自行封装一些客户端来包装这些依赖,所以 Feign 在这个基础上做了进一步封装,由他来帮助我们定义和实现依赖服务的接口定义。 在 F e i g n 的 实 现 下 , 我 们 只 需 要 创 建 一 个 接 口 , 并 使 用 注 解 的 方 式 来 配 置 它 \color{green}{在 Feign 的实现下,我们只需要创建一个接口,并使用注解的方式来配置它} 在Feign的实现下,我们只需要创建一个接口,并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解,现在是微服务接口上标注一个 Feign 注解),即可完成服务提供方的接口绑定,简化了使用 Spring Cloud Ribbon时,自动封装服务调用客户端的开发量。
Feign集成Ribbon
利用 Ribbon 维护了 Payment 的服务列表信息,并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是, 通 过 F e i g n 只 需 要 定 义 服 务 绑 定 接 口 且 声 明 式 的 方 法 , 优 雅 而 简 单 的 实 现 了 服 务 调 用 。 \color{green}{通过Feign只需要定义服务绑定接口且声明式的方法,优雅而简单的实现了服务调用。} 通过Feign只需要定义服务绑定接口且声明式的方法,优雅而简单的实现了服务调用。
Feign和OpenFeign的区别
Feign | OpenFeign |
---|---|
Feign 是 Spring Cloud 组件中的一种轻量级 RestFul 的 HTTP 服务客户端,Feign 内置了Ribbon,用来做客户端的负载均衡,去调用服务注册中心的服务,Feign的使用方式是:使用 Feign的注解定义接口,调用这个接口,就可以调用服务注册中心的服务 | OpenFeign 是 Spring Cloud 在 Feign 的基础上支持了 SpringMVC 的注解,如 @RequestMapping 等等,OpenFeign 的 @FeignClient 可以解析SpringMVC的 @RequestMapping 注解下的接口,并通过动态代理的方法生产实现类,实现类中做均衡并调用其它服务 |
spring-cloud-starter-feign | spring-cloud-starter-openfeign |
OpenFeign使用步骤
1、建 Module:cloud-consumer-openFeign-order80
2、改 POM
引入:
<!--openfeign-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>
完整版:
<?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_yang</artifactId>
<groupId>org.example</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>cloud-consumer-openFeign-order80</artifactId>
<dependencies>
<!--openfeign-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>
<!--eureka client-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.example</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>
3、建 YML
# 端口号【openfeign 也是使用在客户端,集成了ribbon】
server:
port: 80
eureka:
client:
register-with-eureka: false # 不注册进注册中心
service-url:
defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/
4、主启动
使用
@EnableFeignClients
** Feign 组件
@SpringBootApplication
@EnableFeignClients //**并开启feign
public class OpenFeignOrderMain80 {
public static void main(String[] args) {
SpringApplication.run(OpenFeignOrderMain80.class,args);
}
}
5、建业务逻辑接口:PaymentFeignService
service 包下创建 PaymentFeignService 接口
@Component //能够被扫描
@FeignClient(value = "CLOUD-PAYMENT-SERVICE") //配合 EnableFeignClient使用
public interface PaymentFeignService {
//底层实现是一样的,都是封装service层
@GetMapping(value = "/payment/get/{id}")
public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeOut();
}
6、controller
@RestController
@Slf4j
public class PaymentController {
@Resource
private PaymentFeignService paymentFeignService; //表示使用openfeign进行调用
@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(){
//open-feign-ribbon,客户端默认等待一秒钟
return paymentFeignService.paymentFeignTimeOut();
}
}
OpenFeign的超时控制
服务提供者我们进行了睡眠需要超过3秒才能返回数据,但是服务调用者默认只等待1秒,这就会出现超时问题。
这是因为默认 Feign 客户端只等待一秒钟,但是服务端处理需要超过3秒钟,导致 Feign 客户端不想等待了,直接返回报错,这个时候,消费方的 OpenFeign 就需要增大超时时间
引入:
# 设置feign客户端超时时间(OpenFeign默认支持ribbon)
ribbon:
# 指的是建立连接所用的时间,适用于网络状态正常的情况下,两端连接所用的时间
ReadTimeout: 5000
# 指的是建立连接后从服务器读取到可用资源所用的时间
ConnectTimeout: 5000
完整版:
# 端口号【openfeign 也是使用在客户端,集成了ribbon】
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 接口的调用情况进行监控和输出。
日志级别
- NONE:默认的,不显示任何日志
- BASIC:仅记录请求方法、URL、相应状态码以及执行时间
- HEADERS:除了BASIC中定义的信息之外,还有请求和响应头的信息
- FULL:除了HEADERS中定义的信息之外,还有请求和相应的正文及元数据
添加配置类:FeignConfig
/**
* @Author: xj0927
* @Description: 配置日志
* @Date Created in 2020-10-28 20:04
*/
@Configuration
public class FeignConfig {
@Bean
Logger.Level feignLoggerLevel(){
return Logger.Level.FULL;//详细日志打印
}
}
改 YML
引入:
logging:
level:
# feign日志以什么级别监控哪个接口
com.xj0927.springcloud.service.PaymentFeignService: debug
完整版:
# 端口号【openfeign 也是使用在客户端,集成了ribbon】
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
logging:
level:
# feign日志以什么级别监控哪个接口
com.xj0927.springcloud.service.PaymentFeignService: debug
此时我发送请求,具体调用的服务细节就会在控制台打印