Nacos+OpenFegin正確呼叫服務的姿勢！

阿新 • • 發佈：2022-03-23

Nacos 支援兩種 HTTP 服務請求，一個是 REST Template，另一個是 Feign Client。之前的文章咱們介紹過 Rest Template 的呼叫方式，主要是通過 Ribbon（負載均衡） + RestTemplate 實現 HTTP 服務呼叫的，請求的核心程式碼是這樣的：

@RestController
public class ConsumerController {
    @Resource
    private RestTemplate restTemplate;
    @GetMapping("/consumer")
    public String consumer(@RequestParam String name) {
        // 請求並獲取結果（springcloud-nacos-provider 是 nacos 中的服務id）
        String result = restTemplate.getForObject("http://springcloud-nacos-provider/call/" + name, String.class);
        return result;
    }
}

從上述的實現程式碼我們可以看出一個問題，雖然以上程式碼可以實現 HTTP 服務呼叫，但需要開發者手動拼接呼叫地址和引數，並且遠端服務呼叫和客戶端自身的業務邏輯實現是混合在一起，不利於後期的維護與擴充套件，那如何要解決這個問題呢？這就是我們今天要介紹的 OpenFeign 的原因了。

OpenFeign 介紹

OpenFeign 的全稱是 Spring Cloud OpenFeign，它是 Spring 官方推出的一種宣告式服務呼叫和負載均衡元件。它的出現就是為了替代已經進入停更維護狀態的 Feign（Netflix Feign）的。也就是說 OpenFeign（Spring Cloud OpenFeign）是 Feign 的升級版，它們的關係如下圖所示：

因為 Feign 停更維護了，所以 Spring 官方需要推出了一個新的新的框架來對 Feign 功能進行升級和擴充套件。

OpenFeign 常用註解

OpenFeign 宣告式服務呼叫和負載均衡元件，因此它的核心是使用註解 + 介面的方式實現服務呼叫，所以瞭解 OpenFeign 的註解就至關重要了。
對於 Feign 框架來說，它只支援 Feign 註解和 JAX-RS 註解，但 OpenFeign 在 Feign 的基礎上還增加了對 Spring MVC 註解的支援，例如 @RequestMapping、@GetMapping 和 @PostMapping 等註解。
OpenFeign 常用註解有以下幾個：

@EnableFeignClients：該註解用於開啟 OpenFeign 功能，當 Spring Cloud 應用啟動時，OpenFeign 會掃描標有 @FeignClient 註解的介面，生成代理並註冊到 Spring 容器中。
@FeignClient：該註解用於通知 OpenFeign 元件對 @RequestMapping 註解下的介面進行解析，並通過動態代理的方式產生實現類，實現負載均衡和服務呼叫。
@RequestMapping：向服務提供者發起 Request 請求（預設為 GET 方式請求），這裡需要注意 @RequestMapping/@GetMapping/@PostMapping 和 Spring MVC 中的同名註解的含義是完全不同的。
@GetMapping：向服務提供者發起 GET 請求。
@PostMapping：向服務提供者發起 POST 請求。

OpenFeign 使用

OpenFeign 是用在服務消費端的，有消費端就得有服務提供端，它們的關係如下圖所示：

所以我們先要建立一個服務提供者 Provider，建立步驟如下。

建立服務提供者

第一步：先建立一個 Spring Boot 專案（Spring Cloud 專案是基於 Spring Boot 建立的），新增 spring-web 和 nacos-discovery 依賴，具體依賴資訊如下：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 新增 Nacos 支援 -->
<dependency>
  <groupId>com.alibaba.cloud</groupId>
  <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

第二步：設定 Nacos 相關配置，在 application.yml 中新增以下配置：

spring:
  application:
    name: springcloud-nacos-provider # 專案名稱（nacos 註冊的服務名）
  cloud:
    nacos:
      discovery:
        username: nacos # nacos 登入使用者名稱
        password: nacos666 # nacos 密碼
        server-addr: 127.0.0.1:8848 # nacos 服務端地址
server:
  port: 8081 # 專案啟動埠號

第三步：新增服務方法，如下程式碼所示：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class HttpProviderApplication {

    public static void main(String[] args) {
        SpringApplication.run(HttpProviderApplication.class, args);
    }

    /**
     * 為客戶端提供可呼叫的介面
     */
    @RequestMapping("/call/{name}")
    public String call(@PathVariable String name) {
        return LocalTime.now() + "——服務提供者1：" + name;
    }
}

建立服務消費者

第一步：建立一個 Spring Boot 專案，新增 spring-web、nacos-discovery 和 openfeign 依賴，具體依賴內容如下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 新增 nacos 框架依賴 -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!-- 新增 openfeign 框架依賴 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

第二步：設定 Nacos 相關配置，在 application.yml 中新增以下配置：

spring:
  application:
    name: springcloud-nacos-consumer # 專案名稱（nacos 註冊的服務名）
  cloud:
    nacos:
      discovery:
        username: nacos # nacos 登入使用者名稱
        password: nacos666 # nacos 密碼
        server-addr: 127.0.0.1:8848 # nacos 服務端地址
server:
  port: 8093 # 專案啟動埠號

第三步：在 Spring Boot 專案的啟動檔案上新增 @EnableFeignClients 註解，開啟 OpenFeign，具體實現程式碼如下：

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

