微服務網關 —— SpringCloud Gateway

来源:https://www.cnblogs.com/Yee-Q/archive/2023/09/02/17673998.html
-Advertisement-
Play Games

## Gateway 簡介 Spring Cloud Gateway 基於 Spring 5、Spring Boot 2 和 Project Reactor 等技術,是在 Spring 生態系統之上構建的 API 網關服務,Gateway 旨在提供一種簡單而有效的方式來對 API 進行路由以及提供一 ...


Gateway 簡介

Spring Cloud Gateway 基於 Spring 5、Spring Boot 2 和 Project Reactor 等技術,是在 Spring 生態系統之上構建的 API 網關服務,Gateway 旨在提供一種簡單而有效的方式來對 API 進行路由以及提供一些強大的過濾器功能,例如熔斷、限流、重試等

Spring Cloud Gateway 具有如下特性:

  • 基於 Spring Framework 5、Project Reactor 以及 Spring Boot 2.0 進行構建
  • 能夠匹配任何請求屬性
  • 可以對路由指定 Predicate(斷言)和 Filter(過濾器)
  • 集成 Hystrix 的斷路器功能
  • 集成 Spring Cloud 服務發現功能
  • 易於編寫的 Predicate 和 Filter
  • 請求限流功能
  • 路徑重寫

Gateway 快速入門

創建項目,引入依賴

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

在配置文件 application.yml 添加如下配置

server:
  port: 9201 # 指定運行埠

spring:
  application:
    name: gateway-service # 指定服務名稱
  cloud:
    gateway:
      routes:
        - id: path_route  # 路由ID
          uri: http://localhost:8201/user/getUser  # 匹配後路由地址
          predicates: # 斷言,路徑相匹配的路由
            - Path=/user/getUser

也可以按如下配置

@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route("path_route2", r -> r.path("/user/getUserInfo")
                        .uri("http://localhost:8201/user/getUserInfo"))
                .build();
    }
}

Gateway 路由工廠

Spring Cloud Gateway 包括許多內置的路由斷言工廠,所有這些斷言都與 HTTP 請求的不同屬性匹配,多個路由斷言工廠可以進行組合

1. After Route Predicate Factory

在指定時間之後的請求會匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - After=2017-01-20T17:42:47.789-07:00[America/Denver]

2. Before Route Predicate Factory

在指定時間之前的請求會匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

3. Between Route Predicate Factory

在指定時間區間內的請求會匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]

帶有指定 Cookie 的請求會匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - Cookie=milk, yili # cookie為milk=yili

5. Header Route Predicate Factory

帶有指定請求頭的請求會匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - Header=X-Request-Id, 1	# 請求頭為X-Request-Id=1

6. Host Route Predicate Factory

帶有指定 Host 的請求會匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - Host=**.somehost.org	# 請求頭為Host:www.somehost.org的請求可以匹配該路由

7. Method Route Predicate Factory

發送指定方法的請求會匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - Method=GET,POST

8. Path Route Predicate Factory

發送指定路徑的請求會匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - Path=/red/(segment],/blue/(segment) # /red/1或/blue/1路徑請求可以匹配該路由

9. Query Route Predicate Factory

帶指定查詢參數的請求可以匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - Query=green # 帶green=l查詢參數的請求可以匹配該路由

10. RemoteAddr Route Predicate Factory

從指定遠程地址發起的請求可以匹配該路由

spring:
  cloud:
    gateway:
      routes:
        - id: after_route
          uri: http://example.org
          predicates:
            - RemoteAddr=192.168.1.1/24 # 從192.168.1.1發起請求可以匹配該路由

11. Weight Route Predicate Factory

使用權重來路由相應請求,以下代碼表示有 80% 的請求會被路由到 weighthigh.org,20% 會被路由到 weightlow.org

spring:
  cloud:
    gateway:
      routes:
        - id: weight-high
          uri: http://weighthigh.org
          predicates:
            - Weight=group1, 8
        - id: weight-low
          uri: http://weightlow.org
          predicates:
            - Weight=group1, 2

可以使用 metadata 為每個 route 增加附加屬性

