OpenFeign服務介面呼叫的過程詳解

2022-10-08 14:00:03

OpenFeign服務介面呼叫

1、概述

Feign是一個宣告式WebService使用者端。使用Feign能讓編寫Web Service使用者端更加簡單。它的使用方法是定義一個服務介面然後在上面新增註解。

Feign也支援可拔插式的編碼器和解碼器。Spring Cloud對Feign進行了封裝，使其支援了Spring MVC標準註解和HttpMessageConverters。

Feign可以與Eureka和Ribbon組合使用以支援負載均衡

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

Feign能幹什麼

Feign旨在使編寫Java Http使用者端變得更容易。前面在使用Ribbon+RestTemplate時，利用RestTemplate對http請求的封裝處理，形成了一套模版化的呼叫方法。但是在實際開發中，由於對服務依賴的呼叫可能不止一處，往往一個介面會被多處呼叫，所以通常都會針對每個微服務自行封裝一些使用者端類來包裝這些依賴服務的呼叫。所以，Feign在此基礎上做了進一步封裝，由他來幫助我們定義和實現依賴服務介面的定義。在Feign的實現下，我們只需建立一個介面並使用註解的方式來設定它(以前是Dao介面上面標註Mapper註解,現在是一個微服務介面上面標註一個Feign註解即可)，即可完成對服務提供方的介面繫結，簡化了使用Spring cloud Ribbon時，自動封裝服務呼叫使用者端的開發量。

Feign整合了Ribbon

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

Feign和OpenFeign兩者的區別

Feign	OpenFeign
Feign是Spring Cloud元件中的一個輕量級RESTful的HTTP服務使用者端 Feign內建了Ribbon，用來做使用者端負載均衡，去呼叫服務註冊中心的服務。Feign的使用方式是：使用Feign的註解定義介面，呼叫這個介面，就可以呼叫服務註冊中心的服務	OpenFeign是Spring Cloud 在Feign的基礎上支援了SpringMVC的註解，如@RequesMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping註解下的介面，並通過動態代理的方式產生實現類，實現類中做負載均衡並呼叫其他服務。
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-feign</artifactId> </dependency>	<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>

2、OpenFeign使用步驟

1、建立介面和使用註解@FeignClient

2、新建模組cloud-consumer-feign-order80

3、修改pom.xml依賴檔案

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springcloud2022</artifactId>
        <groupId>com.zcl.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-consumer-feign-order80</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <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>
        <!-- 引入自己定義的api通用包，可以使用Payment支付Entity -->
        <dependency>
            <groupId>com.zcl.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--web-->
        <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>

</project>

4、新增YAML組態檔

不將模組註冊到Eureka服務中心

server:
  port: 80

eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

5、建立啟動類

既然使用的是OpenFeign那必須使用@EnableFeignClients註解進行開啟

package com.zcl.springcloud;

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

/**
 * 描述：Feign專案啟動類
 *
 * @author zhong
 * @date 2022-09-19 13:32
 */
@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class, args);
    }
}

6、業務類

業務邏輯介面+@FeignClient註解完成服務呼叫，找指定微服務的範例和呼叫地址，存取的就是8001對外暴露的地址

主啟動類上必須使用@EnableFeignClients註解進行啟用開啟

package com.zcl.springcloud.service;

import com.zcl.springcloud.entities.CommonResult;
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;

/**
 * 描述：Feign業務測試介面
 *
 * @author zhong
 * @date 2022-09-19 13:35
 */
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {
    /**
     * 根據id去呼叫
     * @param id
     * @return
     */
    @GetMapping("/payment/get/{id}")
    CommonResult getPaymentById(@PathVariable("id") Long id);
}

上面定義的介面其實就是服務提供者對外暴露的介面

7、建立控制器

package com.zcl.springcloud.controller;

import com.zcl.springcloud.entities.CommonResult;
import com.zcl.springcloud.entities.Payment;
import com.zcl.springcloud.service.PaymentFeignService;
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;

/**
 * 描述：測試控制器
 *
 * @author zhong
 * @date 2022-09-19 14:11
 */
@Slf4j
@RestController
public class OrderFeignController {

