一.OpenFeign 介紹

OpenFeign 的全稱是 Spring Cloud OpenFeign，它是 Spring 官方推出的一種聲明式服務調用和負載均衡組件。它的出現就是為了替代已經進入停更維護狀態的 Feign（Netflix Feign）的。也就是說 OpenFeign（Spring Cloud OpenFeign）是 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 是用在服務消費端的，有消費端就得有服務提供端，它們的關系如下圖所示：

創建服務提供者
1.先創建一個 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>

2.設置 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 # 項目啟動端口號

3.添加服務方法，如下代碼所示：

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;
    }
}
復制代碼

創建服務消費者
1.創建一個 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>

2.設置 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 # 項目啟動端口號

3.在 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);
    }
}

4.最重要的一步，創建 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);
}

5.編寫服務調用者代碼，經過了上一步對服務提供者的封裝之后，在控制器中我們可以像調用本地方法一樣調用遠程接口了，具體實現代碼如下：

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);
    }
}

然后分別啟動服務提供者和服務調用者程序，執行結果如下圖所示：