Spring Cloud 之 Gateway.

来源:https://www.cnblogs.com/jmcui/archive/2019/07/28/11259200.html
-Advertisement-
Play Games

一、Gateway 和 Zuul 的區別 Zuul 基於servlet 2.5 (works with 3.x)，使用阻塞API。它不支持任何長期的連接，如websocket。 Gateway建立在Spring Framework 5，Project Reactor 和Spring Boot 2 上 ...


一、Gateway 和 Zuul 的區別

Zuul 基於servlet 2.5 (works with 3.x)，使用阻塞API。它不支持任何長期的連接，如websocket。

Gateway建立在Spring Framework 5，Project Reactor 和Spring Boot 2 上，使用非阻塞API。支持Websocket，因為它與Spring緊密集成，所以它是一個更好的開發者體驗。

為什麼 Spring Cloud 最初選擇了使用 Netflix 幾年前開源的 Zuul 作為網關，之後又選擇了自建 Gateway 呢？有一種說法是，高性能版的 Zuul2 在經過了多次跳票之後，對於 Spring 這樣的整合專家可能也不願意再繼續等待，所以 Spring Cloud Gateway 應運而生。

本文不對 Spring Cloud Gateway 和 Zuul 的性能作太多贅述，基本可以肯定的是 Gateway 作為現在 Spring Cloud 主推的網關方案， Finchley 版本後的 Gateway 比 zuul 1.x 系列的性能和功能整體要好。

二、快速入門

我們來搭建一個基於 Eureka 註冊中心的簡單網關，不對 Gateway 的全部功能做過多解讀，畢竟官方文檔已經寫的很詳細了，或者可以閱讀中文翻譯文檔。

SpringBoot 版本號：2.1.6.RELEASE

SpringCloud 版本號：Greenwich.RELEASE

1. pom.xml

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    </dependencies>
  • spring-cloud-starter-gateway：Spring Cloud Gateway 的啟動類
  • spring-cloud-starter-netflix-hystrix：Hystrix 作為網關的熔斷方案
  • spring-cloud-starter-netflix-eureka-client：將網關納入 Eureka 註冊中心管理
  • spring-boot-starter-data-redis-reactive：限流方案，Spring Cloud Gateway 預設以 redis 實現限流
  • spring-boot-starter-actuator：用來監控 Gateway 的路由信息。

2. application.yml

spring:
  application:
    name: cloud-gateway
  redis:
    host: 127.0.0.1
    timeout: 3000
    password: xxxx
    jedis:
      pool:
        max-active: 8
        max-idle: 4
  cloud:
    gateway:
      enabled: true
      metrics:
        enabled: true
      discovery:
        locator:
          enabled: true
      routes:
        # 普通服務的路由配置
        - id: cloud-eureka-client
          uri: lb://cloud-eureka-client
          order: 0
          predicates:
            - Path=/client/**
          filters:
            #  parts 參數指示在將請求發送到下游之前，要從請求中去除的路徑中的節數。比如我們訪問 /client/hello，調用的時候變成 http://localhost:2222/hello
            - StripPrefix=1
            # 熔斷器
            - name: Hystrix
              args:
                name: fallbackcmd
                # 降級處理
                fallbackUri: forward:/fallback
            # 限流器
            # 這定義了每個用戶 10 個請求的限制。允許 20 個突發，但下一秒只有 10 個請求可用。
            - name: RequestRateLimiter
              args:
                # SPEL 表達式獲取 Spring 中的 Bean，這個參數表示根據什麼來限流
                key-resolver: '#{@ipKeyResolver}'
                # 允許用戶每秒執行多少請求（令牌桶的填充速率）
                redis-rate-limiter.replenishRate: 10
                # 允許用戶在一秒內執行的最大請求數。（令牌桶可以保存的令牌數）。將此值設置為零將阻止所有請求。
                redis-rate-limiter.burstCapacity: 20
        # websocket 的路由配置
        - id: websocket service
          uri: lb:ws://serviceid
          predicates:
            - Path=/websocket/**
management:
  endpoints:
    web:
      exposure:
        # 開啟指定端點
        include: gateway,metrics
eureka:
  client:
    service-url:
      defaultZone: http://user:password@localhost:1111/eureka/
  • spring.redis.*： redis 相關配置是為了實現 Gateway 的限流方案。
  • eureka.client.*：eureka 註冊中心信息。
  • spring.cloud.gateway.discovery.locator.enabled：將網關配置為基於使用相容 DiscoveryClient 註冊中心註冊的服務來創建路由。
  • spring.cloud.gateway.routes.*：配置路由信息
    • id：路由唯一標識
    • uri：路由轉發地址，以 lb 開頭的路由，會由 ribbon 處理，轉發到 cloud-eureka-client 的服務處理。也可配置成 http 的單機路由 — http://localhost:2222。
    • order：路由執行順序（也可理解成過濾器的執行順序），執行順序是從小到大執行，較高的值被解釋為較低的優先順序。
    • predicates：路由斷言，匹配訪問路徑為 "/client/**" 的請求。
    • filters：網關的過濾器配置
  • management.endpoints.web.exposure.include：暴露 actuator 可以訪問的端點
    • /actuator/gateway/routes 查看路由列表
    • /actuator/gateway/globalfilters 檢索全局路由 — 對所有路由生效
    • /actuator/gateway/routefilters 檢索局部路由 — 可配置只對單個路由生效
    • /actuator/gateway/refresh 清理路由緩存
    • /actuator/metrics/gateway.requests 獲得路由請求數據

3. GatewayApplication.java

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {

    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class, args);
    }

    /**
     * 限流的鍵定義，根據什麼來限流
     */
    @Bean
    public KeyResolver ipKeyResolver() {
        return exchange -> Mono.just(exchange.getRequest().getRemoteAddress().getHostName());
    }

}

