你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

使用 Spring Cloud 网关

项目
10/01/2024

注意

从 2025 年 3 月中旬开始，基本、标准和企业计划将弃用，停用期为三年。建议过渡到 Azure 容器应用。有关详细信息，请参阅 Azure Spring Apps 停用公告。

从 2024 年 9 月 30 日开始，标准消耗和专用计划将弃用，六个月后将完全关闭。建议过渡到 Azure 容器应用。有关详细信息，请参阅将 Azure Spring Apps 标准消耗和专用计划迁移到 Azure 容器应用。

本文适用于：❌ 基本版/标准版 ✔️ 企业版

本文演示了如何将 VMware Spring Cloud 网关与 Azure Spring Apps 企业计划配合使用，将请求路由到应用程序。

VMware Spring Cloud 网关是一个基于开源 Spring Cloud 网关项目的商业 VMware Tanzu 组件。 Spring Cloud 网关处理 API 开发团队的横切关注点，例如单一登录 (SSO)、访问控制、速率限制、复原能力、安全性等。你可以使用新式云本机模式以及你为 API 开发选择的任何编程语言来加速 API 交付。

Spring Cloud 网关包括以下功能：

动态路由配置，独立于无需重新编译即可应用和更改的单个应用程序。
用于将授权的 JSON Web 令牌 (JWT) 声明传输到应用程序服务的商业 API 路由筛选器。
客户端证书授权。
速率限制方法。
断路器配置。
支持通过 HTTP 基本身份验证凭据访问应用程序服务。

要与API portal for VMware Tanzu集成，VMware Spring Cloud 网关会在任何路由配置增添或变更后自动生成 OpenAPI 版本 3 文档。

先决条件

已启用 Spring Cloud 网关的已预配 Azure Spring Apps 企业计划服务实例。有关详细信息，请参阅快速入门：使用企业计划生成应用并将其部署到 Azure Spring Apps。
Azure CLI 2.0.67 或更高版本。使用以下命令安装 Azure Spring Apps 扩展：az extension add --name spring。

配置路由

本节介绍如何为使用 Spring Cloud 网关的应用添加、更新和管理 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 网关将流量路由到的应用程序的后端协议。协议支持的值为 HTTP 或 HTTPS，默认值为 HTTP。若要保护从 Spring Cloud 网关到启用了 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
      }
   ]
}

下表列出了路由定义。许多属性是可选的。

properties	说明
title	将应用于生成的 OpenAPI 文档中的方法的标题。
description	将应用于生成的 OpenAPI 文档中的方法的说明。
uri	完整 URI，替代请求路由到的应用的名称。
ssoEnabled	一个值，用于指示是否启用 SSO 验证。请参阅配置单一登录。
tokenRelay	将当前经过身份验证的用户标识令牌传递给应用程序。
谓词	谓词列表。请参阅可用谓词。
filters	筛选器列表。请参阅可用筛选器。
订单	路由处理顺序。顺序越低，处理优先级越高，与 Spring Cloud 网关中一样。
标记	分类标记，应用于生成的 OpenAPI 文档中的方法。

注意

由于安全性或兼容性原因，并非所有筛选器/谓词都在 Azure Spring 应用程序中得到支持。不支持以下各项：

BasicAuth
JWTKey