Spring Cloud實戰系列(三) - 宣告式客戶端呼叫Feign

零壹技術棧發表於2019-01-28

前言

上一篇文章，講述瞭如何通過 RestTemplate 配合 Ribbon 去消費服務。Feign 是一個 宣告式 的 HTTP 偽客戶端，提供 面向介面 的 HTTP 客戶端呼叫 程式設計。本文進一步講如何通過 Feign 去消費服務。

Feign 只需要建立一個介面並提供註解即可呼叫。
Feign 具有 可插拔 的註解特性，可使用 Feign 註解和 JAX-RS 註解。
Feign 支援 可插拔 的 編碼器 和 解碼器。
Feign 預設整合了 Ribbon，可以和 Eureka 結合使用，預設實現了 負載均衡 的效果。

正文

1. 建立服務契約模組

建立一個 service-contract 的專案 Module，建立完成後的 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">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>io.ostenant.github.springcloud</groupId>
    <artifactId>service-contract</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>service-contract</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

        <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>io.ostenant.github.springcloud</groupId>
            <artifactId>service-contract</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>
複製程式碼

在 service-contract 中定義 業務介面 和相關的 DTO 物件如下：

User.java

public class User implements Serializable {
    private String name;
    private int age;

    public User() {
    }

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public void getName() {
        return this.name;
    }

    public String setName() {
        this.name = name;
    }

    public int getAge() {
        return this.age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}
複製程式碼

UserContract.java

UserContract 定義了 User 的所有行為，是一個使用 @FeignClient 註解標記的 宣告式服務介面。其中，@FeignClient 的 value 指定的是 服務提供者 的 服務名稱。

@FeignClient("service-provider")
public interface UserContract {
    @PostMapping("/user")
    void add(@RequestBody User user);

    @GetMapping("/user/{name}")  
    User findByName(@PathVariable String name);

    @GetMapping("/users")
    List<User> findAll();
}
複製程式碼

對於 服務提供者 而言，需要實現 UserContract 介面的方法；對於 服務消費者 而言，可以直接注入 UserContract 作為 客戶端樁 使用。

2. 建立服務提供者

建立一個 service-provider 的專案 Module，建立完成後引入 服務契約模組 的依賴，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">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>io.ostenant.github.springcloud</groupId>
    <artifactId>service-provider</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>service-provider</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Dalston.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>io.ostenant.github.springcloud</groupId>
            <artifactId>service-contract</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
複製程式碼

通過註解 @EnableEurekaClient 表明自己是一個 Eureka Client。

@SpringBootApplication
@EnableEurekaClient
@RestController
public class ServiceProviderApplication {
    public static void main(String[] args) {
        SpringApplication.run(ServiceProviderApplication.class, args);
    }
}
複製程式碼

建立一個類 UserService，實現 UserContract 介面的具體業務，對外提供 User 相關的 HTTP 的服務。

@RestController
public class UserService implements UserContract {
    private static final Set<User> userSet = new HashSet<>();

    static {
        userSet.add(new User("Alex", 28));
        userSet.add(new User("Lambert", 32));
        userSet.add(new User("Diouf", 30));
    }

    @Override
    public void add(@RequestBody User user) {
        userSet.add(user);
    }

    @Override
    public User findByName(@PathVariable String name) {
        return userSet.stream().filter(user -> {
            return user.getName().equals(name);
        }).findFirst();
    }