    /**
     * 注入Feign業務介面
     */
    @Resource
    private PaymentFeignService paymentFeignService;

    /**
     * 測試呼叫服務介面
     * @param id
     * @return
     */
    @GetMapping("/consumer/payment/get/{id}")
    public CommonResult<Payment> getPayment(@PathVariable("id") Long id) {
        // 呼叫服務介面
        return paymentFeignService.getPaymentById(id);
    }
}

8、啟動專案測試

先啟動7001、7002Eureka叢集
再啟動8001、8002兩個微服務提供者
啟動OpenFeign專案80
呼叫介面存取http://localhost/consumer/payment/get/1

多請求兩回會發現一樣的有輪詢負載均衡的效果

Feign自帶負載均衡設定項

{
  "code": 200,
  "message": "查詢成功，當前提供者埠號為：8002",
  "data": {
    "id": 1,
    "serial": "1515154151515"
  }
}

3、OpenFeign超時控制

1、在8001提供者上新增一個新的控制器

/**
 * 測試Feign程式存取停止三秒
 * @return
 */
@GetMapping("/feign/timeout")
public String paymentFeignTimeOut(){
    try {
        // 程式停止三秒
        TimeUnit.SECONDS.sleep(3);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
    return serverPort;
}

2、在消費者Feign80上新增介面

package com.zcl.springcloud.service;

import com.zcl.springcloud.entities.CommonResult;
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;

/**
 * 描述：Feign業務測試介面
 *
 * @author zhong
 * @date 2022-09-19 13:35
 */
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {

    /**
     * 測試請求三秒不響應介面
     * @return
     */
    @GetMapping("/payment/feign/timeout")
    String paymentFeignTimeOut();
}

3、在FeignOrder80消費者控制器上新增介面存取

/**
 * 注入Feign業務介面
 */
@Resource
private PaymentFeignService paymentFeignService;

/**
 * 測試超時
 * @return
 */
@GetMapping("/payment/feign/timeout")
public String paymentFeignTimeOut()
{
    return paymentFeignService.paymentFeignTimeOut();
}

4、啟動專案測試

先自測存取提供者的業務是否正常：http://localhost:8001/payment/feign/timeout（等待三秒再響應結果）
通過Feign-Order80消費者的介面測試呼叫提供者的存取是否正常：http://localhost/consumer/payment/feign/timeout

預設連線是1秒鐘，程式設定了三秒導致連線超時

後端超時報錯

5、在YAML組態檔中開啟超時連線

設定組態檔下面的ribbon連線時間後等待三秒存取正常不會再報錯

server:
  port: 80
eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

#設定feign使用者端超時時間(OpenFeign預設支援ribbon)
ribbon:
  #指的是建立連線所用的時間，適用於網路狀況正常的情況下,兩端連線所用的時間
  ReadTimeout: 5000
  #指的是建立連線後從伺服器讀取到可用資源所用的時間
  ConnectTimeout: 5000

4、OpenFeign紀錄檔列印功能

Feign 提供了紀錄檔列印功能，我們可以通過設定來調整紀錄檔級別，從而瞭解 Feign 中 Http 請求的細節。

就是對Feign介面的呼叫情況進行監控和輸出

1、日記級別

NONE：預設的，不顯示任何紀錄檔；

BASIC：僅記錄請求方法、URL、響應狀態碼及執行時間；

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

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

2、設定日記級別設定類

注意不要導錯包

返回的日記級別對應上面的4個

package com.zcl.springcloud.config;

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

/**
 * 描述：Feign日記級別設定
 *
 * @author zhong
 * @date 2022-09-19 15:27
 */
@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel()
    {
        return Logger.Level.FULL;
    }
}

3、YAML組態檔開啟日記資訊列印

logging:
  level:
    # feign紀錄檔以什麼級別監控哪個介面
    com.zcl.springcloud.service.PaymentFeignService: debug

啟動羨慕測試輸出內容

到此這篇關於OpenFeign服務介面呼叫的文章就介紹到這了,更多相關OpenFeign介面呼叫內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

OpenFeign服務介面呼叫的過程詳解

目錄