使用 Rayfin CLI 创建Fabric应用

本教程介绍如何使用 Rayfin CLI 创建项目、在本地运行项目并将其部署到Microsoft Fabric。 无论是新应用，还是后续对架构或前端的更新，你都使用相同的 CLI 工作流。

在本教程中，你将了解：

  • 从模板创建Fabric应用项目。
  • 在本地启动应用。
  • 从 CLI 登录到Microsoft Fabric。
  • 将应用部署到Fabric工作区。
  • 验证部署状态。

先决条件

  • 访问Microsoft Fabric。
  • 具有参与者、成员或管理员权限的Fabric工作区。
  • 已在你的租户中启用的 Fabric 应用工作负载。
  • 已安装 Node.js 和 npm。

如果尚未启用Fabric应用工作负载，请要求Fabric管理员在Fabric管理门户中打开 Fabric Apps（预览版）。

步骤 1：创建新项目

若要从模板搭建新应用，请使用 npm create：

npm create @microsoft/rayfin@latest -- my-app --workspace <workspacename>

此命令使用应用模板、 rayfin 配置和前端源代码创建新的项目文件夹。

转到项目目录：

cd my-app

小窍门

如果已有空项目文件夹或现有源代码，请使用 npx rayfin init 而不是 npm create。

npx rayfin init .

步骤 2：查看生成的项目

完成脚手架搭建后，项目会包含你开始开发所需的文件：

  • rayfin/rayfin.yml 存储应用服务和部署设置。
  • rayfin/.env 存储 CLI 使用的环境值。
  • rayfin/data/ 包含您的数据模型文件。
  • 前端应用位于所选模板创建的根项目结构中。

有关详细的逐文件细分，请参阅 “了解项目结构”。

步骤 3：在本地运行应用

启动本地开发环境：

npm run dev

此命令启动基架应用的前端开发服务器，并将后端部署到Fabric。 若要确认应用正确启动，请打开终端中显示的本地 URL。

步骤 4：将应用部署到Fabric

在应用程序中生成更多功能。 测试更改后，请再次部署到Fabric。

npx rayfin up

若要预览部署而不进行更改，请运行：

npx rayfin up --dry-run

步骤 5：验证部署

检查当前的部署状态：

npx rayfin up status

对于计算机可读响应，请使用 JSON 输出：

npx rayfin up status --json

成功部署后，CLI 将打印已部署项的托管应用 URL 和Fabric门户链接。

步骤 6：仅部署数据库或静态内容

如果仅更改了数据模型，则无需完全重新部署即可应用数据库更改：

npx rayfin up db apply

如果仅更改了前端代码，请重新部署静态资产：

npx rayfin up staticapp deploy

排查常见问题

登录失败或部署返回 401 或 403

再次运行 npx rayfin login ，然后重试 npx rayfin up。

你需要检查 CLI 将执行什么操作

在部署更改之前，请运行 npx rayfin up --dry-run。

应用已部署，但你只是更改了架构

若要独立推送架构更改，请使用 npx rayfin up db apply。 如果执行破坏性更改，例如更改列的类型或删除列，此命令将失败。 若要强制更改，可以使用 --force 标志。 此操作可能是一项重大更改。

后续步骤

  • Last updated on