Spring Cloud OpenFeign 是声明式的服务调用工具,它整合了Ribbon和Hystrix,拥有负载均衡和服务容错功能,本文将对其用法进行详细介绍。
SpringCloud实战电商项目mall-swarm(5.1k+star)地址:https://github.com/macrozheng/mall-swarm
Feign简介
Feign是声明式的服务调用工具,我们只需创建一个接口并用注解的方式来配置它,就可以实现对某个服务接口的调用,简化了直接使用RestTemplate来调用服务接口的开发量。Feign具备可插拔的注解支持,同时支持Feign注解、JAX-RS注解及SpringMvc注解。当使用Feign时,Spring Cloud集成了Ribbon和Eureka以提供负载均衡的服务调用及基于Hystrix的服务容错保护功能。
创建一个feign-service模块
这里我们创建一个feign-service模块来演示feign的常用功能。
在pom.xml中添加相关依赖
<dependency>
在application.yml中进行配置
server
在启动类上添加@EnableFeignClients注解来启用Feign的客户端功能
@EnableFeignClients
添加UserService接口完成对user-service服务的接口绑定
我们通过@FeignClient注解实现了一个Feign客户端,其中的value为user-service表示这是对user-service服务的接口调用客户端。我们可以回想下user-service中的UserController,只需将其改为接口,保留原来的SpringMvc注释即可。
/**
添加UserFeignController调用UserService实现服务调用
/**
负载均衡功能演示
- 启动eureka-service,两个user-service,feign-service服务,启动后注册中心显示如下:
- 多次调用http://localhost:8701/user/1进行测试,可以发现运行在8201和8202的user-service服务交替打印如下信息:
9236 ---
Feign中的服务降级
Feign中的服务降级使用起来非常方便,只需要为Feign客户端定义的接口添加一个服务降级处理的实现类即可,下面我们为UserService接口添加一个服务降级实现类。
添加服务降级实现类UserFallbackService
需要注意的是它实现了UserService接口,并且对接口中的每个实现方法进行了服务降级逻辑的实现。
/**
修改UserService接口,设置服务降级处理类为UserFallbackService
修改@FeignClient注解中的参数,设置fallback为UserFallbackService.class即可。
@FeignClient
修改application.yml,开启Hystrix功能
feign
服务降级功能演示
- 关闭两个user-service服务,重新启动feign-service;
- 调用http://localhost:8701/user/1进行测试,可以发现返回了服务降级信息。
日志打印功能
Feign提供了日志打印功能,我们可以通过配置来调整日志级别,从而了解Feign中Http请求的细节。
日志级别
- NONE:默认的,不显示任何日志;
- BASIC:仅记录请求方法、URL、响应状态码及执行时间;
- HEADERS:除了BASIC中定义的信息之外,还有请求和响应的头信息;
- FULL:除了HEADERS中定义的信息之外,还有请求和响应的正文及元数据。
通过配置开启更为详细的日志
我们通过java配置来使Feign打印最详细的Http请求日志信息。
/**
在application.yml中配置需要开启日志的Feign客户端
配置UserService的日志级别为debug。
logging
查看日志
调用 http:// localhost:8701/user/1 进行测试,可以看到以下日志。
5204 ---
Feign的常用配置
Feign自己的配置
feign
Feign中的Ribbon配置
在Feign中配置Ribbon可以直接使用Ribbon的配置,具体可以参考Spring Cloud Ribbon:负载均衡的服务调用。
Feign中的Hystrix配置
在Feign中配置Hystrix可以直接使用Hystrix的配置,具体可以参考Spring Cloud Hystrix:服务容错保护。
使用到的模块
springcloud
项目源码地址
https://github.com/macrozheng/springcloud-learning