spring:
  cloud:
    gateway:
      routes:
        - id: route-with-metadata
          uri: http://example.org
          metadata:
          	optionName: "OptionValue"
          	compositeObject:
          		name: "value"
          	iAmNumber: 1

可以從 exchange 獲取所有元數據屬性:

Route route = exchange.getAttribute(GATEWAY_ROUTE_ATTR);
route.getMetadata();
route.getMetadata (someKey);

Gateway 過濾器工廠

路由過濾器可用於修改進入的 HTTP 請求和返回的 HTTP 響應,Spring Cloud Gateway 內置了多種路由過濾器,由 GatewayFilter 的工廠類產生

1. AddRequestParameter GatewayFilter

AddRequestParameter GatewayFilter 是給請求添加參數的過濾器·

spring:
  cloud:
    gateway:
      routes:
        - id: add_request_parameter_route
          uri: http://example.org
          filters:
          	- AddRequestParameter=username, tom	# 對GET請求添加usemame=tom的請求參數
          predicates:
            - Method=GET

2. StripPrefixPath GatewayFilter

PrefixPath GatewayFilter 是對指定數量的路徑前緩進行去除的過濾器

spring:
  cloud:
    gateway:
      routes:
        - id: strip_prefix_route
          uri: http://example.org
          filters:
          	# 把以/user-service/開頭的請求的路徑去除兩位
          	# 相當於http://1ocalhost:9201/user-service/a/user/1
          	# 轉換成http://localhost:8080/user/1
          	- StripPrefix=2 
          predicates:
            - Path=/user-service/**

3. PrefixPath GatewayFilter

與 StripPrefix 過濾器恰好相反,PrefixPath GatewayFilter 會對原有路徑進行增加操作

spring:
  cloud:
    gateway:
      routes:
        - id: prefix_prefix_route
          uri: http://example.org
          filters:
          	# 對所有GET請求添加/user路徑首碼
          	# 相當於http://1ocalhost:9201/get
          	# 轉換成http://localhost:8080/user/get
          	- PrefixPath=/user
          predicates:
            - Method-GET

Gateway 全局過濾器

GlobalFilter 全局過濾器與普通的過濾器 GatewayFilter 具有相同的介面定義,只不過 GlobalFilter 會作用於所有路由

發起請求時,Filtering Web Handler 處理器會添加所有 GlobalFilter 實例和匹配的 GatewayFilter 實例到過濾器鏈中,過濾器鏈會使用 @Ordered 註解所指定的順序進行排序,數值越小越靠前執行,預設 GatewayFilter 設置的 order 值為 1,如果 GatewayFilter 和 GlovalFilter 設置的 order 值一樣,優先執行 GatewayFilter

@Component
public class CustomGlobalFilter implements GlobalFilter, ordered {
    
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("custom global filter");
        return chain.filter(exchange);
    }
    
    @Override
    public int getOrder() {
        return -1;
    }
}

Gateway 跨域

Gateway 是支持 CORS 的配置,可以通過不同的 URL 規則匹配不同的 CORS 策略,例如:

spring:
  cloud:
    gateway:
    	globalcors:
            corsConfiqurations:
                '[/**]':
                    allowedOrigins: "https://docs.spring.io"
                    allowedMethods:
                        - GET

在上面的示例中,對於所有 GET 請求,將允許來自 docs.spring.io 的 CORS 請求

Gateway 還提供更為詳細的配置

spring:
  cloud:
    gateway:
    	globalcors:
            cors-confiqurations:
                '[/**]':
                	# 允許攜帶認證信息
                	allow-credentials: true
                	# 允許跨城的源(網站城名/ip),設置*為全部
                    allowed-origins: 
                    - "http://localhost:13009"
                    - "http://localhost:13010"
                    # 允許跨城請求里的head欄位,設置*為全部
                    allowed-headers: "*"
                    # 允許跨城的method,預設為GET和OPTIONS,設置*為全部
                    allowed-methods: 
                    - OPTIONS
                    - GET
                    - POST
                    # 跨域允許的有效期
                    max-age: 3600
                    # 允許response的head信息
                    # 預設僅允許如下6個:
                    # Cache-Control
                    # Content-Language
                    # Content-Type
                    # Expires
                    # Last-Modified
                    # Praqma
                    # exposed-headers:

HTTP 超時配置

1. 全局超時

spring:
  cloud:
    gateway:
    	httpclient:
    		connect-timeout: 1000 # 連接超時配置,單位為毫秒
    		response-timeout: 5s # 響應超時,單位為 java.time.Duration

2. 每個路由配置

spring:
  cloud:
    gateway:
      routes:
        - id: per_route_timeouts
          uri: http://example.org
          predicates:
            - Path=/user-service/**
          metadata:
          	response-timeout: 200 # 響應超時,單位為毫秒
          	connect-timeout: 200 # 連接超時配置,單位為毫秒

TLS/SSL 設置

在 Web 服務應用中,為了數據的傳輸安全,會使用安全證書以及 TLS/SSL 加密,Gateway 可以通過遵循常規的 Spring 伺服器配置來偵聽 HTTPS 上的請求

server:
	ssl:
		# 啟用ssl
		enabled: true
		# 啟用證書
		key-alias: scg
		# 證書密碼
		key-store-password: scg1234
		# 證書地址
		key-store: classpath:scg-keystore.pl2
		# 證書類型
		key-store-type: PKCS12

可以使用以下配置為 Gateway 配置一組可信任的已知證書

spring:
  cloud:
    gateway:
    	httpclient:
    		ssl:
    			trustedX509Certificates:
                - certl.pem
                - cert2.pem

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

-Advertisement-
Play Games
更多相關文章
  • # Keepalived高可用集群 ## 高可用集群簡介 **什麼是高可用集群?** 高可用集群 (High Availability;Cluster,簡稱HA Cluster) ,是指以減少服務中斷時間為目的的伺服器集群技術。它通過保護用戶的業務程式對外不間斷提供的服務,把因軟體、硬體、人為造成的 ...
  • 電機控制和Linux驅動開發哪個方向更好呢? 先說結論:任何一個領域,就像世間的五行,陰陽結合,虛實結合,利弊結合。對於哪個更好,不能一概而論,最重要的是要搞清楚,你更適合哪個? 1、共鳴 當我看到這個問題,也確實是我早些年時所面臨的抉擇,不由得過來回答一下,一來表達自己的看法,二來想以此在互聯網上 ...
  • ![](https://img2023.cnblogs.com/blog/3076680/202309/3076680-20230902225017399-1042005891.png) # 1. 條件邏輯 ## 1.1. SQL邏輯根據特定列或表達式轉向不同的分支來處理 ## 1.2. 在程式執行 ...
  • 學習JavaScript的路徑可以按照以下步驟進行: 瞭解基本概念:首先學習JavaScript的基本概念,包括變數、數據類型、運算符、數組、對象、迴圈和條件語句等。可以通過閱讀相關的教材、線上課程或者參考W3Schools和MDN文檔等來學習。 學習控制DOM元素:學習如何使用JavaScript ...
  • 註:單點登錄原理是一個重要知識點,也常被問及,很多童鞋照葫蘆畫瓢搭建過單點登錄,但是被問到原理時可能說不出來,下麵簡單介紹,拋磚引玉,希望對大家有所幫助。 單點登錄在現在的系統架構中廣泛存在,他將多個子系統的認證體系打通,實現了一個入口多處使用,而在架構單點登錄時,也會遇到一些小問題,在不同的應用... ...
  • >5月份時曾部署上線了C++的Web伺服器,溫故而知新,本篇文章梳理總結一下部署流程知識; >- 最初的解決方案:https://blog.csdn.net/BinBinCome/article/details/129750951?spm=1001.2014.3001.5501 >- 後來的解決方案 ...
  • 運算符用於對變數和值執行操作。 加號運算符(+)將兩個值相加,如下麵的示例所示: **示例代碼:** ```Go package main import ( "fmt" ) func main() { var a = 15 + 25 fmt.Println(a) } ``` 儘管加號運算符通常用於將 ...
  • 寫代碼的時候大腦想的總是數據結構和演算法。大學學習 C 語言的時候, 書上看到的,有位編程大師說的就是, 編程就等於數據結構加演算法。C 語言 有數組這個數據結構。有人說不是啊不是還有鏈表,不是還有棧,不是還 有隊列 其實這 是表象,底層都是以數組的 形式組織設計的。C 語言 編程的時候 會使用到數組, ...
一周排行
    -Advertisement-
    Play Games
  • 隨著Aspire發佈preview5的發佈,Microsoft.Extensions.ServiceDiscovery隨之更新, 服務註冊發現這個屬於老掉牙的話題解決什麼問題就不贅述了,這裡主要講講Microsoft.Extensions.ServiceDiscovery(preview5)以及如何 ...
  • 概述:通過使用`SemaphoreSlim`,可以簡單而有效地限制非同步HTTP請求的併發量,確保在任何給定時間內不超過20個網頁同時下載。`ParallelOptions`不適用於非同步操作,但可考慮使用`Parallel.ForEach`,儘管在非同步場景中謹慎使用。 對於併發非同步 I/O 操作的數量 ...
  • 1.Linux上安裝Docken 伺服器系統版本以及內核版本:cat /etc/redhat-release 查看伺服器內核版本:uname -r 安裝依賴包:yum install -y yum-utils device-mapper-persistent-data lvm2 設置阿裡雲鏡像源:y ...
  • 概述:WPF界面綁定和渲染大量數據可能導致性能問題。通過啟用UI虛擬化、非同步載入和數據分頁,可以有效提高界面響應性能。以下是簡單示例演示這些優化方法。 在WPF中,當你嘗試綁定和渲染大量的數據項時,性能問題可能出現。以下是一些可能導致性能慢的原因以及優化方法: UI 虛擬化: WPF提供了虛擬化技術 ...
  • 引言 上一章節介紹了 TDD 的三大法則,今天我們講一下在單元測試中模擬對象的使用。 Fake Fake - Fake 是一個通用術語,可用於描述 stub或 mock 對象。 它是 stub 還是 mock 取決於使用它的上下文。 也就是說,Fake 可以是 stub 或 mock Mock - ...
  • 為.net6在CentOS7上面做準備,先在vmware虛擬機安裝CentOS 7.9 新建CentOS764位的系統 因為CentOS8不更新了,所以安裝7;簡單就一筆帶過了 選擇下載好的操作系統的iso文件,下載地址https://mirrors.aliyun.com/centos/7.9.20 ...
  • 經過前面幾篇的學習,我們瞭解到指令的大概分類,如:參數載入指令,該載入指令以 Ld 開頭,將參數載入到棧中,以便於後續執行操作命令。參數存儲指令,其指令以 St 開頭,將棧中的數據,存儲到指定的變數中,以方便後續使用。創建實例指令,其指令以 New 開頭,用於在運行時動態生成並初始化對象。方法調用指... ...
  • LiteDB 是一個輕量級的嵌入式 NoSQL 資料庫,其設計理念與 MongoDB 類似,但它是完全使用 C# 開發的,因此與 C# 應用程式的集成非常順暢。與 SQLite 相比,LiteDB 提供了 NoSQL(即鍵值對)的數據存儲方式,並且是一個開源且免費的項目。它適用於桌面、移動以及 We ...
  • 1 開源解析和拆分文檔 第三方的工具去對文件解析拆分,去將我們的文件內容給提取出來,並將我們的文檔內容去拆分成一個小的chunk。常見的PDF word mark down, JSON、HTML。都可以有很好的一些模塊去把這些文件去進行一個東西去提取。 優勢 支持豐富的文檔類型 每種文檔多樣化選擇 ...
  • OOM是什麼?英文全稱為 OutOfMemoryError(記憶體溢出錯誤)。當程式發生OOM時,如何去定位導致異常的代碼還是挺麻煩的。 要檢查OOM發生的原因,首先需要瞭解各種OOM情況下會報的異常信息。這樣能縮小排查範圍,再結合異常堆棧、heapDump文件、JVM分析工具和業務代碼來判斷具體是哪 ...