初探Spring Cloud Gateway實戰

Posted on by

關於Spring Cloud Gateway

  • 這是一個基於Spring技術棧構建的API網關，涉及到：Spring5、Spring Boot 2、Reactor等，目標是為項目提供簡單高效的API路由，以及強大的擴展能力：安全、監控、彈性計算等
  • 官方架構圖如下，可見請求到來後，由Handler Mapping決定請求對應的真實目標，然後交給Web Handler，由一系列過濾器(filter)執行鏈式處理，從紅色箭頭和註釋可以發現，請求前後都有過濾器在運行：

在這裡插入圖片描述

版本信息

  • 《Spring Cloud Gateway實戰》系列涉及的軟件和庫版本信息如下：
  • 本篇實戰涉及到的主要版本情況如下：

1.JDK：1.8.0_291

2.IDEA：2021.1.3 (Ultimate Edition)

3.maven：3.8.1

4.操作系統：win10 64位

5.springboot：2.4.2

6.spring-cloud：2020.0.1

7.spring-cloud-alibaba：2021.1

經典配置中的核心概念

  • 先通過一個典型的簡化版配置來瞭解幾個核心概念，假設Spring Cloud Gateway應用正在運行，監聽8080端口，一旦有遠程請求來到8080端口，下面的配置就會生效瞭，三個核心概念，以及每個配置的作用，請參考中文註釋：
spring:
  cloud:
    gateway:
      # 核心概念1：路由，一個路由代表一個處理邏輯，
      # 該邏輯裡面包含三個元素：匹配條件(是否該此路由處理)、真實處理地址、過濾器
      routes:
        # id要確保唯一性
      - id: add_request_header_route
      	# 真實處理地址，請求一旦確定是當前路由處理，就會轉發到這個地址去
        uri: https://example.org
        # 核心概念2：謂語或者斷言，作用是判斷請求是否由當前路由處理
        predicates:
          # 這是斷言的一種，檢查請求的Cookie中mycookie的值是否等於mycookievalue
        - Cookie=mycookie,mycookievalue
        # 核心概念3：過濾器，請求前和請求後都可以有過濾器處理請求響應數據
        filters:
          # 這個過濾器的作用是在請求header中添加一個鍵值對，值等於"aaabbbccc"
        - AddRequestHeader=X-Request-Red, aaabbbccc
  • 上述配置信息中的predicates是簡化版配置，和完整配置對比效果如下，簡單的說就是把一行拆成瞭三項：name、args.name、args.regexp

在這裡插入圖片描述

  • 理論知識點到為止，咱們還是盡快動手吧

啟動nacos-2.0.3

  • 整個《pring Cloud Gateway實戰》系列，我們會涉及到多個服務，這就不可避免的會用到註冊中心和配置中心，這裡我選擇瞭nacos，它可以很好地承擔註冊中心和配置中心的角色，接下來介紹如何部署和啟動nacos
  • 下載nacos，地址是：https://github.com/alibaba/nacos/releases/download/2.0.3/nacos-server-2.0.3.zip
  • 解壓後進入nacos\bin目錄，執行以下命令啟動nacos：

startup.cmd -m standalone

如果您的電腦是mac或者linux，請執行以下命令啟動nacos：

sh startup.sh -m standalone

  • 瀏覽器登錄nacos，地址是http://localhost:8848/nacos，賬號和密碼都是nacos
  • 登錄成功後顯示如下：

在這裡插入圖片描述

源碼下載