三、過濾器

Spring Cloud Gateway 同 Zuul 類似，有 “pre” 和 “post” 兩種方式的 filter。客戶端的請求先經過 “pre” 類型的 filter，然後將請求轉發到具體的業務服務，收到業務服務的響應之後，再經過“post”類型的filter處理，最後返迴響應到客戶端。

與 Zuul 不同的是，filter 除了分為 “pre” 和 “post” 兩種方式的 filter 外，在 Spring Cloud Gateway 中，filter 從作用範圍可分為另外兩種，一種是針對於單個路由的 gateway filter，它需要像上面 application.yml 中的 filters 那樣在單個路由中配置；另外一種是針對於全部路由的global gateway filter，不需要單獨配置，對所有路由生效。

全局過濾器

我們通常用全局過濾器實現鑒權、驗簽、限流、日誌輸出等。

通過實現 GlobalFilter 介面來自定義 Gateway 的全局過濾器；通過實現 Ordered 介面或者使用 @Order 註解來定義過濾器的執行順序，執行順序是從小到大執行，較高的值被解釋為較低的優先順序。

    @Bean
    @Order(-1)
    public GlobalFilter a() {
        return (exchange, chain) -> {
            log.info("first pre filter");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("third post filter");
            }));
        };
    }

    @Bean
    @Order(0)
    public GlobalFilter b() {
        return (exchange, chain) -> {
            log.info("second pre filter");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("second post filter");
            }));
        };
    }

    @Bean
    @Order(1)
    public GlobalFilter c() {
        return (exchange, chain) -> {
            log.info("third pre filter");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("first post filter");
            }));
        };
    }

優先順序最高的 filter ，它的 “pre” 過濾器最先執行，“post” 過濾器最晚執行。

局部過濾器

我們來定義一個 “pre” 類型的局部過濾器：

@Component
public class PreGatewayFilterFactory extends AbstractGatewayFilterFactory<PreGatewayFilterFactory.Config> {
    
    public PreGatewayFilterFactory() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
        // grab configuration from Config object
        return (exchange, chain) -> {
            //If you want to build a "pre" filter you need to manipulate the
            //request before calling chain.filter
            ServerHttpRequest.Builder builder = exchange.getRequest().mutate();
            //use builder to manipulate the request
            ServerHttpRequest request = builder.build();
            return chain.filter(exchange.mutate().request(request).build());
        };
    }

    public static class Config {
        //Put the configuration properties for your filter here
    }
}

其中，需要的過濾器參數配置在 PreGatewayFilterFactory.Config 中。然後，接下來我們要做的，就是把局部過濾器配置在需要的路由上，根據 SpringBoot 約定大於配置的思想，我們只需要配置 PreGatewayFilterFactory.java 中，前面的參數就行了，即

