OpenFeign常用配置
- 快速入门:
- 1、引入依赖
- 2、启用OpenFeign
- 实践
- 1、引入依赖
- 2、开启连接池功能
- 3、模块划分
- 4、日志
- 5、重试
快速入门:
OpenFeign是一个声明式的http客户端,是spring cloud在eureka公司开源的feign基础上改造而来。其作用及时基于springmvc的常见注解,帮我们优雅的实现http请求的发送。
以下配置都是基于各自项目基础上的,因此这里不会将所有配置都罗列出来,取决于各自项目配置。
OpenFeign已经被SpringCloud自动装配,实现起来比较简单:
1、引入依赖
包括OpenFeign和负载均衡组件SpringCloudLoadbalancer,版本问题都在顶级pom文件定义,此处不在展示
<!--OpenFeign-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<!--负载均衡-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>
2、启用OpenFeign
通过@EnableFeignClients注解,启用OpenFeign功能,例如Gateway模块启动类
说明:
basePackages:指定OpenFeign接口路径
defaultConfiguration:指定OpenFeign配置类,具体查看项目源码
实践
OpenFeign对http请求做了优雅的伪装,不过其底层发起http请求,依赖于其它的框架。这些框架可以自己选择,包括以下三种:
HttpURLConnection:默认实现,不支持连接池
Apache HttpClient:支持连接池
OKHttp:支持连接池
具体源码可参考FeignBlockingLoadBalancerClient类中的delegate成员变量。
整合,OpenFeign整合OKHttp的步骤如下:
1、引入依赖
在快速入门的基础上引入以下依赖使用连接池
<!--okhttp-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
</dependency>
2、开启连接池功能
3、模块划分
单独增加存放远程调用接口模块 edu-api
需要在对应业务模块引入且启动类需要增加包路径指定(包路径一致可忽略),否则启动报错,例如在gateway网关模块pom文件引入
<!--edu-api模块-->
<dependency>
<groupId>com.xxw.itsx</groupId>
<artifactId>edu-api</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些FeignClient无法使用,有两种方案解决:
方案一:指定FeignClient所在包
方式二:指定FeignClient字节码
4、日志
OpenFeign只会在FeignClient所在包的日志级别为debug时,才会输出日志。而且其日志级别由4级:
NONE:不记录任何日志信息,这是默认值
BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
HEADERS:在BASIC的基础上,额外记录了请求和响应头的信息
FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据
备注:由于Feign默认的日志级别时NONE,所以默认我们看不到请求日志。
要自定义日志级别需要声明一个类型为Logger.Level的Bean,在其中定义日志级别:
此时这个bean并未生效,在对应的类没有加配置类注解,要想配置某个FeignClient的日志,可以直接在@FeignClient注解中声明
如果想要全局配置,让所有FeignClient都按照这个日志配置,则需要在@EnableFeignClients注解中声明
5、重试
重试配置,额外增加一个bean即可,如下