跳到主要内容

自定义节点类型

自定义节点类型用于扩展规则引擎可编排节点。用户创建节点、维护处理逻辑和参数定义,编译成功后即可在规则流程中拖入使用。

先看术语​

术语现场理解
自定义节点类型现场或项目自定义的规则功能块,编译成功后可拖入规则流程。
节点实例某个规则流程画布中实际拖入使用的节点。它引用一个节点类型。
输入参数上游节点传给当前节点的数据。
输出参数当前节点处理后传给下游节点的数据。
输入输出参数既能接收上游数据,也能在节点内部修改后继续传递的数据。
编译检查节点代码和参数定义能否被网关加载。编译成功后,规则流程才能使用最新节点。
分类在规则节点面板中分组显示节点,便于现场快速查找。

页面入口​

登录 TGateway Web 后,点击左侧菜单“开发配置 → 自定义节点”。

自定义节点管理页面

使用前准备​

  • 明确节点的输入、输出、异常处理和允许的副作用,先用最小参数集合设计。
  • 确认节点名称和分类不会与已加载节点混淆,并记录哪些规则流程将引用它。
  • 修改已在生产流程中使用的节点前,先导出相关规则流程并安排验证窗口。

页面结构​

区域说明
本地节点管理已保存的自定义节点类型,支持新增、编辑、编译、删除和批量操作。
已加载节点查看已经可在规则流程中使用的节点类型,适合确认编译结果是否生效。
名称搜索按节点名称过滤。
分类筛选按节点分类过滤。
工具按钮依次为新增、批量编译、批量删除、刷新;批量操作需要先勾选节点。

列表字段​

字段说明
节点名称节点类型名称,规则流程中按此名称查找和使用。
分类节点分类,便于在规则编排时组织节点。
输入参数当前节点定义的输入参数数量。
输出参数当前节点定义的输出参数数量。
输入输出参数既可输入又可输出的参数数量。
更新时间最近一次保存或编译时间。
操作编辑、编译、删除当前节点。

新建节点​

点击列表右上角新增按钮,打开“新建自定义节点”弹窗。

新建节点对话框

配置项说明
节点名称必填。建议使用英文、数字和下划线,保持规则流程引用稳定。
分类可选。用于按业务或处理类型组织节点。
描述可选。记录节点用途、输入输出约定和维护注意事项。

点击“确定”后,系统会创建节点并自动进入节点编辑器。

节点编辑器​

节点编辑器包含顶部操作栏、代码编辑区和底部信息面板。

节点编辑器页面

区域说明
返回按钮返回自定义节点列表。
节点名称标签显示当前节点名称和分类。
编译并保存顶部右侧主按钮。先保存节点信息和处理逻辑,再执行编译。
代码编辑维护节点处理逻辑。
底部面板包含“编译日志”“节点信息”“参数定义”页签。

节点信息​

“节点信息”页签用于维护基础信息。

字段说明
节点名称节点显示和引用名称。修改后需要编译保存。
分类节点分类。
描述节点用途和维护说明。

参数定义​

“参数定义”页签按输入、输出、输入输出三类维护参数。参数定义会影响规则流程中节点的连线和数据传递。

参数类型说明
输入参数从上游节点传入,节点内部读取使用。
输出参数节点处理后输出,供下游节点使用。
输入输出参数同时作为输入和输出,适合需要在节点内部修改后继续传递的值。
参数字段说明
参数名参数标识,建议使用清晰的英文或拼音命名。
数据类型参数值类型。数字选择整数或小数类型,开关量选择布尔类型,文本选择字符串,需要传递结构化内容时选择对象类型。
描述参数用途说明。

编译日志​

点击顶部“编译并保存”后,底部“编译日志”会显示保存和编译过程。

节点编辑器编译日志

日志项说明
正在保存节点编译前先保存当前节点信息、代码和参数定义。
节点保存成功保存成功后开始编译。
编译成功自定义节点代码通过编译。
输出显示编译输出信息,便于排查加载问题。
错误 / 警告统计底部面板右侧显示当前错误和警告数量。

出现编译错误时,先处理第一条红色错误;点击错误项可定位到对应代码位置。

常用操作​

操作步骤
编辑节点在列表点击“编辑”,进入编辑器维护代码、节点信息或参数定义。
单个编译在列表点击“编译”,验证当前节点是否可编译。
批量编译勾选多个节点后点击批量编译,适合升级后统一验证。
删除节点点击“删除”并确认。删除前应确认规则流程不再引用该节点。
查看已加载节点切换到“已加载节点”,确认运行时已经注册的节点。

常见问题与注意​

场景建议
参数修改修改参数后,应同步检查引用该节点的规则流程连线。
分类维护分类会影响节点查找效率,建议按业务域或功能类型分类。
编译失败先查看保存日志,再查看编译诊断;保存失败时不会进入真正编译。
节点未出现在规则中确认节点已编译成功,并刷新规则引擎页面或重新打开流程编辑器。
生产删除删除前先导出或备份规则流程,避免留下不可解析的节点引用。

编译与运行验证​

  1. 点击“编译并保存”,确认保存日志和编译日志均无错误。
  2. 切换到“已加载节点”,确认节点名称、分类和参数已经出现。
  3. 在规则引擎中新建最小测试流程,连接输入、当前节点和输出节点。
  4. 保存并启用流程,触发一组已知输入,观察节点实时参数和运行日志。
  5. 输出值、参数类型和异常处理均符合设计后,再把节点用于正式流程。

只通过编译不代表节点行为正确;未完成规则流程中的实际触发验证时,节点仍不应视为交付完成。

相关链接​