@SpringBootApplication
@EnableFeignClients // 啟用 OpenFeign
public class OpenfeignConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(OpenfeignConsumerApplication.class, args);
    }
}

第四步：最重要的一步，建立 OpenFeign 與服務提供者的呼叫介面，實現程式碼如下：

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

@FeignClient("springcloud-nacos-provider") // nacos 服務 id
public interface SpringCloudNacosProviderClient {
    @GetMapping("/call/{name}") // 使用 get 方式，呼叫服務提供者的 /call/{name} 介面
    public String call(@PathVariable(value = "name") String name);
}

第五步：編寫服務呼叫者程式碼，經過了上一步對服務提供者的封裝之後，在控制器中我們可以像呼叫本地方法一樣呼叫遠端介面了，具體實現程式碼如下：

import com.example.openfeignconsumer.feignclient.SpringCloudNacosProviderClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;

@RestController
public class ConsumerController {
    @Resource
    private SpringCloudNacosProviderClient providerClient; // 載入 openfeign client
    
    @GetMapping("/consumer")
    public String consumer(@RequestParam String name) {
        // 向呼叫本地方法一樣，呼叫 openfeign client 中的方法
        return providerClient.call(name);
    }
}

然後分別啟動服務提供者和服務呼叫者程式，執行結果如下圖所示：

注意事項

OpenFeign 預設的介面超時時間為 1s，所以如果介面的執行時間超過 1s，那麼程式呼叫就會報錯。
接下來，我們編寫程式測試一下，將服務提供者的程式碼休眠 2s，具體實現程式碼如下：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalTime;
import java.util.concurrent.TimeUnit;

@SpringBootApplication
@RestController
public class HttpProviderApplication {

    public static void main(String[] args) {
        SpringApplication.run(HttpProviderApplication.class, args);
    }

    /**
     * 為客戶端提供可呼叫的介面
     */
    @RequestMapping("/call/{name}")
    public String call(@PathVariable String name) throws InterruptedException {
        // 讓程式休眠 2s
        TimeUnit.SECONDS.sleep(2);
        return LocalTime.now() + "——服務提供者1：" + name;
    }
}

之後使用 OpenFeign 客戶端訪問服務，就會出現如下報錯資訊：

解決方案：通過修改配置檔案中的超時時長，也就是手動調節介面的超時時長來解決此問題，因為 1s 確實太短了，修改的配置資訊如下：

ribbon:
  ReadTimeout: 5000 # 請求連線的超時時間
  ConnectionTimeout: 10000 # 請求處理的超時時間

總結

OpenFeign 是基於 Feign 實現的，是 Spring Cloud 官方提供的註解式呼叫 REST 介面框架，OpenFeign/Feign 底層是基於 Ribbon 實現負載均衡的。使用 OpenFeign 有三個關鍵步驟，首先在 Spring Boot 啟動類上使用註解 @EnableFeignClients 開啟 OpenFeign；第二，使用 @FeignClient + @GetMapping/@PostMapping 呼叫服務提供者的介面；第三，在客戶端中注入 Feign Client 物件，像呼叫本地方法一樣呼叫遠端介面。

專案原始碼

https://gitee.com/mydb/spring-cloud-alibaba-example

參考 & 鳴謝

c.biancheng.net/springcloud/open-feign.html

是非審之於己，譭譽聽之於人，得失安之於數。

公眾號：Java中文社群

Java面試合集：https://gitee.com/mydb/interview

Nacos+OpenFegin正確呼叫服務的姿勢！

OpenFeign 介紹

OpenFeign 常用註解

OpenFeign 使用

建立服務提供者

建立服務消費者

注意事項

總結

專案原始碼

參考 & 鳴謝

Nacos+OpenFegin正確呼叫服務的姿勢！

SpringCloud Nacos + Ribbon 呼叫服務的 2 種方法！

springboot2.1.*整合nacos和feign進行服務註冊發現和呼叫

List 去除重複資料的 5 種正確姿勢！

Guava RateLimiter 實現 API 限流，這才是正確的姿勢！

nacos+feign實現微服務呼叫

原來，這才是開發者開啟世界讀書日的正確姿勢！

來整一個自己的短連結服務吧！

WCF初探-11：WCF客戶端非同步呼叫服務

WCF初探-10：WCF客戶端呼叫服務

SpringCloud使用feign遠端呼叫服務注入對映介面失敗問題

WCF分散式開發常見錯誤(3)：客戶端呼叫服務出錯

附實戰程式碼｜告別OS模組，體驗Python檔案操作新姿勢！

Nacos配置中心和服務的註冊發現

關於SpringGateway呼叫服務接受不到引數問題

Spring cloud 通過Feign直接呼叫服務層的方法（類似RPC）

FeignClient 呼叫服務端時，服務端報錯:Request method ‘POST‘ not supported]

逆向爬蟲時，Python 如何正確呼叫 JAR 加密邏輯？

python 逆向爬蟲正確呼叫 JAR 加密邏輯

springcloud中openFeign中url遠端呼叫服務

Nacos+OpenFegin正確呼叫服務的姿勢！

OpenFeign 介紹

OpenFeign 常用註解

OpenFeign 使用

建立服務提供者

建立服務消費者

注意事項

總結

專案原始碼

參考 & 鳴謝

相關推薦