天天看點

Spring Cloud Gateway 入門

認識 Spring Cloud Gateway

Spring Cloud Gateway 是一款基于 Spring 5,Project Reactor 以及 Spring Boot 2 建構的 API 網關,是 Spring Cloud 微服務生态的主要元件之一。Spring Cloud Gateway 主要負責接口請求的路由分發,并且支援對請求的安全驗證,流量監控和流量控制等擴充操作。另外值得一提的點是,Spring Cloud Gateway 預設采用了非阻塞 I/O 模型實作請求路由的分發。對于處理一些I/O 耗時長的請求上,相比其他一樣用 Java 編寫采用的同步阻塞I/O 模型的網關性能更高,處理的并發數也更高,避免了因為 I/O 阻塞(網絡調用,資料庫操作等)導緻線程空閑下來,仍能繼續處理響應其他請求。

Spring Cloud Gateway 适用場景

作為 API 網關,Spring Cloud Gateway 所提供的功能也很強大,內建了對負載均衡,動态路由,通路控制,限流熔斷,埋點監控等功能的支援。如果現有的微服務體系是以 Java 生态甚至 Spring 生态為基礎的,那麼就十分适合使用 Spring Cloud Gateway 作為 API 應用網關了,讓聚合管理多個微服務 API,對外進行統一的輸出。

同時秉承 Spring 家族的傳統,Spring Cloud Gateway 也旨在提供一個簡單,且高效的方式來進行 API 路由和請求關注點的擴充,對于已經熟悉 Spring 或者 Spring Boot 的開發者來說,Spring Cloud Gateway 學習成本并不高,利用底層架構所帶的注解驅動和自動化配置等特性,使用和擴充起來難度都不算高。

快速上手 Spring Cloud Gateway

利用 Spring Cloud Gateway 能快速搭建一個 API 網關,但在這之前,先介紹一下使用 Spring Cloud Gateway 架構所涉及的一些專用概念,來加深對 Spring Cloud Gateway 的認識,友善後面的使用。

路由:是 Spring Cloud Gateway 中基礎的元件,通常由一個 id 辨別,目标 URI,以及一系列斷言(Predicate)和過濾器組成。

斷言(Predicate):是 Java 8 函數庫的 Predicate 對象,具體類型為 <code>Predicate&lt;ServerWebExchange&gt;</code> ,用于比對 HTTP 請求上資料資訊,如請求頭資訊,請求體資訊。如果對于某個請求的斷言為 true,那麼它所關聯的路由就算比對成功,然後将請求給這個路由處理。

過濾器:用于某一個路由的請求或者響應進行修改的元件,在 Spring Cloud Gateway 都要實作 GatewayFilter 接口,并且需要由基于 GatewayFilterFactory 具體實作類構造。

Spring Cloud Gateway 入門

認識上面三個概念之後,再看上圖所示,就能清楚看出 Spring Cloud Gateway 對用戶端請求的處理過程了,這幫助我們用好 Spring Cloud Gateway 幫助很大。

用戶端請求首先被 GatewayHandlerMapping 擷取,然後根據斷言比對找到對應的路由

找到路由後,走完所關聯的一組請求過濾器的處理方法,請求到目标 URI 所對應的服務程式,獲得服務響應。

網關收到響應後,通過關聯的響應過濾器的處理方法後,同樣由 GatewayHandlerMapping 傳回響應給用戶端。

額外需要注意的是 Spring Cloud Gateway 的過濾器是有序執行的,統一以 order 值的大小決定執行順序,值越小優先級越高,就越先執行。

認識 Spring Cloud Gateway 整體處理請求過程之後,我們現在就快速建構一個基于 Spring Cloud Gateway 的 API 網關,看看在實際應用中還需要注意的哪些地方,需要注意的是本文所使用的 Spring Cloud Gateway 屬于最新的裡程碑版本 2.2.3,對應 Spring Boot 版本為 2.3.1, 并且 Spring Cloud 版本為 Hoxton.SR6 。利用 Spring Initializr ,選擇對應的版本和依賴後快速建立一個項目 <code>spring-cloud-gateway-quick-start</code> ,并且為了實作請求的路由,表現網關的效果,再分别建立使用者服務應用 <code>demo-userservice</code> 和訂單服務應用 <code>demo-orderservice</code> ,各自提供一個可調用 API 接口。

使用者服務暴露 8071 端口,提供 /user/get 接口:

類似,訂單服務暴露 8061 端口,提供 /order/get 接口:

接下來要通過 Spring Cloud Gateway 将兩個服務接口聚合在 spring-cloud-gateway-quick-start 項目中,首先來看下利用 Spring Cloud Gateway API 方式的實作:

