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即可,如下