簡(jiǎn)介

客戶端和服務(wù)器之間的通信是現(xiàn)代 Web 應(yīng)用程序的一個(gè)重要方面。隨著微服務(wù)架構(gòu)越來(lái)越受歡迎，簡(jiǎn)化客戶端-服務(wù)器通信的需求，降低成本變得越來(lái)越重要。 Spring Boot 是一個(gè)非常流行的 Java 框架，它提供了一系列工具來(lái)使這種交互無(wú)縫且高效。在這些工具中，@FeignClient 注解因其易用性和強(qiáng)大的功能而脫穎而出。 在這篇文章中，我們將探討如何使用 Spring 的 @FeignClient 注解進(jìn)行客戶端-服務(wù)器通信。

@FeignClient介紹

在當(dāng)今微服務(wù)和云原生應(yīng)用程序的世界中，不同服務(wù)之間的通信更多是一種規(guī)則。微服務(wù)通常必須相互交互才能實(shí)現(xiàn)業(yè)務(wù)邏輯、查詢數(shù)據(jù)或處理事務(wù)。然而，如果管理不當(dāng)，啟用這種通信的過(guò)程可能會(huì)變得復(fù)雜且容易出錯(cuò)。這也就是 Spring Cloud 的 @FeignClient 發(fā)揮作用的地方，它為服務(wù)間通信提供了強(qiáng)大、簡(jiǎn)化的解決方案。

@FeignClient為什么重要

傳統(tǒng)的架構(gòu)由緊密耦合的單一代碼庫(kù)應(yīng)用程序組成，微服務(wù)本質(zhì)上恰恰相反。它們是松散耦合服務(wù)的集合，每個(gè)服務(wù)負(fù)責(zé)特定的功能。這些服務(wù)必須有效地進(jìn)行通信，以提供良好的用戶體驗(yàn)。

當(dāng)一個(gè)服務(wù)想要調(diào)用另一個(gè)服務(wù)的 API 時(shí)，開(kāi)發(fā)人員通常使用 HTTP 客戶端或 REST 模板來(lái)進(jìn)行這些調(diào)用。盡管這些是函數(shù)式方法，但它們需要大量樣板代碼，使得代碼庫(kù)更難以維護(hù)和理解。

@FeignClient 注解通過(guò)抽象 HTTP 客戶端層來(lái)簡(jiǎn)化此過(guò)程，使開(kāi)發(fā)人員能夠更多地關(guān)注業(yè)務(wù)邏輯，而不是基礎(chǔ)設(shè)施。

@FeignClient的優(yōu)勢(shì)

聲明式注解

使用 @FeignClient 最引人注目的優(yōu)點(diǎn)是它的聲明式方法。您定義一個(gè)接口并使用 @FeignClient 對(duì)其進(jìn)行注解，Spring 會(huì)處理其余的事情。您不必為 HTTP 調(diào)用、連接設(shè)置或響應(yīng)解析編寫代碼； Spring Boot 在幕后處理所有這些問(wèn)題。

內(nèi)置負(fù)載均衡

微服務(wù)通常運(yùn)行在分布式環(huán)境中，其中可能存在服務(wù)的多個(gè)實(shí)例。 @FeignClient 注解與 Spring Cloud 和 Eureka 等服務(wù)注冊(cè)中心結(jié)合使用時(shí)，提供內(nèi)置的客戶端負(fù)載平衡。這意味著請(qǐng)求會(huì)自動(dòng)路由到不同的服務(wù)實(shí)例，從而提供高效的資源利用。

安全

@FeignClient 可以與 Spring Security 很好地集成，使您能夠輕松保護(hù)服務(wù)間通信。這可確保服務(wù)在相互通信之前經(jīng)過(guò)身份驗(yàn)證和授權(quán)

容災(zāi)機(jī)制

在微服務(wù)環(huán)境中，服務(wù)失敗是很常見(jiàn)的。要構(gòu)建彈性系統(tǒng)，您可以定義在服務(wù)不可用時(shí)觸發(fā)的回退方法。這有助于提高應(yīng)用程序的容錯(cuò)能力。

@FeignClient的原理

@FeignClient 注解的工作原理是在運(yùn)行時(shí)動(dòng)態(tài)創(chuàng)建所注解接口的代理。該接口中的每個(gè)方法對(duì)應(yīng)指定的服務(wù)的 HTTP 請(qǐng)求。當(dāng)調(diào)用該接口的方法時(shí)，Spring會(huì)攔截該調(diào)用并將其轉(zhuǎn)換為HTTP請(qǐng)求，包括URL映射、請(qǐng)求和響應(yīng)正文轉(zhuǎn)換以及標(biāo)頭設(shè)置。然后，它將請(qǐng)求發(fā)送到目標(biāo)服務(wù)，處理響應(yīng)，并將其作為方法的返回值返回

與 Spring Cloud 集成

