[圖片上傳失敗...(image-883e28-1653318905408)]
背景
前段時間同事碰到一個問題,需要在 SpringCloud
的 Feign 調用中使用自定義的 URL辐怕;通常情況下是沒有這個需求的乾翔;畢竟都用了 SpringCloud
的了麻裁,那服務之間的調用都是走注冊中心的,不會需要自定義 URL 的情況。
但也有特殊的须肆,比如我們這里碰到 ToB
場景,需要對每個商戶自定義的 URL
進行調用桩皿。
雖說也可以使用原生的 Feign
甚至是自定義一個 OKHTTP Client
實現(xiàn)豌汇,但這些方案都得換一種寫法;
打算利用現(xiàn)有的 SpringCloud
OpenFeign
來實現(xiàn)泄隔,畢竟原生的 Feign 其實是支持該功能的拒贱,而 SpringCloud OpenFeign
也只是在這基礎上封裝了一層。
[圖片上傳失敗...(image-fd4006-1653318905409)]
只需要在接口聲明處加上一個 URI
參數(shù)即可佛嬉,這樣就可以在每次調用時傳遞不同的 URI
來實現(xiàn)動態(tài) URL
的目的逻澳。
想法很簡單,但實踐起來卻不是那么回事了暖呕。
偽代碼如下:
@FeignClient(name = "dynamic")
interface DynamicClient {
@GetMapping("/")
String get(URI uri);
}
dynamicClient.get(URI.create("https://github.com"));
執(zhí)行后會拋出負載均衡的異常:
java.lang.RuntimeException: com.netflix.client.ClientException:
Load balancer does not have available server for client: github.com
這個異常也能理解斜做,就是找不到 github 這個服務;找不到也是合理的湾揽,畢竟也不是一個內部注冊的服務瓤逼。
但按照 Feign
的官方介紹笼吟,只要接口中聲明了 URI
這個參數(shù)就能自定義,同時我自己也用原生的 Feign 測試過確實沒什么問題抛姑。
Debug
那問題只能出在 SpringCloud OpenFeign
的封裝上了赞厕;經(jīng)過同事的搜索在網(wǎng)上找到一篇博客解決了這個問題。
https://www.cnblogs.com/syui-terra/p/14386188.html
[圖片上傳失敗...(image-e67db5-1653318905409)]
按照文中的說法定硝,確實只需要加上 URL 參數(shù)同時有值就可以了皿桑,但原因不明。
本著打破砂鍋問到底的精神蔬啡,我個人也想知道 OpenFeign
是如何處理的诲侮,只要 url 有值就可以,這完全是個黑盒箱蟆,而且在官方的注釋中并沒有對這種情況有特殊說明沟绪。
所以我準備從源碼中找到答案。
既然是 url 有值就能正常運行空猜,那一定是在運行過程中獲取了這個值绽慈;
[圖片上傳失敗...(image-7c7d5a-1653318905409)]
但我在源碼中查看 url 所使用的地方,并沒有在單測之外找到哪里有所應用辈毯,說明源碼中并沒有直接調用 url()
這個函數(shù)來獲取值坝疼。
但 org.springframework.cloud.openfeign.FeignClient
這個注解總會使用吧,于是我又查詢這個注解的使用情況谆沃。
[圖片上傳失敗...(image-4e7eb1-1653318905409)]
最終在這里查到了使用的痕跡钝凶。
這里查閱源碼時也有一些小技巧,比如如果我們直接查詢時唁影,IDEA 默認的查詢范圍是整個項目和所有依賴庫耕陷,會有許多干擾信息。
比如我這里就需要只看項目源碼据沈,單測這些都不用看哟沫;所以在查詢的時候可以過濾一下,這樣干擾信息就會少很多锌介。
[圖片上傳失敗...(image-5bee4e-1653318905409)]
左邊的工具欄還有許多過濾條件嗜诀,大家可以自行研究一下。
接著從源碼中進行閱讀掏湾,會發(fā)現(xiàn)是將 @FeignClient
中的所有數(shù)據(jù)都寫到一個 Map
里進行使用的。
[圖片上傳失敗...(image-62c7fa-1653318905409)]
最終會發(fā)現(xiàn)這個 url 被寫入到了 FeignClientFactoryBean
中的 url 成員變量中了肿嘲。
查看哪里在使用這個 url 就知道背后的原理了融击。
[圖片上傳失敗...(image-1b3708-1653318905409)]
在這里打個斷點會發(fā)現(xiàn):當 url 為空時會返回一個 LoadBalance
的 client
,也就是會從注冊中心獲取 url
的客戶端雳窟,而 url
有值時則會獲取一個默認的客戶端尊浪,這樣就不會走負載均衡了匣屡。
所以我們如果想在 OpenFeign 中使用動態(tài) url 時就得讓 @Feign 的 url 有值才行,無論是什么都可以拇涤。
Feign 的實現(xiàn)
既然已經(jīng)看到這一步了捣作,我也比較好奇 Feign 是如何做到只要有 URI 參數(shù)就使用指定的 URL 呢?
這里也分享一個讀源碼的小技巧鹅士,如果我們跟著程序執(zhí)行的思路去一步步
debug
的話會非常消耗時間券躁,畢竟這類成熟庫的代碼量也不小。
這里我們從官方文檔中可以得知只要在接口參數(shù)中使用了 java.net.URI
便會走自定義的 url掉盅,所以我們反過來只要在源碼中找到哪里在使用 java.net.URI
便能知道關鍵源碼也拜。
畢竟使用 java.net.URI
的場景也不會太多。
[圖片上傳失敗...(image-8f8bd5-1653318905409)]
所以只需要在這個依賴的地方 cmd+shift+f
全局搜索 java.net.URI
就能查到結果趾痘,果然不多慢哈,只有兩處使用。
[圖片上傳失敗...(image-2a7ee3-1653318905409)]
再結合使用場景猜測大概率是判斷參數(shù)中是否是有 URL.class
這樣的條件永票,或者是 url 對象卵贱;總之我們先用
URL
這樣關鍵字在這兩個文件中搜索一下,記得勾選匹配大小寫侣集;最后會發(fā)現(xiàn)的確是判斷了參數(shù)中是否有 URL
這個類键俱,同時將這個索引位置記錄了下來。
想必后續(xù)會通過這個索引位置讀取最終的 url
信息肚吏。
[圖片上傳失敗...(image-17ccf-1653318905409)]
最終通過這個索引的使用地方查詢到了核心源碼方妖,如果有值時就取這個 URI 中所指定的地址作為 target
。
到此為止這個問題的背后原理都已經(jīng)分析完畢了罚攀。
總結
其實本文重點是分析了一些 debug
和閱讀源碼的一些小技巧党觅,特別是在讀關于 Spring
相關的代碼時一定不能 debug 跟蹤到細節(jié)中,因為調用鏈通常是很長的斋泄,稍不留神就把自己都繞暈了杯瞻,只需要知道核心、關鍵源碼是如何處理的即可炫掐。
最后對于 OpenFeign 處理動態(tài) url 的方案確實也有些疑惑魁莉,是一個典型的約定大于配置
的場景,但問題就在于我們并不知道這個約定是 @Feign
的 url 得有值募胃。
所以我也提了一個 PR
給 OpenFeign
旗唁,感興趣的朋友也可以查看一下:
https://github.com/spring-cloud/spring-cloud-openfeign/pull/713