跳到主要内容
版本:预览版 · 2026.09

开发声明式插件

声明式插件用 JSON 描述项目专属页面、数据源和权限。业务逻辑仍在项目后端,配置中不携带可执行前端代码。

从真实示例开始​

序基源码提供 examples/ops/xg-archive-plugin.json,演示蹊光档案任务列表。它依赖蹊光实际动作和权限,不能直接替换名称就用在任意项目上。

下面是该示例的身份与能力声明节选,不是完整可发布文件:

插件声明 · 节选
{
"pluginSchemaVersion": "xu-plugin/1",
"pluginId": "net.zhuoan.xg.archive",
"version": "0.1.0",
"name": "蹊光档案运营",
"requires": {
"dataProtocol": "ops-data/1",
"hostFeatures": ["page.list/1", "component.recordList/1", "formatter.enumLabel/1"],
"queryActions": ["net.zhuoan.xg.archive.tasks.list"],
"commandActions": [],
"topicDefinitions": []
}
}

编写顺序​

  1. 在项目后端实现并验证所需查询动作。
  2. 选择当前宿主支持的页面模板与组件。
  3. 定义导航、页面、数据源与权限,将字段绑定到真实响应。
  4. 使用当前序基 Schema 校验完整配置。

本手册首版以已有列表模板示例为起点。其他模板的具体字段需核对对应宿主及 Schema,不从设计草案自行推导。

校验与上传​

从保存插件文件的项目目录运行:

xuji plugin publish --file=ops/plugin.json --project=<项目ID> --platform=<掌序物理开发环境>

预检通过后再加 --apply 上传候选:

xuji plugin publish --file=ops/plugin.json --project=<项目ID> --platform=<掌序物理开发环境> --apply

用运营台的项目插件管理入口扫描候选二维码。具有 plugins.manage 权限的账号核对项目、版本、摘要与权限后批准登记。

预览与启用​

登记成功不会自动启用。预览页面并核对数据与权限,然后启用指定版本。启用时仍需检查当前连接允许的动作。

版本登记后不可变;内容修改应使用新版本。在宿主已有能力范围内,更新 JSON 不需要重建运营台;新增宿主组件仍需运营台正常发版。

配置限制​

候选大小不超过 128 KiB。不要放入秘密、远程 JavaScript、任意 HTML/CSS 或未支持的表达式。未知字段按 Schema 拒绝,不能依赖忽略字段来实现兼容。