Skip to content

BPMN XML 导入导出 ​

yh-flow 通过 BPMN 2.0 XML 接口与其他流程建模工具打通,能够将当前画布内容导出为标准的 BPMN 文档,也能将外部 BPMN 导入到 Flow,用于调试、迁移或演示。

何时使用 ​

  • 将 Flow 编辑器中的流程直接交付给 BPMN 引擎或团队的设计工具
  • 将团队在其他工具里产出的 BPMN 文件带回 Flow 以便可视化预览与验证
  • 在导出前先验证 XML 合法性,保证对接的稳定性

核心 API ​

函数说明
flowToBpmnXml(nodes, edges, options)将节点/连线转换为 BPMN 2.0 XML 字符串和流程 ID,includeDi 控制是否输出图形信息
bpmnXmlToFlow(xml, options)解析 BPMN XML 并恢复节点、连线,若缺少 DI 会自动施加简单布局
validateBpmnXml(xml)验证 XML 是否包含 definitions 与 process,防止导入抛出
generateSampleBpmnXml()返回内置示例流程,便于快速 Demo 或测试

示例 ​

下面示例展示如何导出 BPMN、导入默认 XML,并实时查看解析结果。

BPMN XML 导入导出示例

最佳实践 ​

  1. 保持流程定义同步:导出 BPMN 以前先调用 flowToBpmnXml 获取最新结构,再写入版本控制。
  2. 批量校验:在导入前用 validateBpmnXml 检查 XML,避免因格式异常导致解析失败。
  3. 分离图形信息:flowToBpmnXml 的 includeDi 参数允许你决定是否输出布局信息,便于自定义还原。
  4. 结合示例模板:generateSampleBpmnXml 可用于 smoke test 或教学演示,快速让团队理解 Flow ↔ BPMN 的链路。

Released under the MIT License.