Spring Cloud系列教程(十六)：下一代網關服務Gateway-入門篇(Finchley版本)

官網文檔： https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/

一.什麼是Spring Cloud Gateway

來自官方文檔的一句話： Spring Cloud Gateway提供了一個在Spring生態系統之上構建的API網關，包括：Spring 5，Spring Boot 2和Project Reactor。Spring Cloud Gateway旨在提供一種簡單而有效的方法來路由到API，併爲它們提供跨領域的關注，例如：安全性，監視/指標和彈性。並且從引入的spring-cloud-starter-gateway依賴信息可見，Spring Cloud Gateway底層是基於SpringBoot2.x、Project Reactor和Spring5 WebFlux響應式驅動編程構建，而Spring5底層又是基於netty異步實現，可謂性能不一般啊。

由於響應式編程的特性，Spring WebFlux和Reactor底層需要支持異步的運行環境，比如Netty和Undertow；也可以運行在支持異步I/O的Servlet 3.1的容器之上，比如Tomcat（8.0.23及以上）和Jetty（9.0.4及以上）。而且Spring Cloud Gateway底層默認通過netty啓動，所以在使用Gateway網關組件時，無需引入Tomcat容器組件；

二. Spring Cloud Gateway能解決什麼問題

網關具有身份認證與安全、審查與監控、動態路由、負載均衡、緩存、請求分片與管理、靜態響應處理等功能。當然最主要的職責還是與“外界聯繫”，起到一個門戶的作用。

總結一下，網關應當具備以下功能：

性能： API 高可用，負載均衡，容錯機制。
安全： 權限身份認證、脫敏，流量清洗，後端簽名（保證全鏈路可信調用），黑名單（非法調用的限制）。
日誌： 日誌記錄，一旦涉及分佈式，全鏈路跟蹤必不可少。
緩存： 數據緩存。
監控： 記錄請求響應數據，API 耗時分析，性能監控。
限流： 流量控制，錯峯流控，可以定義多種限流規則。
灰度： 線上灰度部署，可以減小風險。
路由： 動態路由規則。

三. 生產上網關和Nginx搭配部署

1、前端頁面調用接口請求Nginx服務器，如果是靜態資源，則返回Nginx上緩存的資源

2、Nginx負載均衡調用後端的網關（網關服務多臺部署，高可用）

3、網關做身份驗證，服務路由，日誌記錄等等操作，

4、網關調用業務接口後，返回業務數據到頁面。

四. 開始實踐

五. 網關服務springcloud-api-gateway

5.1 創建maven工程，pom.xml文件

 <!--SpringBoot依賴版本-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
        <relativePath/>
    </parent>

    <!--項目編碼、jdk版本、SpringCloud版本定義-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    </properties>

    <!--聲明管理SpringCloud版本依賴信息-->
    <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>

    <dependencies>
        <!-- SpringBoot整合Gateway -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

5.2 配置網關路由

Spring Cloud Gateway 網關路由有兩種配置方式：

在配置文件yml 中配置
通過@Bean自定義 RouteLocator，在啓動主類 Application中配置

這兩種方式是等價的，建議使用 yml方式進配置。

1. application.yml形式

#端口號
server:
  port: 8015
#定義服務名稱
spring:
  application:
    name: api-gateway   # 應用名稱
  cloud:
    gateway:
      # 路由規則
      routes:
        #通過Path匹配路由
        - id: product-service        # 路由 ID，唯一
          uri: http://127.0.0.1:8016  # 目標 URI，路由到接口http://127.0.0.1:8015/product/getProductInfo
          predicates:                # 斷言（判斷條件）
            - Path=/product/**       # 匹配對應 URL 的請求，將匹配到的請求追加在目標 URI 之後

#Gateway日誌級別
logging:
  level:
    org.springframework.cloud.gateway: debug

對上述字段含義解釋一下：

id： 我們自定義的路由 ID，保持唯一
uri： 目標服務地址
predicates： 路由條件，Predicate 接受一個輸入參數，返回一個布爾值結果。該接口包含多種默認方法來將 Predicate 組合成其他複雜的邏輯（比如：與，或，非）。
filters： 過濾規則，本示例暫時沒用。

上述配置是當請求：http://127.0.0.1:8015/product/getProductInfo時，會通過product匹配到路由，通過IP+Port，自動轉發到http://127.0.0.1:8016 所在的服務機器，然後拼接http://127.0.0.1:8016 +/product/getProductInfo，組成一個完整的請求地址，請求到Product服務接口： http://127.0.0.1:8015/product/getProductInfo，因此網關暴露的接口地址並非真實的API接口地址，在網關層會進行過濾轉發。

2. 通過@Bean自定義RouteLocator形式

package com.thinkingcao.gateway.route;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @desc:  java寫法路由配置
 * @author: cao_wencao
 * @date: 2020-06-30 14:28
 */
