【Spring Cloud】详解Feign常用配置

3,835 阅读3分钟

1 Feign常用配置

搭载着Spring Cloud的顺风车,Feign正以席卷之势成为使用Spring架构的大大小小互联网公司发起HTTP调用的首选框架。基于接口的声明式定义、客户端负载均衡、断路器和后备方法(fallback)是Feign相对上一代HTTP调用框架(比如Spring Template,Apache HttpClient)的四大优势。

类似于Retrofit和OkHttp的关系,Feign实际上是对普通HTTP客户端的一层封装,其目的是降低集成成本、提升可靠性。Feign支持三种HTTP客户端,包括JDK自带的HttpURLConnection、Apache HttpClient和Square OkHttp,默认使用Apache HttpClient。

  • HttpURLConnection:不支持线程池,一般不会选用。
  • HttpClient:相比OkHttp,HttpClient并没有明显的优势,可能是因为使用更广泛,所以被Feign选为默认实现。从5.0版本开始才支持HTTP/2。
  • OkHttp:开发Android应用的首选HTTP客户端,支持HTTP/2,通过设置feign.okhttp.enabled=true启用。

Feign提供了两大类配置属性来配置上述三种HTTP客户端,feign.client.*feign.httpclient.*,前者支持按实例进行配置(注解-1),后者全局共享一套配置,包含线程池配置,但只影响HttpClient和OkHttp,不影响HttpURLConnection,具体关系见下表。

注解-1:所谓按实例进行配置,就是指每个FeignClient实例都可以通过feign.client.<feignClientName>.*来单独进行配置,注意首字母小写。而feign.client.default.*表示默认配置。

HTTP客户端 连接超时时间 请求超时时间 线程存活时间 线程池最大连接数(全局) 线程池最大连接数(单个HOST)
HttpURLConnection feign.client.[default|<feignClientName>].connect-timeout
默认值:10秒
feign.client.[default|<feignClientName>].read-timeout
默认值:60秒
N/A N/A N/A
HttpClient feign.httpclient.connection-timeout
默认值:2秒
默认值:-1(RequestConfig.Builder.socketTimeout) feign.httpclient.time-to-live
默认值:900秒
feign.httpclient.max-connections
默认值:200
feign.httpclient.max-connections-per-route
默认值:50
OkHttp feign.httpclient.connection-timeout
默认值:2秒
feign.client.[default|<feignClientName>].read-timeout
默认值:10秒
feign.httpclient.time-to-live
默认值:900秒
feign.httpclient.max-connections
默认值:200
N/A

从上表可以看到,Feign提供了两个连接超时配置,HttpURLConnection使用feign.client.[default|<feignClientName>].connect-timeout,而HttpClient和OkHttp则使用feign.httpclient.connection-timeout,这一点要尤其注意。

2 启用Hystrix

通过设置feign.hystrix.enabled=true可以启用Feign的断路器支持(基于Hystrix)。跟Feign一样,Hystrix也支持按实例进行配置,详细配置属性参见官方文档

由于Hystrix默认的请求超时时间为1秒,很容易触发超时异常,所以往往需要调大。调大超时时间有两种方式,

  • 第一种方式,通过hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds设置默认超时时间,影响所有请求。
  • 第二种方式,如果你不想改变所有请求的超时时间,那么可以通过hystrix.command.<HystrixCommandKey>.execution.isolation.thread.timeoutInMilliseconds单独设置某个Hystrix Command的超时时间。那么问题来了,Feign下面,这个Hystrix Command Key到底是什么呢,是和Feign Client Name一样吗?答案是否定的。Feign下面,一个Hystrix Command对应的是Feign Client的一个方法,因此Hystrix Command Key的定义为<FeignClientName>#<methodName>(<arg1ClassName>,<arg2ClassName>...),注意首字母大写,详见SetterFactory.Default#create()方法。

3 小结

不管是Spring还是Spring Cloud,由于整个生态过于庞大,因此即便是官方文档,也只能勉强覆盖各个组件的大体框架,一旦深入细节就只能靠开发者自己研读源码来寻找答案。就像Linus Torvalds说的,Talk is cheap. Show me the code.

4 参考