SpringCloud 9.OpenFeign服務介面呼叫

SpringCloud 9.OpenFeign服務介面呼叫

1、概述
1.1 什麼是OpenFeign
官網地址：https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign

Feign是一個宣告性web服務客戶端。它使編寫web服務客戶端變得更容易。使用Feign建立一個介面並對其進行註釋。它有可插入的註釋支援，包括外部註釋和JAX-RS註釋。Feign還支援可插入的編碼器和解碼器。Spring Cloud增加了對Spring MVC註釋的支援，以及對使用Spring Web中預設使用的httpMessageConverter的支援。Spring Cloud整合了Ribbon和Eureka以及Spring Cloud LoadBalancer，在使用Feign時提供了一個負載均衡的http客戶端

他的使用方式是：定義一個服務介面，然後在上面新增註釋；

總結：Feign是一個宣告式的Web服務客戶端，讓編寫Web服務客戶端變得非常容易，只需 建立一個介面，並在介面上新增註解即可。

github地址：https://github.com/spring-cloud/spring-cloud-openfeign

1.2 OpenFeign能幹嘛
OpenFeign是整合了Feign的，Feign旨在使編寫Java Http客戶端變得更加容易；

前面在使用Ribbon+RestTemplate的時候，利用RestTemplate對Http請求的封裝處理，形成了一套模板化的呼叫方法。但是實際開發中，由於對服務依賴的呼叫可能不止一處，**往往一個介面會被多處呼叫，所以通常都會針對每個微服務自行封裝一些客戶端類來包裝這些依賴服務的呼叫。**所以，Feign在此基礎上做了進一步的封裝，由他來幫助我們定義和實現依賴服務介面的定義。在Feign的實現下，我們只需建立一個介面並使用註解的方式來配置它（以前是Dao介面上面標註Mapper註解，現在是一個微服務介面上面標註一個Feign註解即可）；即可完成對服務提供方的介面繫結，簡化了使用Spring Cloud Ribbon時，自動封裝服務呼叫客戶端的開發量。

Feign整合了Ribbon，利用Ribbon維護了Payment支付服務的服務列表資訊，並且通過輪詢實現了客戶端的負載均衡。而與Ribbon不同的是，通過Feign只需要定義服務繫結介面，且以宣告式的方式，優雅而簡單的實現了服務呼叫。

1.3 OpenFeign和Feign的區別

OpenFeign	Feign
OpenFeign是SpringCloud在Feign的基礎上支援了SpringMVC的註解，如@RequestMapping等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping註解下的介面，並通過動態代理的方式產生實現類，實現類中做負載均衡並呼叫其他服務。	Feign是SpringCloud元件中的一個輕量級RESTful的Http服務客戶端，Feign內建了Ribbon，用來做客戶端負載均衡，去呼叫服務註冊中心的服務。Feign的使用方式是：使用Feign的註解定義介面，呼叫這個介面，就可以呼叫服務註冊中心的服務。

OpenFeign的pom檔案
groupId：org.springframework.cloud
artifactId：spring-cloud-starter-openfeign

Feign的pom檔案
groupId：org.springframework.cloud
artifactId：spring-cloud-starter-feign

2、OpenFeign的使用
微服務呼叫介面+@FeignClient，OpenFeign是在客戶端使用的

2.1 建立cloud-consumer-openfeign-order80

2.2 改pom

<?xml version="1.0" encoding="UTF-8"?>

springcloud2020
com.zdw.springcloud
1.0-SNAPSHOT

4.0.0

<artifactId>cloud-consumer-openfeign-order80</artifactId>
<description>訂單消費者之feign</description>

<dependencies>
    <!--openfeign-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
    <!--eureka client-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
        <groupId>com.zdw.springcloud</groupId>
        <artifactId>cloud-api-common</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!--監控-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <!--熱部署-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

2.3 寫yml

server:
  port: 80
spring:
  application:
    name: cloud-consumer-openfeign-order

eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      # defaultZone: http://localhost:7001/eureka
      # 叢集版
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka

2.4 主啟動

package com.zdw.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients   
public class OrderOpenFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderOpenFeignMain80.class,args);
    }
}

注意：@EnableFeignClients ：開啟OpenFeign的支援

2.5 業務程式碼
2.5.1 @FeignClient修飾業務邏輯介面

package com.zdw.springcloud.service;

import com.zdw.springcloud.entities.CommonResult;
import com.zdw.springcloud.entities.Payment;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;

/**
 * OpenFeign的業務邏輯介面類，裡面的方法和8001的paymentController的方法以及路徑都是一樣的
 */
@Component
@FeignClient(name = "CLOUD-PAYMENT-SERVICE") //指定要從哪個服務呼叫
public interface PaymentOpenFeignService {
    @PostMapping(value = "payment/create")
    public CommonResult create(@RequestBody Payment payment);

    @GetMapping(value = "payment/get/{id}")
    public CommonResult<Payment> get(@PathVariable("id") Long id);

