[]
        
在线Demo 免费试用
(Showing Draft Content)

开发调试、发布部署与运维管理

5.1 开发环境准备

综合原始资料,建议开发环境如下:

  • Node.js:建议 10.0.0 或以上

  • npm:建议 6.x 或以上

  • IDE:推荐 VS Code

  • 全局工具:@grapecity/wyn-visual-tools

安装命令:

npm i @grapecity/wyn-visual-tools -g

说明:

  • 有文档提到 10.0.0+ 即可运行

  • 也有文档以 14.x+ 作为推荐环境

  • 面向客户项目交付时,建议优先采用较新的稳定 Node 环境

5.2 工程初始化

wyn-visual-tools init

执行后可得到标准插件工程骨架,后续开发通常围绕以下文件展开:

  • visual.json

  • capabilities.json

  • src/visual.ts

  • style/visual.less

  • i18nResources/*

5.3 本地开发与调试

启动本地开发服务:

wyn-visual-tools develop

补充说明:

  • 默认端口通常为 3000

  • 可以通过 -p 参数修改端口

  • 开发工具当前不支持在 https 站点中使用

5.4 启用开发者模式

本地调试前,系统管理员需要在后台启用开发者模式:

  • 路径:系统管理 > 系统设置 > 仪表板设置 > 通用

  • 设置项:启用开发者模式 = 是

然后在仪表板设计器中:

  1. 拖入开发工具组件

  2. 单击刷新按钮

  3. 加载当前本地开发中的插件

5.5 插件开发标准步骤

建议按以下流程开发:

  1. 初始化工程

  2. 配置 visual.json

  3. 配置 capabilities.json

  4. 实现 src/visual.ts

  5. 编写 style/visual.less

  6. 补充 i18nResourcesassets

  7. 在设计器中用开发工具调试

  8. 更新 package.json 中版本号

  9. 打包为 .viz

  10. 上传系统并验证

5.6 打包发布

发布命令:

wyn-visual-tools package

产物说明:

  • 打包后会在项目根目录生成 .viz 文件

  • .viz 是 Wyn 可识别的插件交付包

5.7 上传插件到系统

原始资料提供了两种上传方式:

5.7.1 文档门户上传

适合普通用户或有门户使用权限的用户:

  • 进入文档门户

  • 点击“创建文档”

  • 拖拽 .viz 文件到上传区域

5.7.2 管理后台上传

适合系统管理员:

  • 进入「系统管理 > 文档管理 > 可视化插件」

  • 点击“上传”

  • 拖拽 .viz 文件并确认

上传成功后,插件即可像内置组件一样在设计器中使用。

5.8 插件管理能力

上传后的插件一般支持以下管理动作:

  • 升级

  • 删除

  • 重命名

  • 下载

  • 设置运行参数

5.8.1 升级规则

系统会比较插件版本:

  • 若新上传版本低于或等于系统已有版本,则无法升级

  • 若新上传版本高于已有版本,则可执行升级

因此发布前务必更新 package.json 中的版本号。

5.8.2 删除权限

根据资料:

  • 删除插件通常仅允许系统管理员执行

  • 支持单个删除和批量删除

5.8.3 设置插件参数

常见配置之一是:

  • 插件运行于 DIViframe

这类参数往往来自 visual.json -> configuration

5.9 从应用市场获取插件

客户下载插件的典型路径包括:

  • 在设计器里点击“下载更多插件”

  • 在管理后台可视化插件页面点击“下载更多插件”

  • 直接进入应用市场搜索合适插件

下载完成后,通常得到一个 .viz 文件,再上传到系统中使用。

5.10 收费插件激活流程

综合资料,收费插件的激活步骤可整理为:

  1. 获取对应版本的授权文件(通常为 .cvl

  2. 系统管理员进入可视化插件授权页面

  3. 选择授权文件

  4. 确认状态为绿色可用

  5. 勾选需要的授权并导入

  6. 导入成功后即可正常使用收费插件

关键注意事项:

  • 授权按大版本管理

  • 试用版 Wyn 无法使用正式授权插件

  • 正式授权与试用插件是两套不同限制条件

5.11 面向客户交付时的建议清单

如果最终交付给客户的是“可直接使用的插件知识库”,建议至少覆盖以下内容:

  • 插件是什么,适用于哪些业务场景

  • 插件从哪里来:内置、市场、自研

  • 如何判断某个插件需要哪些数据字段

  • 如何理解属性面板中的配置项

  • 如何本地调试一个自定义插件

  • 如何打包、上传、升级和下载插件

  • 如何处理收费插件的授权与激活

5.12 常见问题整理

5.12.1 为什么开发工具里加载不到插件?

优先检查:

  • 是否已启用开发者模式

  • wyn-visual-tools develop 是否已启动

  • 端口是否正确

  • 当前站点是否为 https

  • visual.jsoncapabilities.json 是否存在格式错误

5.12.2 为什么上传后不能升级?

通常是因为:

  • 新插件版本号没有高于系统中现有版本

5.12.3 为什么绑定字段后图表没有数据?

通常检查:

  • dataRoles 定义是否正确

  • dataViewMappings 是否与绑定结构匹配

  • conditions 是否过于严格

  • update(options) 中是否正确读取 dataViews

5.12.4 为什么属性面板里没有显示我的属性?

通常检查:

  • 属性是否定义在 options.visual

  • hidden 是否为 true

  • getInspectorHiddenState 是否动态隐藏了该属性

  • structuredPath 是否写错

5.12.5 为什么动作栏按钮出现了,但没有效果?

通常因为:

  • 只在 capabilities.json 中声明了动作

  • 但没有在 visual.ts 中实现相关逻辑