跳到主要内容

Studio 项目管理

“我的工程”页面用于维护 Studio 本地工程。完整端到端操作可同时参考 Studio Web 操作手册

页面用途

Studio 项目管理用于维护本地工程,并完成开发运行、导入导出、插件管理、上传 Watchdog、从 Watchdog 下载工程等操作。

我的工程页面

区域或操作说明
排序支持按更新时间、创建时间或名称排序。
视图切换桌面端可在列表视图和卡片视图之间切换。
新建工程打开工程抽屉,创建本地工程。
停止运行时本地运行时正在运行时显示,用于停止正在运行的项目。
导入工程从 ZIP 工程包导入本地工程。
从网关下载从已配置的 Watchdog 服务下载项目包。
网关版本查看 Studio 使用的 GatewayRuntime 当前版本、最新版本和更新状态。
工程操作每个工程支持启动/停止运行时、编辑、导出、上传、插件管理和删除。

工程生命周期

阶段Studio 操作说明
创建新建工程或导入 ZIP建议写清工程名称和描述,便于发布、备份和回传识别。
本地调试启动运行时并进入 GatewayRuntime WebStudio 会启动本地运行时,打开网关 Web 后继续配置通道、设备、变量、脚本等。
插件整理插件管理发布前确认缺失插件、核心插件和可选插件状态。
发布上传到 Watchdog选择目标 Watchdog、发布类型、目标环境、运行时和插件。
回传从网关下载将现场 Watchdog 中的项目下载回 Studio,便于排查和二次维护。
归档导出 ZIP用于版本留存、迁移或交付。

新建或编辑工程

点击“新建工程”,或在工程更多菜单中点击“编辑”,打开工程抽屉。

新建工程抽屉

配置项说明
工程名称必填,长度校验为 2-50 个字符。建议包含现场、产线或设备组信息。
工程描述可选,用于记录用途、版本说明、现场差异或维护备注。
保存新建时创建工程,编辑时更新工程名称和描述。
取消关闭抽屉,不保存本次修改。

启动本地运行时

在列表或卡片中点击工程本身,或点击工程主按钮“启动运行时”。Studio 会启动该工程的本地运行时并打开 GatewayRuntime Web。

状态页面表现操作建议
未运行主按钮显示启动运行时。点击后等待运行时启动,启动中卡片会显示遮罩。
运行中工程显示运行状态,主按钮可停止运行时。点击工程会直接打开 GatewayRuntime Web。
切换工程启动另一个工程时,正在运行的开发工程会切换。切换前确认当前 GatewayRuntime Web 中的配置已保存。
开发运行说明

Studio 项目页只负责启动和停止本地运行时。进入 GatewayRuntime Web 后,通道、设备、变量、脚本、节点、数据转发等配置按 GatewayRuntime 的操作手册执行。

导入工程

点击工具栏“导入工程”,选择 ZIP 工程包。

导入工程弹窗

配置项说明
工程包仅支持 ZIP 文件。可以拖拽到上传区域,也可以点击选择。
导入工程名称可选。填写后使用该名称导入;不填写时使用工程包原始名称。
确认选择文件后可执行导入。

导入后应检查工程列表中名称、描述、更新时间是否符合预期,并打开插件管理查看是否存在缺失插件。

导出工程

在工程更多菜单中点击“导出”。浏览器会下载 ${工程名称}.zip 工程包,可用于迁移、归档或提交给维护人员排查问题。

使用场景说明
版本归档在发布前后各导出一次,便于回滚和比对。
迁移交付将工程移动到另一台 Studio 或交给现场人员。
问题排查将现场工程导出给维护人员复现。

插件管理

在工程更多菜单中点击“插件管理”,打开插件抽屉。

插件管理抽屉