本篇實戰中的完整源碼可在GitHub下載到，地址和鏈接信息如下表所示(https://github.com/zq2599/blog_demos)：

名稱 鏈接 備註
項目主頁 https://github.com/zq2599/blog_demos 該項目在GitHub上的主頁
git倉庫地址(https) https://github.com/zq2599/blog_demos.git 該項目源碼的倉庫地址，https協議
git倉庫地址(ssh) [email protected]:zq2599/blog_demos.git 該項目源碼的倉庫地址，ssh協議

這個git項目中有多個文件夾，本篇的源碼在spring-cloud-tutorials文件夾下，如下圖紅框所示：

在這裡插入圖片描述

《Spring Cloud Gateway實戰》系列的父工程

新建名為spring-cloud-tutorials的maven工程，這就是《Spring Cloud Gateway實戰》系列所有源碼的父工程就，pom.xml內容如下，可見這裡將springboot、spring-cloud、spring-cloud-alibaba庫的版本號都已經確定，今後子工程就無需關註依賴庫的版本號瞭：

<?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>
    <modules>
        <module>hello-gateway</module>
        <module>provider-hello</module>
        <module>common</module>
    </modules>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/>
    </parent>
    <groupId>com.bolingcavalry</groupId>
    <artifactId>spring-cloud-tutorials</artifactId>
    <version>1.0-SNAPSHOT</version>
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <java.version>1.8</java.version>
        <spring-cloud.version>2020.0.1</spring-cloud.version>
        <spring-cloud-alibaba.version>2021.1</spring-cloud-alibaba.version>
    </properties>
    <packaging>pom</packaging>
    <description>Demo project for Spring Cloud </description>
    <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>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.squareup.okhttp3</groupId>
                <artifactId>okhttp</artifactId>
                <version>3.14.9</version>
                <scope>compile</scope>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
                <version>1.1.7</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.16.16</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

創建名為common的子工程，存放共用的常量和數據結構

  • 現在創建名為common的子工程，整個《Spring Cloud Gateway實戰》系列涉及的常量和數據結構都放在這個子工程中，方便其他工程使用
  • 新增常量Constants.java：
package com.bolingcavalry.common;
public interface Constants {
    String HELLO_PREFIX = "Hello World";
}

創建web應用，作為服務提供方

  • 現在創建名為provider-hello的web應用，這是個極其普通的web應用，提供幾個http接口服務，咱們在嘗試Spring Cloud Gateway的基本功能時，都會將請求路由到provider-hello上來
  • provider-hello是個普通的springboot應用，會在nacos進行註冊，其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">
    <parent>
        <artifactId>spring-cloud-tutorials</artifactId>
        <groupId>com.bolingcavalry</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>provider-hello</artifactId>
    <packaging>jar</packaging>
    <dependencies>
        <dependency>
            <groupId>com.bolingcavalry</groupId>
            <artifactId>common</artifactId>
            <version>${project.version}</version>
        </dependency>
        <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-config</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <!-- 如果父工程不是springboot，就要用以下方式使用插件，才能生成正常的jar -->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>com.bolingcavalry.provider.ProviderApplication</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

工程的配置文件application.yml如下，web端口是8082，還有一處要註意的是nacos服務地址：

server:
  #服務端口
  port: 8082
spring:
  application:
    name: provider-hello
  cloud:
    nacos:
      discovery:
        # nacos服務地址
        server-addr: 127.0.0.1:8848
  • 啟動類ProviderApplication.java
package com.bolingcavalry.provider;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
@SpringBootApplication
public class ProviderApplication {
    public static void main(String[] args) {
        SpringApplication.run(ProviderApplication.class, args);
    }
}
  • 普通的Controller類Hello.java，對外提供一個http服務：
package com.bolingcavalry.provider.controller;
import com.bolingcavalry.common.Constants;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.text.SimpleDateFormat;
import java.util.Date;
@RestController
@RequestMapping("/hello")
public class Hello {
    private String dateStr(){
        return new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date());
    }
    /**
     * 返回字符串類型
     * @return
     */
    @GetMapping("/str")
    public String helloStr() {
        return Constants.HELLO_PREFIX + ", " + dateStr();
    }
}

新增測試類HelloTest.java，用於檢查應用的服務是否正常：

package com.bolingcavalry.provider.controller;
import com.bolingcavalry.common.Constants;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import static org.hamcrest.Matchers.containsString;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@SpringBootTest
@AutoConfigureMockMvc
@Slf4j
class HelloTest {
    @Autowired
    private MockMvc mvc;
    @Test
    void hello() throws Exception {
        String responseString = mvc.perform(MockMvcRequestBuilders.get("/hello/str").accept(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk())
                .andExpect(content().string(containsString(Constants.HELLO_PREFIX)))
                .andDo(print())
                .andReturn()
                .getResponse()
                .getContentAsString();
        log.info("response in junit test :\n" + responseString);
    }
}

執行單元測試（此時nacos是否啟動無所謂，隻是不啟動的話控制臺會有一些錯誤信息，但是沒有影響），如下，測試通過表示服務是正常的：

在這裡插入圖片描述

開發一個簡單的demo，完成spring-cloud-gateway的初體驗