    @Override
    public List<User> findAll() {
        return new ArrayList<>(userSet);
    }
}
複製程式碼

在 配置檔案 中註明的 服務註冊中心 的地址，application.yml 配置檔案如下：

spring:
  active:
    profiles: sp1 # sp2

---

spring:
  profiles: sp1
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
server:
  port: 8770
spring:
  application:
    name: service-provider

---

spring:
  profiles: sp2
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
server:
  port: 8771
spring:
  application:
    name: service-provider
複製程式碼

分別以 spring.profiles.active=sp1 和 spring.profiles.active=sp2 作為 Spring Boot 的 啟動命令引數，在埠號 8770 和 8771 啟動 2個 服務提供者 例項。

3. 建立服務消費者

新建一個專案 Module，取名為 service-consumer，在它的 pom 檔案中引入 Feign 的 起步依賴 和 服務契約模組，程式碼如下：

<?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">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>io.ostenant.github.springcloud</groupId>
    <artifactId>service-consumer</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>service-consumer</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Dalston.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-feign</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>io.ostenant.github.springcloud</groupId>
            <artifactId>service-contract</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
複製程式碼

在專案的配置檔案 application.yml 檔案，指定 應用名稱 為 service-consumer，埠號為 8772，服務註冊地址 為http://localhost:8761/eureka/ ，程式碼如下：

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
server:
  port: 8772
spring:
  application:
    name: service-feign
複製程式碼

在應用的啟動類 ServiceConsumerApplication 上加上 @EnableFeignClients 註解開啟 Feign 的功能。

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class ServiceConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServiceConsumerApplication.class, args);
    }
}
複製程式碼

定義一個 UserController 控制器，用於呼叫 服務提供者 提供的服務並響應前端。

@RestController
public class UserController {
    @Autowired
    private UserContract userContract;

    @PostMapping("/user")
    public void add(@RequestBody User user) {
        userContract.add(user);
    }

    @GetMapping("/user/{name}")
    public User findByName(@PathVariable String name) {
        return userContract.findByName(name);
    }

    @GetMapping("/users")
    public List<User> findAll() {
        return userContract.findAll();
    }
}
複製程式碼

在 控制層 UserController 引入 Feign 介面，通過 @FeignClient（服務名稱），來指定呼叫的是哪個服務。

啟動 服務消費者 應用，訪問 http://localhost:8772/users 測試 服務消費者 的訪問連通性，響應內容為：

[
    {
      "name": "Alex",
      "age": 28
    },
    {
      "name": "Lambert",
      "age": 32
    },
    {
      "name": "Diouf",
      "age": 30
    }
]
複製程式碼

4. Feign的原始碼實現過程

總的來說，Feign 的 原始碼實現 過程如下：

首先通過 @EnableFeignClients 註解開啟 FeignClient 的功能。只有這個註解存在，才會在程式啟動時啟動 @FeignClient 註解的 包掃描。
服務提供者 實現基於 Feign 的 契約介面，並在 契約介面 上面加上 @FeignClient 註解。
服務消費者 啟動後，會進行 包掃描 操作，掃描所有的 @FeignClient 的註解的類，並將這些資訊注入 Spring 上下文中。
當介面的方法被呼叫時，通過 JDK 的代理來生成具體的 RequestTemplate 模板物件。
根據 RequestTemplate 再生成 HTTP 請求的 Request 物件。
Request 物件交給 Client 去處理，其中 Client 內嵌的 網路請求框架 可以是 HTTPURLConnection、HttpClient 和 OkHttp。
最後 Client 被封裝到 LoadBalanceClient 類，這個類結合 Ribbon 完成 負載均衡 功能。

參考

方誌朋《深入理解Spring Cloud與微服務構建》

歡迎關注技術公眾號：零壹技術棧

本帳號將持續分享後端技術乾貨，包括虛擬機器基礎，多執行緒程式設計，高效能框架，非同步、快取和訊息中介軟體，分散式和微服務，架構學習和進階等學習資料和文章。