    @GetMapping(value = "/payment/lb")
    public String getPaymentLB();
}

注意：@Component 這個註解要加，要交給Spring的IOC容器管理
@FeignClient(name = “CLOUD-PAYMENT-SERVICE”) ：指定要從哪個服務呼叫

2.5.2 controller編寫

package com.zdw.springcloud.controller;

import com.zdw.springcloud.entities.CommonResult;
import com.zdw.springcloud.entities.Payment;
import com.zdw.springcloud.service.PaymentOpenFeignService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

@RestController
@Slf4j
public class OrderOpenFeignController {

    @Resource
    PaymentOpenFeignService paymentOpenFeignService;

    @GetMapping(value = "/consumer/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id) {
        log.info("===OpenFeign80服務被呼叫了，會去呼叫8001和8002的叢集服務");
        return paymentOpenFeignService.get(id);
    }
}

2.6 測試
啟動Eureka7001和7002，然後啟動payment8001和8002，最後啟動新建立的這個order80服務：

Feign自帶負載均衡配置項，所以我們訪問：http://localhost/consumer/payment/get/1 可以看到也是8001和8002交替出現，輪詢的負載均衡機制已經得到了實現了。

3、OpenFeign超時控制
3.1 超時設定，故意設定超時演示出錯情況
3.1.1 payment8001和payment8002的controller新增方法
在cloud-provider-payment8001和cloud-provider-payment8002的PaymentController中新增如下方法：

@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeout() {
    try {
        // 暫停3秒鐘
        TimeUnit.SECONDS.sleep(3);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
    return serverPort;
}

3.1.2 order80的OpenFeign介面新增方法
在cloud-consumer-openfeign-order80的PaymentOpenFeignService新增方法：

/**
  * 模擬feign超時
   */
@GetMapping(value = "/payment/feign/timeout")
String paymentFeignTimeout();

3.1.3 order80的controller新增方法
在cloud-consumer-openfeign-order80的OrderOpenFeignController新增方法：

@GetMapping(value = "/consumer/payment/feign/timeout")
public String paymentFeignTimeout() {
    // openfeign-ribbon, 客戶端一般預設等待1秒鐘
    return paymentOpenFeignService.paymentFeignTimeout();
}

3.2 測試
啟動服務之後，瀏覽器訪問：http://localhost/consumer/payment/feign/timeout ，會看到報錯：

OpenFeign預設等待1秒鐘，超過後報錯，而我們的8001和8002是延遲了3秒。導致客戶端不想等待了，直接返回報錯，為了避免這樣的情況，有時候我們需要設定Feign客戶端的超時時間。

3.3 設定Feign客戶端的超時時間
修改cloud-consumer-openfeign-order80的application.yml，新增超時設定：

server:
  port: 80
spring:
  application:
    name: cloud-consumer-openfeign-order

eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      # defaultZone: http://localhost:7001/eureka
      # 叢集版
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka
      
# 設定feign客戶端超時時間(OpenFeign預設支援ribbon)
ribbon:
  # 指的是建立連線所用的時間,適用於網路狀態正常的情況下,兩端連線所用的時間
  ReadTimeout: 5000
  # 指的是建立連線後從伺服器讀取到可用資源所用的時間
  ConnectTimeout: 5000

設定的超時時間的 5000，就是5秒。

3.4 重新測試
瀏覽器訪問：http://localhost/consumer/payment/feign/timeout 在等待了3秒之後，成功了返回了，不會報錯。

4、OpenFeign日誌列印功能
4.1 概述
Feign提供了日誌列印功能，我們可以通過配置來調整日誌級別，從而瞭解Feign中Http的請求細節，說白了就是對Feign介面的呼叫情況進行監控和輸出。

有以下日誌級別：

NONE：預設的，不顯示任何日誌

BASIC：僅記錄請求方法，URL，響應狀態碼以及響應時間

HEADERS：除了BASIC中定義的資訊之外，還有請求和響應的頭資訊

FULL：除了HEADERS中定義的資訊之外，還有請求和響應的正文和後設資料

4.2 配置日誌Bean
在cloud-consumer-openfeign-order80中新建一個配置類：OpenFeignConfig：

package com.zdw.springcloud.config;

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenFeignConfig {

    /**
     * feignClient配置日誌級別
     */
    @Bean
    public Logger.Level feignLoggerLevel() {
        // 請求和響應的頭資訊,請求和響應的正文及後設資料，注意Logger是feign.Logger
        return Logger.Level.FULL;
    }
}

4.3 yml中新增配置
在cloud-consumer-openfeign-order80的application.yml中，設定feign日誌以什麼級別監控哪個介面，logging是頂格寫的。

logging:
  level:
    # 配置 feign日誌以什麼級別監控哪個介面
    com.zdw.springcloud.service.PaymentOpenFeignService: debug

4.4 測試
啟動之後，瀏覽器訪問：http://localhost/consumer/payment/feign/timeout