Spring Cloud OpenFeign 的 5 個優化小技巧!

OpenFeign 是 Spring 官方推出的一種聲明式服務調用和負載均衡組件。它的出現就是爲了替代已經進入停更維護狀態的 Feign(Netflix Feign),同時它也是 Spring 官方的頂級開源項目。我們在日常的開發中使用它的頻率也很高,而 OpenFeign 有一些實用的小技巧,配置之後可以讓 OpenFeign 更好的運行,所以本文我們就來盤點一下(也歡迎各位老鐵評論區留言補充)。

1.超時優化

OpenFeign 底層內置了 Ribbon 框架,並且使用了 Ribbon 的請求連接超時時間和請求處理超時時間作爲其超時時間,而 Ribbon 默認的請求連接超時時間和請求處理超時時間都是 1s,如下源碼所示:
image.png
所有當我們使用 OpenFeign 調用了服務接口超過 1s,就會出現以下錯誤:
image.png
因爲 1s 確實太短了,因此我們需要手動設置 OpenFeign 的超時時間以保證它能正確的處理業務。
OpenFeign 的超時時間有以下兩種更改方法:

  1. 通過修改 Ribbon 的超時時間,被動的修改 OpenFeign 的超時時間。

  2. 直接修改 OpenFeign 的超時時間(推薦使用)。

    1.1 設置Ribbon超時時間

    在項目配置文件 application.yml 中添加以下配置:

    ribbon:
    ReadTimeout: 5000 # 請求連接的超時時間
    ConnectionTimeout: 10000 # 請求處理的超時時間
    

    1.2 設置OpenFeign超時時間

    在項目配置文件 application.yml 中添加以下配置:

    feign:
    client:
     config:
       default: # 設置的全局超時時間
         connectTimeout: 2000 # 請求連接的超時時間
         readTimeout: 5000 # 請求處理的超時時間
    

    推薦使用此方式來設置 OpenFeign 的超時時間,因爲這樣的(配置)語義更明確。

    2.請求連接優化

    OpenFeign 底層通信組件默認使用 JDK 自帶的 URLConnection 對象進行 HTTP 請求的,因爲沒有使用連接池,所以性能不是很好。我們可以將 OpenFeign 的通訊組件,手動替換成像 Apache HttpClient 或 OKHttp 這樣的專用通信組件,這些的專用通信組件自帶連接池可以更好地對 HTTP 連接對象進行重用與管理,同時也能大大的提升 HTTP 請求的效率。接下來我以 Apache HttpClient 爲例,演示一下專用通訊組件的使用。

    2.1 引入Apache HttpClient依賴

    在項目的依賴管理文件 pom.xml 中添加以下配置:

    <!-- 添加 openfeign 框架依賴 -->
    <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
    <!-- 添加 httpclient 框架依賴 -->
    <dependency>
     <groupId>io.github.openfeign</groupId>
     <artifactId>feign-httpclient</artifactId>
    </dependency>
    

    2.2 開啓Apache HttpClient使用

    啓動 Apache HttpClient 組件,在項目配置文件 application.yml 中添加以下配置,:

    feign:
    client:
     httpclient: # 開啓 HttpClient
       enabled: true
    

    驗證 Apache HttpClient 配置是否生效,可以在 feign.SynchronousMethodHandler#executeAndDecode 方法上打斷點就可以看到了,如下圖所示:
    image.png

    3.數據壓縮

    OpenFeign 默認不會開啓數據壓縮功能,但我們可以手動的開啓它的 Gzip 壓縮功能,這樣可以極大的提高寬帶利用率和加速數據的傳輸速度,在項目配置文件 application.yml 中添加以下配置:

    feign:
    compression:
     request:
       enabled: true # 開啓請求數據的壓縮功能
       mime-types: text/xml,application/xml, application/json # 壓縮類型
       min-request-size: 1024 # 最小壓縮值標準,當數據大於 1024 纔會進行壓縮
     response:
       enabled: true # 開啓響應數據壓縮功能
    

    PS:如果服務消費端的 CPU 資源比較緊張的話,建議不要開啓數據的壓縮功能,因爲數據壓縮和解壓都需要消耗 CPU 的資源,這樣反而會給 CPU 增加了額外的負擔,也會導致系統性能降低。