Spring Cloud實戰系列(二) - 客戶端呼叫Rest + Ribbon
2019-01-27
SpringCloud客戶端REST
Spring Cloud Netflix—宣告性REST客戶端：Feign
2018-03-07
SpringCloudREST客戶端
Spring Cloud Feign 宣告式服務呼叫
2019-05-28
SpringCloud
宣告式服務呼叫 Spring Cloud Feign
2021-01-19
SpringCloud
Spring Cloud Alibaba系列（三）使用feign進行服務呼叫
2020-05-13
SpringCloud
初識Spring Cloud Eureka（三）（Eureka客戶端之間服務的相互呼叫）
2019-03-31
SpringCloud客戶端
Spring Cloud構建客戶端
2017-11-15
SpringCloud客戶端
Spring Cloud系列（四）：Eureka原始碼解析之客戶端
2020-10-06
SpringCloud原始碼客戶端
RetrofitJs – TypeScript實現的宣告式HTTP客戶端
2019-02-14
JSTypeScriptHTTP客戶端
spring cloud feign實現遠端呼叫服務傳輸檔案
2019-01-19
SpringCloud
Asp .Net Core 系列：整合 Refit 和 RestEase 宣告式 HTTP 客戶端庫
2024-04-12
RESTHTTP客戶端
SpringCloud 原始碼學習筆記2——Feign宣告式http客戶端原始碼分析
2023-02-25
SpringGCCloud原始碼筆記HTTP客戶端
Spring Cloud Config客戶端使用
2019-06-03
SpringCloud客戶端
Spring Cloud Config—客戶端使用
2017-12-04
SpringCloud客戶端
net core天馬行空系列-微服務篇：全宣告式http客戶端feign快速接入微服務中心nacos
2022-06-06
微服務HTTP客戶端
Spring Cloud Ribbon 客戶端負載均衡
2020-06-04
SpringCloud客戶端負載
Spring Cloud實戰系列(六) - 分散式配置中心Spring Cloud Config
2019-02-02
SpringCloud分散式
spring mina整合(客戶端進行呼叫)
2014-06-18
Spring客戶端
Spring Cloud Alibaba(8)---Feign服務呼叫
2021-05-11
SpringCloud
Spring Cloud應用（三）---feign使用
2018-05-04
SpringCloud
C# 客戶端程式呼叫外部程式的三種實現
2018-04-10
C#客戶端
SpringCloud學習筆記：宣告式呼叫Feign（4）
2018-05-10
SpringGCCloud筆記
Spring Cloud入門教程-Ribbon實現客戶端負載均衡
2018-05-05
SpringCloud客戶端負載
Go gRPC 系列三：流式客戶端和服務端
2019-10-06
GoRPC客戶端服務端
Spring Cloud Netflix—自定義Ribbon客戶端
2018-03-07
SpringCloud客戶端
Spring Cloud Netflix—斷路器：Hystrix客戶端
2018-03-02
SpringCloud客戶端
spring系列—CAS客戶端與SpringSecurity整合
2019-01-19
Spring客戶端Gse
Bug集錦-Spring Cloud Feign呼叫其它介面報錯
2019-10-27
SpringCloud
Spring Cloud微服務-基於Eureka的feign呼叫(1)
2019-03-26
SpringCloud微服務
微服務實戰SpringCloud之Spring Cloud Feign替代HTTP Client
2020-09-07
微服務SpringGCCloudHTTPclient
Feign客戶端呼叫服務時丟失Header引數的解決方案
2020-10-14
客戶端Header
Spring Cloud OpenFeign：基於Ribbon和Hystrix的宣告式服務呼叫
2019-10-08
SpringCloud
三 Spring 宣告式事務
2020-11-19
Spring
webService 客戶端呼叫 axis2
2013-05-03
Web客戶端
.net客戶端呼叫activeMQ程式碼
2009-11-23
客戶端MQ
微服務整合Spring Cloud Alibaba Seata (二) 客戶端連線
2024-04-03
微服務SpringCloud客戶端
Spring Boot響應式客戶端WebClient入門
2018-11-12
Spring Boot客戶端Webclient
Spring Cloud實戰系列(七) - 服務鏈路追蹤Spring Cloud Sleuth
2019-02-04
SpringCloud

Spring Cloud實戰系列(三) - 宣告式客戶端呼叫Feign

相關

前言

正文

1. 建立服務契約模組

2. 建立服務提供者

3. 建立服務消費者

4. Feign的原始碼實現過程

參考

相關文章