@FeignClient 是 Spring Cloud 生態(tài)系統(tǒng)中不可或缺的一部分，它是一組用于構(gòu)建云原生應(yīng)用程序的工具。當(dāng)在 Spring Cloud 項(xiàng)目中使用時(shí)，F(xiàn)eign 客戶端可以獲得額外的功能，例如集中配置以及與其他 Spring Cloud 模塊（例如 Spring Cloud Stream 或 Spring Cloud Config）的輕松集成。

實(shí)踐

要使用Spring 的 @FeignClient，首先需要正確設(shè)置開(kāi)發(fā)環(huán)境。本節(jié)概述了使用 Spring Boot 應(yīng)用程序的步驟以及如何合并 Feign 客戶端。

創(chuàng)建一個(gè)新的 SpringBoot 項(xiàng)目

需要的第一件事是 創(chuàng)建Spring Boot 項(xiàng)目。如果從頭開(kāi)始，您可以使用 Spring Initializr 輕松生成項(xiàng)目框架：

• 打開(kāi) Spring Initializr。
• 選擇您喜歡的語(yǔ)言（Java、Kotlin、Groovy）。
• 選擇Spring Boot版本（一般選擇最新的穩(wěn)定版本就好）。
• 添加所需的依賴項(xiàng)；在這個(gè)階段，可以選擇“Spring Web”和“Spring Cloud OpenFeign”。
• 點(diǎn)擊“生成”

添加 Maven 依賴

生成 Spring Boot 項(xiàng)目后，打開(kāi) pom.xml 文件以添加依賴。如果您使用帶有正確選項(xiàng)的 Spring Initializr，您的 pom.xml 中可能已經(jīng)有了這些依賴項(xiàng)：

<dependencies>
  <!-- Spring Cloud Starter Feign -->
  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
  </dependency>
</dependencies>

如果您沒(méi)有使用 Spring Initializr，請(qǐng)手動(dòng)添加這些依賴項(xiàng)。

版本兼容性

Spring Cloud 版本與 Spring Boot 版本緊密耦合。添加依賴時(shí)，請(qǐng)確保您使用的 Spring Cloud 版本與您的 Spring Boot 版本兼容。您可以查看 Spring Cloud 發(fā)行說(shuō)明以獲取兼容性信息。

啟用Feign Clients

一旦依賴關(guān)系就位，就可以在 Spring Boot 應(yīng)用程序中啟用 Feign 客戶端了。這是使用 @EnableFeignClients 注釋完成的。將此注釋添加到您的主 Spring Boot 應(yīng)用程序類中，如下所示：

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

通過(guò)添加 @EnableFeignClients， Spring就會(huì) 掃描使用 @FeignClient 注解的接口并為它們生成代理實(shí)現(xiàn)。

@FeignClient的基本用法

Feign 本質(zhì)上是一種編寫簡(jiǎn)化的 HTTP 客戶端的方法。其操作背后的基本思想是編寫一個(gè)接口并對(duì)其進(jìn)行注解。然后 Spring 通過(guò)在運(yùn)行時(shí)提供實(shí)現(xiàn)來(lái)填補(bǔ)空白。下面，我們將逐步介紹定義和使用 Feign 客戶端與其他服務(wù)交互的步驟。

創(chuàng)建FeignClient接口

使用 @FeignClient 開(kāi)始是定義一個(gè)充當(dāng) Feign 客戶端的接口。該接口應(yīng)使用 @FeignClient 進(jìn)行注解，并包含希望執(zhí)行的操作的方法簽名。 @FeignClient 注解至少需要一個(gè)參數(shù)：您要連接的服務(wù)的名稱。

看看以下示例，我們定義一個(gè) Feign 客戶端接口來(lái)與假設(shè)的 Order-Service 交互：

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

import java.util.List;

@FeignClient("Order-Service")
public interface OrderClient {
  @GetMapping("/orders/{userId}")
  List<Order> getOrdersByUserId(@PathVariable("userId") String userId);
}

在此接口中，我們定義了一個(gè)方法 getOrdersByUserId，意思是從 Order-Service 中獲取給定用戶 ID 的訂單。

注解及其作用

• @FeignClient(“Order-Service”)：此注解告訴 Spring 創(chuàng)建一個(gè) Feign 客戶端，將請(qǐng)求路由到 Order-Service 微服務(wù)。
• @GetMapping(“/orders/{userId}”)：@GetMapping 注解將 HTTP GET 方法映射到 /orders/{userId} URL 模式，該模式將用于獲取訂單。 @
• PathVariable(“userId”)：該注解將URL中的userId路徑變量綁定到userId方法參數(shù)。

注入 FeignClient

定義接口后，可以使用 Spring 的 @Autowired 注釋將其注入任何 Spring 組件（如控制器或服務(wù)）。

下面是一個(gè) Spring REST 控制器的示例，它使用 OrderClient 接口來(lái)獲取給定用戶的訂單：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class UserController {
  @Autowired
  private OrderClient orderClient;

  @GetMapping("/user/{id}/orders")
  public List<Order> getUserOrders(@PathVariable("id") String id) {
    return orderClient.getOrdersByUserId(id);
  }
}