配置项或操作说明
插件总数/启用数抽屉顶部显示当前工程插件数量和已启用数量。
勾选框选择多个插件后可批量启用或批量禁用。
插件名称插件包标识。
版本插件版本。
状态显示已启用、已禁用、缺失等状态。
启用启用未选择且未缺失的插件。
禁用禁用已选择插件;核心插件按钮不可用。

发布前重点检查“缺失”状态。缺失插件不会因为上传工程而自动补齐,必须先处理本地插件来源或在上传抽屉中确认随包插件选择。

上传工程到 Watchdog

在工程更多菜单中点击“上传”,打开上传抽屉。

上传工程到网关抽屉

配置项说明
工程名称当前待上传工程,只读显示。
目标网关从已配置的 Watchdog 服务中选择。没有可选项时,需要先到“看门狗”页面新增服务。
发布方式正常发布AOT发布。正常发布用于常规部署;AOT发布用于目标环境明确、希望使用独立运行包的部署。
目标环境运行时标识,例如 Windows/Linux 及 CPU 架构组合。AOT发布或跨平台发布时必须认真填写,填错可能导致目标网关无法启动发布包。
更新RUNTIME上传时同时更新目标 GatewayRuntime 程序文件。生产环境建议在维护窗口使用。
强制还原NuGet发布时重新还原依赖。依赖异常、构建缓存异常或切换目标环境后可使用;网络无法访问 NuGet 源时可能导致发布失败。
选择插件选择随工程上传的插件;缺失插件、核心插件和不支持 AOT 的插件按界面状态处理。
上传目标网关已选择后可执行上传。

发布前检查

  1. 在“看门狗”页面测试目标 Watchdog 连接成功。
  2. 在“插件管理”确认工程没有缺失插件。
  3. 在 Watchdog Web 的“备份管理”中为目标项目创建备份。
  4. 正常发布用于常规部署;AOT发布需要确认目标环境和插件兼容性。
  5. AOT发布会排除名称包含 NOTAOTNOAOT 的插件。工程依赖这些插件时,不要选择 AOT发布。
  6. 勾选“更新RUNTIME”会影响目标 GatewayRuntime 程序文件,生产环境应安排维护窗口。
  7. 勾选“强制还原NuGet”会重新还原依赖;发布失败时检查 NuGet 源、网络和目标环境标识。

从网关下载工程

点击工具栏“从网关下载”,打开下载抽屉。

从网关下载工程抽屉

配置项说明
源网关选择已配置的 Watchdog 服务。
项目列表选择该 Watchdog 上的项目包。切换源网关后会重新加载项目列表。
覆盖已有工程本地存在同名工程时允许覆盖。未勾选时,重名项目会下载失败或被阻止。
下载源网关和项目都选择后可执行下载。

下载后建议打开工程并进入 GatewayRuntime Web,确认通道、设备、变量和插件状态与现场一致。

网关版本

点击工具栏“网关版本”,查看 Studio 使用的 GatewayRuntime 当前版本、最新版本和是否有更新。存在更新时可点击更新按钮,更新前会出现确认提示。

字段说明
当前版本Studio 使用的 GatewayRuntime 版本。
最新版本检查到的最新 GatewayRuntime 版本。
状态显示是否为最新版本。
更新版本有更新时可用;执行前确认当前工程和运行时状态。

常见问题

现象处理建议
新建工程保存失败检查工程名称是否为空、长度是否在 2-50 个字符之间。
点击工程后打不开 GatewayRuntime Web检查本地运行时是否启动成功,必要时停止后重新启动。
上传抽屉没有目标网关先到“看门狗”页面新增 Watchdog 服务并测试连接。
上传失败检查 Watchdog 是否在线、工程插件是否缺失、发布类型和目标环境是否匹配。
下载工程列表为空检查源 Watchdog 是否在线、账号密码是否正确、Watchdog 项目管理中是否存在项目包。
AOT发布异常检查目标环境、运行时文件、插件是否支持 AOT;名称包含 NOTAOTNOAOT 的插件不会随 AOT发布使用。