@Slf4j
@Configuration
public class ProductRouteLocator{
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route("product-service", r -> r.path("/product/**")
                        .uri("http://127.0.0.1:8016"))
                .build();
    }
}

上面配置類等同於yml形式配置，解釋如下

id: 定義一個id爲product-service。
path: 定義一個path匹配/product/**
uri: 轉發的uri 爲http://127.0.0.1:8016

5.3 啓動類

package com.thinkingcao.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @desc:  Api Gateway網關
 * @author: cao_wencao
 * @date: 2020-06-23 13:07
 */
@SpringBootApplication
public class AppGateway {
    public static void main(String[] args) {
        SpringApplication.run(AppGateway.class, args);
    }
}

六. 商品服務springcloud-product-service

6.1 創建maven項目，pom依賴如下

 <!--SpringBoot依賴版本-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
        <relativePath/>
    </parent>

    <!--項目編碼、jdk版本、SpringCloud版本定義-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    </properties>

    <!--聲明管理SpringCloud版本依賴信息-->
    <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>

    <!--依賴信息-->
    <dependencies>
        <!-- SpringBoot整合Web組件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--Lombok簡化代碼插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

    </dependencies>

    <!--maven插件-->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

6.2 application.yml

server:
  port: 8016
#定義服務名稱
spring:
  application:
    name: product-service

6.3 商品服務接口

/**
 * @desc:   商品服務
 * @author: cao_wencao
 * @date: 2020-06-28 10:34
 */
@RestController
@RequestMapping("/product")
public class ProductController {
    @RequestMapping("/getProductInfo")
    public Map<String,String> getProductInfo(){
        Map<String,String> productsMap = new HashMap<>();
        productsMap.put("productNo","111");
        productsMap.put("productName","荔枝");
        productsMap.put("productDesc","一騎紅塵妃子笑，無人知是荔枝來");
        productsMap.put("productPrice","11.0");
        productsMap.put("productWeight","10.0");
        return productsMap;
    }
}

6.4 啓動類

/**
 * @desc:   商品服務
 * @author: cao_wencao
 * @date: 2020-06-23 13:17
 */
@SpringBootApplication
public class AppProduct{
    public static void main(String[] args) {
        SpringApplication.run(AppProduct.class,args);
    }
}

七. 運行測試

訪問http://127.0.0.1:8015/product/getProductInfo，路由轉發到http://127.0.0.1:8016/product/getProductInfo

Spring Cloud系列教程(十六)：下一代網關服務Gateway-入門篇(Finchley版本)

一.什麼是Spring Cloud Gateway

二. Spring Cloud Gateway能解決什麼問題

三. 生產上網關和Nginx搭配部署

四. 開始實踐

五. 網關服務springcloud-api-gateway

5.1 創建maven工程，pom.xml文件

5.2 配置網關路由

5.3 啓動類

六. 商品服務springcloud-product-service

6.1 創建maven項目，pom依賴如下

6.2 application.yml

6.3 商品服務接口

6.4 啓動類

七. 運行測試

八. 源碼

源碼：https://github.com/Thinkingcao/SpringCloudLearning/tree/master/springcloud-first-gateway

下一篇： Spring Cloud系列教程(十七)：下一代網關服務Gateway-謂詞篇(Finchley版本)

【面試準備】又一次失敗的面試經歷，題目離譜～資深軟件測試工程師

dotnet 8 版本與銀河麒麟V10和UOS系統的 glibc 兼容性

Spring Cloud系列教程(十六)：下一代網關服務Gateway-入門篇(Finchley版本)

Spring Cloud系列教程(十九)：下一代網關服務Gateway-全局Filter(Finchley版本)

傳統SSM的Web項目如何設置項目訪問鏈接名稱

CentOS 7.X下MySQL 5.7 的安裝與配置

Java開發微信公衆號之被動回覆用戶消息-回覆圖片消息

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結