• 前言
• 1. OpenFeign 基本知識
  • 1.1 Feign 是什么
  • 1.2 Feign 的出現解決了什么問題
  • 1.3 Feign 與 OpenFeign 的區別與對比
• 2. 在服務消費者端開啟 Feign 支持
  • 2.1 引入 pom.xml 依賴
  • 2.2 在主程式類上添加注解
  • 2.3 在業務介面上添加注解
  • 2.4 在 controller 層呼叫介面
• 3. 在服務消費者端開啟 OpenFeign 支持
  • 3.1 引入 pom.xml 依賴
  • 3.2 在主程式類上添加注解
  • 3.3 在業務介面上添加注解
• 4. OpenFeign 的超時控制
• 5. OpenFeign 的日志列印功能
  • 5.1 日志與日志級別
  • 5.2 撰寫配置類設定日志級別
  • 5.3 在 yml 檔案里配置需要開啟日志功能的提供者 Feign 客戶端
  • 5.4 在控制臺上查看日志資訊
• 最后

前言

參考資料：
《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 最大的區別是：前者不支持對 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="https://www.cnblogs.com/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 = "https://www.cnblogs.com/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 = "https://www.cnblogs.com/dlhjw/p/provider-instance-name")
public interface ProviderFeignClient {
    @GetMapping(value = "https://www.cnblogs.com/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 介面的呼叫情況進行監控和輸出；

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 在控制臺上查看日志資訊

最后

新人制作，如有錯誤，歡迎指出，感激不盡！ 歡迎關注公眾號，會分享一些更日常的東西！ 如需轉載，請標注出處！

標籤：架構設計

上一篇：PowerDotNet平臺化軟體架構設計與實作系列（12）：HCRM人員管理平臺

下一篇：微服務架構 | 4.2 基于 Feign 與 OpenFeign 的服務介面呼叫