sapse/approuter

sapse/approuter

概述

当业务应用由多个不同应用（微服务）组成时，应用路由器用于为该业务应用提供单一入口点。其主要职责包括：

• 分发请求至后端微服务（反向代理）
• 对用户进行身份验证
• 提供静态内容服务

!应用路由器概述图

可将不同应用（微服务）视为请求将被转发到的“目标”（destinations）。决定哪些请求应转发到哪个目标的规则称为“路由”（routes）。每个目标可对应多个路由。有关路由的更多概念将在本文档后续部分介绍。如果后端微服务需要身份验证，应用路由器可配置为对用户进行身份验证并传播用户信息。同样通过路由，应用路由器可以提供静态内容服务。

应用路由器设计用于 XS Advanced - Cloud Foundry 和 XS OnPremise Runtime 环境。

仅当没有可用 JWT 令牌时（例如，用户通过 Web 浏览器调用应用），调用组件才通过应用路由器访问目标服务。如果已存在 JWT 令牌（例如，用户已通过身份验证，或调用组件使用 JWT 令牌作为其自身 OAuth 客户端），调用组件将直接调用目标服务，无需使用应用路由器。

注意：应用路由器不会以任何方式隐藏后端微服务。它们仍然可以绕过应用路由器直接访问。因此，后端微服务必须通过验证 JWT 令牌并实施适当的范围检查来保护其所有端点。平台目前不提供网络隔离。

使用微服务部署业务应用

例如，我们有一个具有以下结构的业务应用：

+-- manifest.yml
+-- manifest-op.yml
|  +-- microservice-1
|  | +-- ...
|  | +-- ...
|  +-- microservice-2
|  | +-- ...
|  | +-- ...
|  +-- web
|  | +-- ...
|  | +-- ...

manifest.yml 文件用于在 Cloud Foundry 上部署业务应用，manifest-op.yml 用于在 XS OnPremise Runtime 上部署。这些文件应描述该业务应用的所有微服务。

文件夹用于隔离不同的微服务。假设应用路由器是 web 文件夹中的微服务（每个业务应用都有自己的应用路由器）。以下是包含应用路由器的方法：

• 在 web 文件夹中手动创建 node_modules 文件夹。
• 将包含独立应用路由器的文件夹复制到 node_modules 中。在此示例中，该文件夹名称为 @sap/approuter，参见下面 package.json 中的 start 脚本。
• 检查刚复制的应用路由器版本。
• 在 web 中创建 package.json 文件，内容类似以下示例，并将版本值替换为应用路由器的实际版本：

json
{
    "name": "hello-world-approuter",
    "dependencies": {
       "@sap/approuter": "2.6.1"
    },
    "scripts": {
        "start": "node node_modules/@sap/approuter/approuter.js"
    }
}

使用应用路由器无需编写任何 JavaScript 代码。只需在 web 文件夹中提供一些配置。以下是完整示例：

+-- web
| +-- package.json
| +-- xs-app.json
| +-- resources
| | +-- hello-world.html
| | +-- my-page.html
| +-- node_modules
| |   +-- ...
| +-- default-env.json
| +-- default-services.json

web 文件夹包含 package.json、node_modules、应用路由器使用的一些配置文件以及要提供的静态资源。有关配置的更多信息将在本文档后续部分介绍。

默认情况下，应用路由器在端口 5000 上运行（如果本地启动），或从 PORT 环境变量获取端口。

工作目录

工作目录包含应用路由器所需的配置文件和可在运行时提供的静态资源。在前面的示例中，web 文件夹是工作目录。默认情况下，当前目录为工作目录。可在应用路由器启动期间使用以下命令行参数配置工作目录：

bash
node approuter.js -w <working-dir>

如果工作目录不包含 xs-app.json 文件，应用路由器将终止。

配置

应用路由器使用以下配置：

• 主配置 - 即 xs-app.json 文件。此文件是必需的，包含应用路由器的主要配置。

• UAA 配置 - 应用路由器从 VCAP_SERVICES 环境变量（部署在 Cloud Foundry 或 XS Advanced OnPremise Runtime 时）或 default-services.json 文件（本地运行时）读取此配置。有关更多详细信息，请参阅 @sap/xsenv 包的文档。

• 环境配置 - 这些配置从应用路由器的环境（部署在 Cloud Foundry 或 XS Advanced OnPremise Runtime 时）或 default-env.json 文件（本地运行时）读取。有关更多详细信息，请参阅 @sap/xsenv 包的文档。应用路由器考虑的环境变量如下：

注意：所有这些环境变量都是可选的。

目标

目标配置可由 destinations 环境变量或目标服务提供。业务应用的每个应用（微服务）都必须有一个目标。

环境目标

目标配置是对象数组。目标可具有以下属性：

注意：指定的超时也将应用于目标的注销路径或服务的注销路径（如果已设置）。
注意：proxyHost 和 proxyPort 是可选的，但如果定义了其中一个，则另一个变为必需的。

目标环境变量的示例内容：

json
[
  {
    "name" : "ui5",
    "url" : "https://ui5.sap.com",
    "proxyHost" : "proxy",
    "proxyPort" : "8080",
    "forwardAuthToken" : false,
    "timeout" : 1200
  }
]

也可将目标包含在 manifest.yml 和 manifest-op.yml 文件中：

yml
- name: node-hello-world
  memory: 100M
  path: web
  env:
    destinations: >
                  [
                    {"name":"ui5", "url":"https://ui5.sap.com"}
                  ]

目标服务

目标配置也可从 目标服务 读取。
以下是应用路由器对从目标服务获取的目标属性配置的限制：

可选附加属性：