作者 | 磊哥

來源 | Java中文社群（ID：javacn666）

轉載請聯系授權（微信ID：GG_Stone）

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

@RestController public?class?ConsumerController?{@Resourceprivate?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?{@Resourceprivate?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?{//?讓程序休眠?2sTimeUnit.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

往期推薦

SpringCloud Ribbon中的7種負載均衡策略！

SpringCloud Nacos + Ribbon 調用服務的 2 種方法！

Spring Cloud Alibaba Nacos 的 2 種健康檢查機制！

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的SpringCloud OpenFeign + Nacos正确打开方式！的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。