4.負載均衡優化

OpenFeign 底層使用的是 Ribbon 做負載均衡的,查看源碼我們可以看到它默認的負載均衡策略是輪詢策略,如下圖所示:
image.png
然而除了輪詢策略之外,我們還有其他 6 種內置的負載均衡策略可以選擇,這些負載均衡策略如下:

  1. 權重策略:WeightedResponseTimeRule,根據每個服務提供者的響應時間分配一個權重,響應時間越長,權重越小,被選中的可能性也就越低。它的實現原理是,剛開始使用輪詢策略並開啓一個計時器,每一段時間收集一次所有服務提供者的平均響應時間,然後再給每個服務提供者附上一個權重,權重越高被選中的概率也越大。
  2. 最小連接數策略:BestAvailableRule,也叫最小併發數策略,它是遍歷服務提供者列表,選取連接數最小的⼀個服務實例。如果有相同的最小連接數,那麼會調用輪詢策略進行選取。
  3. 區域敏感策略:ZoneAvoidanceRule,根據服務所在區域(zone)的性能和服務的可用性來選擇服務實例,在沒有區域的環境下,該策略和輪詢策略類似。
  4. 可用敏感性策略:AvailabilityFilteringRule,先過濾掉非健康的服務實例,然後再選擇連接數較小的服務實例。
  5. 隨機策略:RandomRule,從服務提供者的列表中隨機選擇一個服務實例。
  6. 重試策略:RetryRule,按照輪詢策略來獲取服務,如果獲取的服務實例爲 null 或已經失效,則在指定的時間之內不斷地進行重試來獲取服務,如果超過指定時間依然沒獲取到服務實例則返回 null。

出於性能方面的考慮,我們可以選擇用權重策略或區域敏感策略來替代輪詢策略,因爲這樣的執行效率最高。

5.日誌級別優化

OpenFeign 提供了日誌增強功能,它的日誌級別有以下幾個:

  • NONE:默認的,不顯示任何日誌。
  • BASIC:僅記錄請求方法、URL、響應狀態碼及執行時間。
  • HEADERS:除了 BASIC 中定義的信息之外,還有請求和響應的頭信息。
  • FULL:除了 HEADERS 中定義的信息之外,還有請求和響應的正文及元數據。

我們可以通過配置文件來設置日誌級別,配置信息如下:

logging:
  level:
    cn.myjszl.service: debug

其中 cn.myjszl.service 爲 OpenFeign 接口所在的包名。雖然 OpenFeign 默認是不輸出任何日誌,但在開發階段可能會被修改,因此在生產環境中,我們應仔細檢查並設置合理的日誌級別,以提高 OpenFeign 的運行效率

總結

OpenFeign 是 Spring 官方推出的一種聲明式服務調用和負載均衡組件,在生產環境中我們可以通過以下配置來優化 OpenFeign 的運行:

  1. 修改 OpenFeign 的超時時間,讓 OpenFeign 能夠正確的處理業務;
  2. 通過配置專用的通信組件 Apache HttpClient 或 OKHttp,讓 OpenFeign 可以更好地對 HTTP 連接對象進行重用和管理,以提高其性能;
  3. 開啓數據壓縮功能,可以提高寬帶利用率和加速數據傳輸速度;
  4. 使用合適的負載均衡策略來替換默認的輪詢負載均衡策略,已獲得更好的執行效率;
  5. 檢查生成環境中 OpenFeign 的日誌級別,選擇合適的日誌輸出級別,防止無效的日誌輸出。

參考 && 鳴謝

juejin.cn/post/7010555899240513543

是非審之於己,譭譽聽之於人,得失安之於數。

公衆號:Java中文社羣

Java面試合集:https://gitee.com/mydb/interview

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章