  • 前面做瞭那麼多準備，接下來咱們會投入到Spring Cloud Gateway的開發中，先寫個簡單的demo快速體驗一下
  • 新增名為hello-gateway的子工程，pom.xml如下，重點是依賴瞭spring-cloud-starter-gateway庫，還有一處要重點小心的：測試庫用的是reactor-test和spring-boot-starter-test，這和之前的單元測試很不一樣，用的是webflux：
<?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">
    <parent>
        <artifactId>spring-cloud-tutorials</artifactId>
        <groupId>com.bolingcavalry</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>hello-gateway</artifactId>
    <dependencies>
        <dependency>
            <groupId>com.bolingcavalry</groupId>
            <artifactId>common</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <dependency>
            <groupId>io.projectreactor</groupId>
            <artifactId>reactor-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>
  • 下面是重點，Spring Cloud Gateway的配置文件application.yml，：
server:
  #服務端口
  port: 8081
spring:
  application:
    name: hello-gateway
  cloud:
    gateway:
      routes:
        - id: path_route
          # 匹配成功後，會被轉發到8082端口，至於端口後面的path，會直接使用原始請求的
          # 例如http://127.0.0.1:8081/hello/str，會被轉發到http://127.0.0.1:8082/hello/str
          uri: http://127.0.0.1:8082
          predicates:
            # 根據請求路徑中帶有"/hello/"，就算匹配成功
          - Path=/hello/**

如果要轉發到其他域名下，需要創建配置類解決跨域問題：

package com.bolingcavalry.hellogateway.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.reactive.CorsWebFilter;
import org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource;
import org.springframework.web.util.pattern.PathPatternParser;
@Configuration
public class CorsConfig {
    @Bean
    public CorsWebFilter corsFilter() {
        CorsConfiguration config = new CorsConfiguration();
        config.addAllowedMethod("*");
        config.addAllowedOrigin("*");
        config.addAllowedHeader("*");
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser());
        source.registerCorsConfiguration("/**", config);
        return new CorsWebFilter(source);
    }
}
  • 啟動類：
package com.bolingcavalry.hellogateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class HelloGatewayApplication {
    public static void main(String[] args) {
        SpringApplication.run(HelloGatewayApplication.class,args);
    }
}
  • 最後是單元測試類，請註意，由於Spring Cloud Gateway使用瞭webflux技術棧，因此不能用常見的MockMvc來模擬請求，幾個註解也值得註意，另外也要註意WebTestClient的expectStatus、expectBody等API的用法：
package com.bolingcavalry.hellogateway;
import com.bolingcavalry.common.Constants;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.reactive.server.WebTestClient;
import static org.junit.jupiter.api.Assertions.assertTrue;
@SpringBootTest
@ExtendWith(SpringExtension.class)
@AutoConfigureWebTestClient
public class HelloTest {
    @Autowired
    private WebTestClient webClient;
    @Test
    void testHelloPredicates() {
        webClient.get()
                .uri("/hello/str")
                .accept(MediaType.APPLICATION_JSON)
                .exchange()
                // 驗證狀態
                .expectStatus().isOk()
                // 驗證結果，註意結果是字符串格式
                .expectBody(String.class).consumeWith(result  -> assertTrue(result.getResponseBody().contains(Constants.HELLO_PREFIX)));
    }
}

請確保provider-hello應用已經啟動，再運行上面創建的HelloTest.java，得到結果如下，測試通過，證明hello-gateway的功能符合預期，成功的將請求轉發到provider-hello應用，並且成功收到響應：

在這裡插入圖片描述

至此，《Spring Cloud Gateway實戰》系列的準備工作已經完成，而且開發瞭一個簡單的應用體驗最基本的Spring Cloud Gateway功能，接下來的文章，咱們一起實戰更多基本功能。

總結

本篇文章就到這裡瞭，希望能給你帶來幫助，也希望您能夠多多關註WalkonNet的更多內容！

推薦閱讀：