Feign请求压缩与超时等配置
# Feign请求压缩与超时等配置
本文主要为大家介绍一下Feign相关的一些配置,在开始讲解之前,有一点是我们需要说明的:因为Feign的底层是基于Ribbon实现的,所以Ribbon配置在OpenFeign或者Feign的环境下,依然是生效的。
# 一、如何替换HTTP客户端实现
在之前的章节已经为大家讲过,RestTemplate的底层HTTP客户端实现有三种:
- SimpleClientHttpRequestFactory(封装URLConnection,JDK自带,默认实现)
- HttpComponentsClientHttpRequestFactory(封装第三方类库HttpClient)
- OkHttp3ClientHttpRequestFactory(封装封装第三方类库OKHttp)
Feign 默认底层通过JDK 的java.net.HttpURLConnection
实现了feign.Client
接口类,在每次发送请求的时候,都会创建新的HttpURLConnection 链接,这也就是为什么默认情况下Feign的性能很差的原因。我们可以通过配置,在Feign中使用Apache HttpClient 或者OkHttp3等基于连接池的高性能Http客户端。这个几乎是所有基于Spring Cloud与HTTP的微服务项目提升性能必做的步骤。
# 1.1.HTTPClient
那么如何在Feign中使用HttpClient的框架呢?我们查看FeignAutoConfiguration.HttpClientFeignConfiguration的源码: spring-cloud-netflix-core包中的org.springframework.cloud.netflix.feign.FeignAutoConfiguration.java
- 从代码@ConditionalOnClass({ApacheHttpClient.class})注解可知,需要在pom文件上加上HttpClient的maven依赖
- 需要在配置文件中配置
feign.httpclient.enabled
为true,从@ConditionalOnProperty注解可知,这个配置可以不写,因为在默认情况下就为true。
所以通常我们只需要在pom文件中引入feign-httpclient即可,该包里面包含apache httpclient。
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
2
3
4
# 1.2.使用OkHttp(推荐)
FeignAutoConfiguration.HttpClientFeignConfiguration的源码:
- 从代码@ConditionalOnClass({OkHttpClient.class})注解可知,需要在pom文件上加上HttpClient的maven依赖
- 从@ConditionalOnProperty注解可知,需要在配置文件中配置
feign.okhttp.enabled
为true。
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
</dependency>
2
3
4
# 二、请求压缩
Spring Cloud Feign支持对请求和响应进行GZIP压缩,以提高网络传输效率,配置方式如下:
# 配置请求GZIP压缩
feign.compression.request.enabled=true
# 配置响应GZIP压缩
feign.compression.response.enabled=true
# 配置压缩支持的MIME TYPE
feign.compression.request.mime-types=text/xml,application/xml,application/json
# 配置压缩数据大小的下限
feign.compression.request.min-request-size=2048
2
3
4
5
6
7
8
为什么要配置压缩数据大小的下限?因为压缩操作本身也是要耗时的,对于数据量较小的HTTP请求或响应进行压缩,反而会造成性能下降。
# 三、日志配置
SpringCloudFeign为每一个FeignClient都提供了一个feign.Logger实例。可以根据logging.level.<FeignClient>
参数配置格式来开启Feign客户端的DEBUG日志,其中<FeignClient>
为Feign客户端定义接口的完整路径。如:
logging:
level:
com.zimug.dongbb.cloud.aservice.rbac.feign.SmsService: debug
2
3
然后再在配置类(比如主程序入口类)中加入Looger.Level的Bean
@Bean
public Logger.Level feignLoggerLevel(){
return Logger.Level.FULL;
}
2
3
4
级别 | 说明 |
---|---|
NONE | 不输出任何日志 |
BASIC | 只输出Http 方法名称、请求URL、返回状态码和执行时间 |
HEADERS | 输出Http 方法名称、请求URL、返回状态码和执行时间 和 Header 信息 |
FULL | 记录Request 和Response的Header,Body和一些请求元数据 |
请求日志的打印结果,更加详细,方便我们进行接口调试。
# 四、请求重试
需要注意的是:Ribbon有重试机制(前面章节已经介绍),Feign和OpenFeign也有重试机制。Feign和OpenFeign的底层就是Ribbon。所以当项目使用了Feign或OpenFeign的重试机制,就不要开启Ribbon的重试机制,反之亦然。否则重试配置重叠,实际重试次数是二者的笛卡尔积。
Feign 内置了一个重试器,当HTTP请求出现IO异常时,Feign会有一个最大尝试次数发送请求。重试器有如下几个控制参数:
重试参数 | 说明 | 默认值 |
---|---|---|
period | 初始重试时间间隔,当请求失败后,重试器将会暂停 初始时间间隔(线程 sleep 的方式)后再开始,避免强刷请求,浪费性能 | 100ms |
maxPeriod | 当请求连续失败时,重试的时间间隔将按照:long interval = (long) (period * Math.pow(1.5, attempt - 1)); 计算,按照等比例方式延长,但是最大间隔时间为 maxPeriod, 设置此值能够避免 重试次数过多的情况下执行周期太长 | 1000ms |
maxAttempts | 最大重试次数 | 5 |
具体的代码实现可参考: https://github.com/OpenFeign/feign/blob/master/core/src/main/java/feign/Retryer.java (opens new window)。feign的重试机制默认是关闭的,源码如下
//FeignClientsConfiguration.java
@Bean
@ConditionalOnMissingBean
public Retryer feignRetryer() {
return Retryer.NEVER_RETRY; #不要重试,就是关闭的意思
}
2
3
4
5
6
当没有spring容器中不存在retryer这个实例的时候,会初始化这个bean, NEVER_RETRY(永远不重试)。如果想要开启的话,配置如下:
@Bean
public Retryer feignRetryer() {
return new Retryer.Default();
}
2
3
4
在你的配置类中,添加如上代码就可以开启Feign的重试机制。但是,正如我们前文所讲的,Ribbon有重试机制(前面章节已经介绍),Feign和OpenFeign也有重试机制。二选一,通常使用Ribbon的重试机制即可,不要打开Feign的重试机制。