Feign是Netflix开发的声明式、模板化的HTTP客户端,且内部也支持负载均衡。Feign是在Ribbon的基础上进行了一次改进,Feign本身已经集成了Ribbon依赖和自动配置,因此我们不需要额外引入依赖,也不需要再注册RestTemplate对象。
- Feign可以帮助我们更加便携、优雅的调用HTTP API
- 在Spring Cloud中,使用Feign非常简单【创建一个接口,添加相应注解就完事了】
- Feign支持多种注解,例如Feign自带的注解和JAX-RS注解等
- Spring Cloud对Feign进行了增强,使Feign支持SpringMVC注解,并整合了Ribbon和Eureka,从而使Feign的使用更加方便
Feign的使用
项目案例:传送门
- 引入依赖
- 配置调用接口
- 在启动类上激活Feign
- 通过自定义的接口调用远程微服务
引入依赖
<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-openfeign -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<!-- <version>2.2.0.RELEASE</version> -->
</dependency>
配置调用接口
声明需要调用的微服务名称
@FeignClient
- name:远程服务提供者的名称
配置需要调用的微服务接口
在启动类上激活Feign
@EnableFeignClients
通过自定义接口调用远程微服务
Feign的高级使用
Feign的配置
从Spring Cloud Edgware开始,Feign支持使用属性自定义Feign。对于一个指定名称的Feign Client(例如该Feign Client的名称为 feignName ),Feign支持如下配置项
feign:
client:
config:
chenfuFeign: #定义FeginClient的名称
# 建立链接的超时时长,相当于Request.Options
connectTimeout: 5000
# 读取超时时长,相当于Request.Options
readTimeout: 5000
# 配置Feign的日志级别,相当于代码配置方式中的Logger
loggerLevel: full
# Feign的错误解码器,相当于代码配置方式中的ErrorDecoder
errorDecoder: com.example.SimpleErrorDecoder
# 配置重试,相当于代码配置方式中的Retryer
retryer: com.example.SimpleRetryer
# 配置拦截器,相当于代码配置方式中的RequestInterceptor
requestInterceptors:
- com.example.FooRequestInterceptor
- com.example.BarRequestInterceptor
# 配置熔断不处理404异常
decode404: false
请求压缩
Spring Cloud Feign支持对请求和相应进行GZIP压缩,以减少通信过程中的性能消耗,通过下面的参数即可开启请求与相应的压缩功能
feign:
compression:
request:
enabled: true # 开启请求压缩
response:
enabled: true # 开启响应压缩
对请求的数据类型,以及触发压缩的大小下限进行设置:
# 下面的数据类型、压缩大小下限均为默认值
feign:
compression:
request:
enabled: true # 开启请求压缩
# 设置压缩的数据类型
mime-types: text/html,application/xml,application/json
# 设置触发压缩的大小下限
min-request-size: 2048
日志级别
在开发或者运行阶段往往希望看到Feign请求过程的日志记录,默认情况下Feign的日志是没有开启的。 要想用属性配置方式来达到日志效果,只需在 application.yml 中添加如下内容即可
feign:
client:
config:
shop-service-item:
loggerLevel: FULL
logging:
level:
top.chenfu.fegin.ItemFeginClient: debug
- logging.level.xx : debug : Feign日志只会对日志级别为debug的做出响应
- feign.client.config.shop-service-item.loggerLevel : 配置Feign的日志Feign有四种日志级别:
-
- NONE【性能佳,适用于生产】:不记录任何日志(默认值)
-
- BASIC【适用于生产环境追踪问题】:仅记录请求方法、URL、响应状态代码以及执行时间
-
- HEADERS:记录BASIC级别的基础上,记录请求和响应的header。
-
- FULL【比较适用于开发及测试环境定位问题】:记录请求和响应的header、body和元数据。
Feign和Ribbon的联系
- Ribbon是一个基于 HTTP 和 TCP 客户端的负载均衡的工具。它可以在客户端配置 RibbonServerList(服务端列表),使用 HttpClient 或 RestTemplate 模拟http请求,步骤相当繁琐。
- Feign 是在 Ribbon的基础上进行了一次改进,是一个使用起来更加方便的 HTTP 客户端。采用接口的方式, 只需要创建一个接口,然后在上面添加注解即可 ,将需要调用的其他服务的方法定义成抽象方法即可,不需要自己构建http请求。然后就像是调用自身工程的方法调用,而感觉不到是调用远程方法,使得编写客户端变得非常容易