在此示例中，UserController 類有一個(gè)由 Spring 自動(dòng)填充的 OrderClient 字段。 getUserOrders 方法只是將調(diào)用委托給
OrderClient.getOrdersByUserId 方法，該方法在幕后執(zhí)行 HTTP 請(qǐng)求來(lái)獲取數(shù)據(jù)。

運(yùn)行程序

定義 Feign 客戶端接口并將其注入 Spring 組件后，運(yùn)行 Spring Boot 應(yīng)用程序應(yīng)該啟用此功能。一旦應(yīng)用程序運(yùn)行，對(duì) getUserOrders API 的任何調(diào)用都將在內(nèi)部使用 Feign 客戶端從 Order-Service 獲取數(shù)據(jù)。

高級(jí)功能

@FeignClient 簡(jiǎn)化了微服務(wù)通信方式的同時(shí)，還提供了豐富的高級(jí)功能和自定義選項(xiàng)。了解這些功能可以幫助開(kāi)發(fā)人員構(gòu)建更強(qiáng)大、更靈活和更優(yōu)化的應(yīng)用程序。

自定義請(qǐng)求參數(shù)

默認(rèn)情況下，@FeignClient 使用簡(jiǎn)單的方法參數(shù)名稱作為請(qǐng)求參數(shù)。但是，可以使用 @RequestParam 注解進(jìn)行自定義。

@FeignClient("Order-Service")
public interface CustomOrderClient {
  @GetMapping("/orders")
  List<Order> getOrdersByStatus(@RequestParam("status") String orderStatus);
}

在此示例中， getOrdersByStatus 方法將調(diào)用 Order-Service 的 /orders 端點(diǎn)并將狀態(tài)作為查詢參數(shù)傳遞。

使用 Ribbon 進(jìn)行客戶端負(fù)載均衡

Feign 客戶端可以輕松與 Ribbon 集成，以實(shí)現(xiàn)客戶端負(fù)載均衡。我們要做的就是在項(xiàng)目中包含功能區(qū)依賴項(xiàng)。

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
</dependency>

@FeignClient 將使用ribbon功能在使用 Eureka 等發(fā)現(xiàn)服務(wù)注冊(cè)的可用服務(wù)實(shí)例之間分發(fā)請(qǐng)求

使用 Hystrix 處理異常

可以集成 Hystrix 以實(shí)現(xiàn)容錯(cuò)。可以指定回退方法來(lái)處理目標(biāo)服務(wù)不可用的情況。 首先，將 Hystrix 依賴項(xiàng)添加到 pom.xml 中：

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>

然后在 @FeignClient 定義中指定回調(diào)類：

@FeignClient(name = "Order-Service", fallback = OrderClientFallback.class)
public interface OrderClient {
  // ...
}

@Component
public class OrderClientFallback implements OrderClient {
  @Override
  public List<Order> getOrdersByUserId(String userId) {
    return Collections.emptyList();
  }
}

最佳實(shí)踐

• 一致的命名約定：為 Feign 客戶端接口使用一致的命名約定。這使得查找和管理它們變得更加容易。
• 單獨(dú)的配置類：對(duì)于復(fù)雜的客戶端，使用單獨(dú)的配置類，可以在其中定義請(qǐng)求攔截器、編碼器和解碼器。
•  日志記錄和監(jiān)控：實(shí)施日志記錄和監(jiān)控以跟蹤 Feign 客戶端發(fā)出的請(qǐng)求。這可以幫助您調(diào)試和優(yōu)化應(yīng)用程序的性能。
• 文檔：使用 JavaDocs 或注釋來(lái)注釋 Feign 客戶端接口，特別是當(dāng) API 具有復(fù)雜的查詢參數(shù)、標(biāo)頭或請(qǐng)求/響應(yīng)主體時(shí)。
• 超時(shí)和重試：始終配置超時(shí)和重試以使您的應(yīng)用程序更具彈性。您可以在全局或每個(gè)客戶端級(jí)別執(zhí)行此操作。

總結(jié)

在現(xiàn)代微服務(wù)架構(gòu)中，客戶端-服務(wù)器通信是系統(tǒng)不可或缺的一部分。 Spring 框架的 @FeignClient 注解簡(jiǎn)化了這種通信，使代碼的閱讀、編寫和維護(hù)變得更加容易。 Feign 具有參數(shù)自定義、回退機(jī)制和內(nèi)置客戶端負(fù)載平衡等高級(jí)功能，是一款功能強(qiáng)大的工具，可以幫助您構(gòu)建健壯且可擴(kuò)展的應(yīng)用程序。 因此，下次在 Spring Boot 應(yīng)用程序中處理客戶端-服務(wù)器通信時(shí)，我們可以考慮使用 @FeignClient 提升開(kāi)發(fā)的效率。

以上就是詳解如何使用Spring的@FeignClient注解實(shí)現(xiàn)通信的詳細(xì)內(nèi)容，更多關(guān)于Spring @FeignClient實(shí)現(xiàn)通信的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論