接下來要通過 Spring Cloud Gateway 将兩個服務接口聚合在 <code>spring-cloud-gateway-quick-start</code> 項目中,首先來看下利用 Spring Cloud Gateway API 方式的實作:

上述代碼就已經實作 API 路由的功能,是不是很快速,同時啟動 <code>spring-cloud-gateway-quick-start</code> 和其他服務應用,就可以統一通過網關應用通路使用者服務和訂單服務了:

回到 API 實作的代碼, <code>DemogatewayApplication#customRouteLocator</code> 方法中定義了兩個 id 分别為 user-service 和 order-service 的路由,并且設定了比對請求的斷言,以及真正目标請求位址。這裡路由的斷言采用了路徑比對的規則,隻要原始請求位址符合對應的規則就算比對到此路由,但 Spring Cloud Gate 還支援豐富的斷言規則,如主機比對,請求體字段比對,請求資料比對等等,足以滿足定制路由斷言的規則了。

由于使用 API 就是寫死方式将路由規則定義在程式裡了,這樣做擴充性很差,也不好維護。于是更推薦另外一種實作方式:配置化。來看下要實作相同功能,在 application.properties 裡該如何配置:

使用上面的配置,重新開機網關應用,同樣能完成之前 API 方式的效果,由于路由規則轉移到了配置檔案中,就大大友善對 API 的管理,為實作動态路由也提供了可能。當然需要實作動态路由,除了路由配置,還需要進行額外的擴充實作路由規則的動态重新整理,涉及 Spring Cloud Gateway 更進階的用法,本文就不再詳細贅述了,可以等後續進階使用和分析的文章或者參考網上其他實作資料。

為了能對 API 的請求或者響應處理,Spring Cloud Gateway 提供過濾器元件來實作這一功能,并且内置了很多功能強大。另外過濾器分兩類,全局過濾器和網關過濾器,對于全局過濾器,所有比對到路由的請求處理時都會經過全局過濾器處理;而網關過濾器隻有顯示在指定路由上時才會起到左右。

Spring Cloud Gateway 預設的全局過濾器有 8個:

ForwardRoutingFilter

LoadBalancerClientFilter(棄用)

ReactiveLoadBalancerClientFilter

WebClientHttpRoutingFilter

NettyWriteResponseFilter

RouteToRequestUrlFilter

WebsocketRoutingFilter

GatewayMetricsFilter

而網關過濾器就更多了,并且由對應工廠類來構造,比如用于熔斷的 HystrixGatewayFilterFactory ,用于限流的 RequestRateLimiterGatewayFilterFactory,用于修改請求資料的 ModifyRequestBodyGatewayFilterFactory 等等,當然也支援開發者進行定義自己的過濾器。

首先來看下如何自定義一個全局過濾器,代碼實作比較簡單:

這樣就可以為所有路由添加一個全局的過濾器了。不同于全局過濾器的定義,網關過濾器必須在指定路由上進行申明才能生效,參考官方内置的網關攔截器,自定義一個用于授權的簡易網關攔截器工廠如下:

如果要在 user-service 路由下使用,需要在 application.properties 配置檔案添加如下配置:

這裡的名稱就需要跟 MyAuthGatewayFilterFactory 類的 MyAuth 保持一緻,Spring Cloud Gateway 會自動拼接上 AuthGatewayFilterFactory 去查找對應的網關過濾器,沒有找到就會導緻啟動失敗,抛出異常:

配置完對網關應用進行重新開機,這是使用原來的方式去請求使用者服務,已經無法正常通路,隻會傳回校驗授權失敗的資訊,必須以 <code>http://localhost:8080/user/get?from=system</code> 方式通路才能成功擷取到資料,說明定義的授權攔截器已經起了作用。

這裡我們就将全局攔截器和網關攔截器都實作了自定義,通常情況我們都會在網關攔截器上進行擴充定制,也結合内置的過濾器使用。最後将完整的實作代碼上傳到 Github :https://github.com/wrcj12138aaa/spring-cloud-gateway-quick-start ,感興趣的朋友也可以參考下。

Spring Cloud Gateway 入門

往期推薦

日志系統新貴Loki,确實比笨重的ELK輕

接到一個需求,想在頁面上加一個連結有多難?

MySQL中,當 update 修改資料與原資料相同時會再次執行嗎?

Spring Boot 2.x基礎教程:使用EhCache緩存叢集

嘗鮮剛釋出的 SpringFox 3.0.0,以前造的輪子可以不用了...

開源:推薦一個不錯的離線IP位址定位庫