目錄
前言
參考資料：
《Spring Microservices in Action》
《Spring Cloud Alibaba 微服務原理與實戰》
《B站 尚硅谷 SpringCloud 框架開發教程 周陽》
Feign 是一個聲明式的Web服務客戶端，讓編寫 Web 服務客戶端變得非常容易，只需創建一個接口並在接口上添加注解即可；
1. OpenFeign 基本知識
1.1 Feign 是什么
- Feign 是一個聲明式的 Web 服務客戶端，讓編寫 Web 服務客戶端變得非常容易，只需創建一個接口並在接口上添加注解即可；
- Feign 旨在使編寫 Java HTTP 客戶端變得更容易；
1.2 Feign 的出現解決了什么問題
- 上篇《微服務架構 | 4.1 基於 Ribbon 的負載均衡詳解》在使用 Ribbon + RestTemplate 時，利用 RestTemplate 對 http 請求的封裝處理，有一套模版化的調用方法；
- 但是在實際開發中，由於對服務依賴的調用可能不止一處，往往一個接口會被多處調用，所以通常都會針對每個微服務自行封裝一些客戶端類來包裝這些依賴服務的調用；
- 所以，Feign 在此基礎上做了進一步封裝，由他來幫助我們定義和實現依賴服務接口的定義；
- 在 Feign 的實現下，我們只需創建一個接口並使用注解的方式來配置它（以前是 Dao 接口上面標注 Mapper 注解，現在是一個微服務接口上面標注一個 Feign 注解），即可完成對服務提供方的接口綁定；
- 簡化了使用 Spring cloud Ribbon 時，自動封裝服務調用客戶端的開發量；
1.3 Feign 與 OpenFeign 的區別與對比
| Feign | OpenFeign |
|---|---|
| Feign 是 Spring Cloud 組件中的一個輕量級 RESTful 的 HTTP 服務客戶端。Feign 內置了 Ribbon，用來做客戶端負載均衡，去調用服務注冊中心的服務。Feign 的使用方式是：使用 Feign 的注解定義接口，調用這個接口，就可以調用服務注冊中心的服務； | OpenFeign 是 Spring Cloud 在 Feign 的基礎上支持了 SpringMVC 的注解，如 @RequesMapping 等。OpenFeign 的 @FeignClient 可以解析 SpringMVC 的 @RequestMapping 注解下的接口，並通過動態代理的方式產生實現類，實現類中做負載均衡並調用其他服務； |
| 2018年以前的項目在使用feign | springcloud F 及 F 版本以上基本上使用 openfeign，openfeign 從框架結構上可以看做是2019年 feign 停更后出現版本，可以說大多數新項目在用 openfeign |
| spring-cloud-starter-feign | spring-cloud-starter-openfeign |
- Feign 與 OpenFeign 最大的區別是：前者不支持對 SpringMVC 的注解，而后者支持；
- Feign 默認支持 Ribbon 負載均衡，而 OpenFeign 又是在 Feign 的基礎上發展而來的；
- 詳情可以參考下面：《2.3 在業務接口上添加注解》與《3.3 在業務接口上添加注解》；
2. 在服務消費者端開啟 Feign 支持
消費者對 Feign 客戶端的支持示例同《微服務架構 | 4.1 基於 Ribbon 的負載均衡詳解》一篇中：2.4 使用 Netflix Feign 客戶端調用服務部分；
2.1 引入 pom.xml 依賴
<!--feign-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
</dependency>
2.2 在主程序類上添加注解
@EnableFeignClients：表示開啟並使用 Feign 客戶端；
2.3 在業務接口上添加注解
@FeignClient("provider-instance-name") //標識服務為 feign 的客戶端
public interface ProviderFeignClient {
//定義端點的路徑和動作
@RequestMapping(
method= RequestMethod.GET,
value="/providers/{providerId}",
consumes="application/json")
//定義傳入端點的參數，該方法可以由客戶端調用以觸發組織服務
Provider getProvider(@PathVariable("providerId") String providerId);
}
-
注意：Feign 不支持對 SpringMVC 注解的支持（與 OpenFeign 的最大區別）；
-
接下來完成對業務接口的實現，將接口自動注入 Controller 層並調用接口方法即可；
2.4 在 controller 層調用接口
@RestController
public class ConsumerFeignController{
@Resource
private ProviderFeignClient providerFeignClient;
@GetMapping(value = "/provider/get/{id}")
public Provider getProviderById(@PathVariable("id") Long id){
return providerFeignClient.getProviderById(id);
}
}
3. 在服務消費者端開啟 OpenFeign 支持
3.1 引入 pom.xml 依賴
<!--openfeign-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
3.2 在主程序類上添加注解
@EnableFeignClients：表示開啟並使用 Feign 客戶端（同 Feign）；
3.3 在業務接口上添加注解
@FeignClient：表示開啟並使用 Feign 客戶端；
@Component
@FeignClient(value = "provider-instance-name")
public interface ProviderFeignClient {
@GetMapping(value = "/providers/{providerId}")
Provider getProvider(@PathVariable("providerId") String providerId);
}
-
注意：可以從這里看到 OpenFeign 對 SpringMVC 注解的支持（與 Feign 的最大區別）；
-
接下來的步驟同 Feign，也是：完成對業務接口的實現，將接口自動注入 Controller 層並調用接口方法即可；
-
同《2.4 在 controller 層調用接口》；
4. OpenFeign 的超時控制
- 當客戶端請求超過 1s 是，會報如下錯誤：
- 這是因為 Feign 客戶端默認只等待一秒鍾，當請求時間超過 1s 時，Feign 會給我們返回請求超時頁面；
- 只需修改 yml 文件即可修改默認超時控制；
#設置 feign/openFeign 客戶端超時時間
ribbon:
#指的是建立連接所用的時間，適用於網絡狀況正常的情況下,兩端連接所用的時間
ReadTimeout: 5000
#指的是建立連接后從服務器讀取到可用資源所用的時間
ConnectTimeout: 5000
5. OpenFeign 的日志打印功能
5.1 日志與日志級別
- Feign 提供了日志打印功能，可以通過配置來調整日志級別，從而了解 Feign 中 Http 請求的細節；
- 也即：對 Feign 接口的調用情況進行監控和輸出；
| 級別 | 說明 |
|---|---|
| NONE | 默認的，不顯示任何日志 |
| BASIC | 僅記錄請求方法、URL、響應狀態碼及執行時間 |
| HEADERS | 除了 BASIC 中定義的信息之外，還有請求和響應的頭信息 |
| FULL | 除了 HEADERS 中定義的信息之外，還有請求和響應的正文及元數據 |
5.2 編寫配置類設置日志級別
在 config 包下；
@Configuration
public class FeignConfig{
@Bean
Logger.Level feignLoggerLevel(){
return Logger.Level.FULL;
}
}
5.3 在 yml 文件里配置需要開啟日志功能的提供者 Feign 客戶端
logging:
level:
#feign日志以什么級別監控哪個接口
com.xxx.springcloud.service.ProviderFeignService: debug
5.4 在控制台上查看日志信息
最后