spring:
  cloud:
    gateway:
      routes:
        - id: cloud-eureka-client
          uri: lb://cloud-eureka-client
          order: 0
          predicates:
            - Path=/client/**
          filters:
            - pre

tips：可以去閱讀下 Gateway 中預設提供的幾種過濾器，比如 StripPrefixGatewayFilterFactory.java 等。

四、動態路由

Spring Cloud Gateway 實現動態路由主要利用 RouteDefinitionWriter 這個 Bean：

public interface RouteDefinitionWriter {

    Mono<Void> save(Mono<RouteDefinition> route);

    Mono<Void> delete(Mono<String> routeId);
}

之前翻閱了網上的一些文章，基本都是通過自定義 controller 和出入參，然後利用 RouteDefinitionWriter 實現動態網關。但是，我在翻閱 Spring Cloud Gateway 文檔的時候，發現 Gateway 已經提供了類似的功能：

@RestControllerEndpoint(id = "gateway")
public class GatewayControllerEndpoint implements ApplicationEventPublisherAware {

    /*---省略前面代碼---*/

    @PostMapping("/routes/{id}")
    @SuppressWarnings("unchecked")
    public Mono<ResponseEntity<Void>> save(@PathVariable String id, @RequestBody Mono<RouteDefinition> route) {
        return this.routeDefinitionWriter.save(route.map(r ->  {
            r.setId(id);
            log.debug("Saving route: " + route);
            return r;
        })).then(Mono.defer(() ->
            Mono.just(ResponseEntity.created(URI.create("/routes/"+id)).build())
        ));
    }

    @DeleteMapping("/routes/{id}")
    public Mono<ResponseEntity<Object>> delete(@PathVariable String id) {
        return this.routeDefinitionWriter.delete(Mono.just(id))
                .then(Mono.defer(() -> Mono.just(ResponseEntity.ok().build())))
                .onErrorResume(t -> t instanceof NotFoundException, t -> Mono.just(ResponseEntity.notFound().build()));
    }

     /*---省略後面代碼---*/
}

要創建一個路由，發送POST請求 /actuator/gateway/routes/{id_route_to_create}，參數為JSON結構，具體參數數據結構：

{
  "id": "first_route",
  "predicates": [{
    "name": "Path",
    "args": {"_genkey_0":"/first"}
  }],
  "filters": [],
  "uri": "http://www.uri-destination.org",
  "order": 0
}]

要刪除一個路由，發送 DELETE請求 /actuator/gateway/routes/{id_route_to_delete}

五、附錄


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 使用 Spring Framework 時常犯的十大錯誤
    Spring 可以說是最流行的 Java 框架之一，也是一隻需要馴服的強大野獸。雖然它的基本概念相當容易掌握，但成為一名強大的 Spring 開發者仍需要很多時間和努力。 在本文中，我們將介紹 Spring 中一些常見的錯誤，特別是面向 Web 應用程式和 Spring Boot。正如 Spring ...
  • 通過位元組碼展示Java8 Lambda的實現
    Java8 增加了 Lambda 表達式，很大程度使代碼變的更加簡潔緊湊了，那麼 Java8 是如何實現 Lambda 表達式的呢？ 直接看一個簡單的創建線程的例子。 執行 編譯生成文件 ，然後用 命令來分析這個class文件。 執行 顯示所有類和成員。 由上面的代碼可以看出編譯器根據 Lambda ...
  • Java描述設計模式(05)：原型模式
    一、原型模式簡介 1、基礎概念 原型模式屬於對象的創建模式。通過給出一個原型對象來指明所有創建的對象的類型，然後用複製這個原型對象的辦法創建出更多同類型的對象。 2、模式結構 原型模式要求對象實現一個可以“克隆”自身的介面，這樣就可以通過複製一個實例對象本身來創建一個新的實例。這樣一來，通過原型實例 ...
  • Java collection 集合類架構
    https://www.cnblogs.com/fireflyupup/p/4875130.html Collection List 在Collection的基礎上引入了有序的概念，位置精確；允許相同元素。在列表上迭代通常優於索引遍歷。特殊的ListIterator迭代器允許元素插入、替換，雙向訪問 ...
  • Apache和Spring提供的StopWatch執行時間監視器
    一個可以沉迷於技術的程式猿，wx加入加入技術群：fsx641385712 ...
  • 【Python基礎】11_Python中的字元串
    1.字元串的定義 可以使用""雙引號，也可以使用''單引號定義字元串，一般使用雙引號定義。 2.字元串的操作 判斷類型： 查找和替換 大小寫切換： 文本對齊 註：string.center(weight,str) 以str填充對齊，其他兩個方法類似，都可以拓展。 去除空白字元 拆分和鏈接 3.字元串 ...
  • F#周報2019年第30期
    新聞 "Fantomas 3.0" "宣告.NET Core 3.0預覽版7" ".NET Core 3.0預覽版7中ASP.NET Core與Blazor的升級" "Visual Studio 2019版本16.2正式版本與16.3預覽版1" "Mac上的Visual Studio 2019版本8 ...
  • Java學習第四天
    1.數組： java.lang.ArrayIndexOutOfBoundsException：5 下標越界異常 java.lang.NullPointerException 空指針異常 arr.length獲取數組長度 數組存儲的是多個數，數據的操作離不開迴圈2數組初始化：int[] arr=new ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類