使用 Spring Cloud 閘道

發行項
10/01/2024

注意

基本、標準和企業方案將從 2025 年 3 月中旬開始淘汰，並停用 3 年。建議您轉換至 Azure Container Apps。如需詳細資訊，請參閱 Azure Spring Apps 淘汰公告。

標準 耗用量和專用 方案將從 2024 年 9 月 30 日起淘汰，並在六個月後完成關閉。建議您轉換至 Azure Container Apps。如需詳細資訊，請參閱將 Azure Spring Apps 標準取用和專用方案遷移至 Azure Container Apps。

本文適用於：❌基本/標準 ✔️ Enterprise

本文說明如何使用 VMware Spring Cloud Gateway 搭配 Azure Spring Apps Enterprise 方案，將要求路由傳送至您的應用程式。

VMware Spring Cloud Gateway 是以開放原始碼 Spring Cloud Gateway 專案為基礎的商業 VMware Tanzu 元件。 Spring Cloud Gateway 會處理 API 開發小組的跨領域考量，例如單一登入 (SSO)、存取控制、速率限制、復原、安全性等。您可以使用新式雲端原生模式，以及您為 API 開發選擇的任何程式設計語言，加速 API 傳遞。

Spring Cloud Gateway 包含下列功能：

動態路由設定，與可以套用和變更且不需要重新編譯的個別應用程式無關。
商業 API 路由篩選器，用於將授權的 JSON Web 令牌（JWT）宣告傳輸至應用程式服務。
用戶端憑證授權。
速率限制方法。
斷路器設定。
支援透過 HTTP 基本驗證認證存取應用程式服務。

為了與 VMware Tanzu 的 API 入口網站整合，VMware Spring Cloud Gateway 會在任何路由設定新增或變更之後自動產生 OpenAPI 第 3 版檔。

必要條件

已經佈建的 Azure Spring 應用程式企業方案服務執行個體，且已啟用 Spring Cloud 閘道。如需詳細資訊，請參閱快速入門：使用 Enterprise 方案建置應用程式並將其部署至 Azure Spring 應用程式。
Azure CLI 2.0.67 版或更新版本。使用下列命令安裝 Azure Spring 應用程式延伸模組：az extension add --name spring。

設定路由

本節說明如何新增、更新和管理使用 Spring Cloud Gateway 之應用程式的 API 路由。

路由組態定義包含下列部分：

OpenAPI URI：此 URI 參考 OpenAPI 規格。您可以使用公用 URI 端點，例如 https://petstore3.swagger.io/api/v3/openapi.json 或建構的 URI，例如 http://<app-name>/{relative-path-to-OpenAPI-spec}，其中 <app-name> 是 Azure Spring Apps 中包含 API 定義的應用程式名稱。同時支援 OpenAPI 2.0 和 OpenAPI 3.0 規格。如果已啟用，規格會顯示在 API 入口網站中。
routes：路由規則清單，將流量導向至應用程式並套用篩選。
通訊協定：Spring Cloud Gateway 路由傳送流量的應用程式後端通訊協定。通訊協定支援的值為 HTTP 或 HTTPS，且預設值為 HTTP。若要保護從 Spring Cloud Gateway 到已啟用 HTTPS 的應用程式流量，您必須在路由設定中將通訊協定設定為 HTTPS 。
應用程式層級路由：您可以在應用程式層級設定三個路由屬性，以避免在路由設定中重複所有或大部分路由。具體路由規則會覆寫相同屬性的應用程式層級路由規則。您可以在應用程式層級定義下列屬性： predicates、 filters和 ssoEnabled。如果您使用 OpenAPI URI 功能來定義路由，唯一支援的應用程式層級路由屬性是 filters。

使用下列命令來建立路由設定。此值 --app-name 應該是要求路由傳送至 Azure Spring Apps 中裝載的應用程式名稱。

az spring gateway route-config create \
    --name <route-config-name> \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --app-name <app-name> \
    --routes-file <routes-file.json>

下列範例示範在 create 命令中傳遞至 --routes-file 參數的 JSON 檔案：

{
   "predicates": [
      "<app-level-predicate-of-route>",
   ],
   "ssoEnabled": false,
   "filters": [
      "<app-level-filter-of-route>",
   ],
   "openApi": {
      "uri": "<OpenAPI-URI>"
   },
   "protocol": "<protocol-of-routed-app>",
   "routes": [
      {
         "title": "<title-of-route>",
         "description": "<description-of-route>",
         "predicates": [
            "<predicate-of-route>",
         ],
         "ssoEnabled": true,
         "filters": [
            "<filter-of-route>",
         ],
         "tags": [
            "<tag-of-route>"
         ],
         "order": 0
      }
   ]
}

下表列出路由定義。所有屬性都是選擇性的。

屬性	描述
title	要套用至所產生 OpenAPI 檔中方法的標題。
description	要套用至所產生 OpenAPI 檔中方法的描述。
uri	完整 URI，其會覆寫要求路由至的應用程式名稱。
ssoEnabled	值，指出是否啟用 SSO 驗證。請參閱設定單一登錄。
tokenRelay	將目前已驗證使用者的身分識別令牌傳遞至應用程式。
謂詞	述詞的清單。請參閱可用的述詞。
篩選	篩選清單。請參閱可用的篩選。
訂單	路由處理順序。較低順序的處理優先順序較高，如 Spring Cloud Gateway 中所示。
標記	套用至所產生 OpenAPI 檔中方法的分類標籤。

注意

由於安全性或相容性原因，Azure Spring Apps 不支援所有篩選/述詞。不支援下列專案：

BasicAuth
JWTKey