bpmn-js调研

1.bpmn-js

github
官网

在线demo(中文)
在线demo

介绍

BPMN.js是一个开源工具包，用于使用JavaScript建模和执行BPMN流程。
它提供一组库，用于在基于浏览器和服务器端环境中创建，编辑和可视化BPMN图表。
BPMN.js具有内置支持广泛的BPMN元素，包括任务，网关，事件和流程，并允许用户定义自己的自定义元素。
工具包还包括用于验证和执行BPMN模型的工具，以及导出和导入BPMN文件的功能。
由于其易于使用的API和灵活的架构，BPMN.js是将BPMN支持整合到独立和企业应用程序中的流行选择。

安装

直接按照会导致依赖版本冲突，建议使用一下版本

“bpmn-js”: “^7.3.1”,
“bpmn-js-properties-panel”: “^0.37.2”,
“bpmn-moddle”: “^6.0.0”,
“camunda-bpmn-moddle”: “^4.5.0”,
“diagram-js-minimap”:2.0.4

vue基本使用

<template>
  <div>
    <div id="canvas"></div>
  </div>
</template>

import BpmnModeler from 'bpmn-js/lib/Modeler'


export default {
  data() {
    return {
    }
  },
  mounted() {
    this.initModeler()
  },
  methods: {
    initModeler() {
      this.bpmnModeler = new BpmnModeler({
        container: '#canvas' ,//或者document.getElementById('canvas')
        width:1500,//string|number
        height:600,
      })
      var canvas = this.bpmnModeler.get('canvas')
      // 设置画布背景色
      canvas._container.style.backgroundColor = '#f2f2f2'
    }
  }
}

效果

图中没有工具栏 需要引入css

import 'bpmn-js/dist/assets/diagram-js.css' // 左边工具栏以及编辑节点的样式
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn.css'
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn-codes.css'
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn-embedded.css'

效果

汉化

两种方法使用汉化包或使用
1.首先创建汉化包 zh.js

export default {
  // Labels
  'Activate the global connect tool' : '激活全局连接工具',
  'Append {type}': '追加 {type}',
  'Append EndEvent': '追加 结束事件 ',
  'Append Task':'追加 任务',
  'Append Gateway':'追加 网关',
  'Append Intermediate/Boundary Event':'追加 中间/边界 事件',
  'Add Lane above': '在上面添加道',
  'Divide into two Lanes': '分割成两个道',
  'Divide into three Lanes': '分割成三个道',
  'Add Lane below': '在下面添加道',
  'Append compensation activity': '追加补偿活动',
  'Change type': '修改类型',
  'Connect using Association': '使用关联连接',
  'Connect using Sequence/MessageFlow or Association': '使用顺序/消息流或者关联连接',
  'Connect using DataInputAssociation': '使用数据输入关联连接',
  'Remove': '移除',
  'Activate the hand tool': '激活抓手工具',
  'Activate the lasso tool': '激活套索工具',
  'Activate the create/remove space tool': '激活创建/删除空间工具',
  'Create expanded SubProcess': '创建扩展子过程',
  'Create IntermediateThrowEvent/BoundaryEvent' : '创建中间抛出事件/边界事件',
  'Create Pool/Participant': '创建池/参与者',
  'Parallel Multi Instance': '并行多重事件',
  'Sequential Multi Instance': '时序多重事件',
  'DataObjectReference':'数据对象参考',
  'DataStoreReference':'数据存储参考',
  'Loop': '循环',
  'Ad-hoc': '即席',
  'Create {type}': '创建 {type}',
  'Create Task':'创建任务',
  'Create StartEvent':'创建开始事件',
  'Create EndEvent':'创建结束事件',
  'Create Group':'创建组',
  'Task': '任务',
  'Send Task': '发送任务',
  'Receive Task': '接收任务',
  'User Task': '用户任务',
  'Manual Task': '手工任务',
  'Business Rule Task': '业务规则任务',
  'Service Task': '服务任务',
  'Script Task': '脚本任务',
  'Call Activity': '调用活动',
  'Sub Process (collapsed)': '子流程（折叠的）',
  'Sub Process (expanded)': '子流程（展开的）',
  'Start Event': '开始事件',
  'StartEvent': '开始事件',
  'Intermediate Throw Event': '中间事件',
  'End Event': '结束事件',
  'EndEvent': '结束事件',
  'Create Gateway': '创建网关',
  'GateWay':'网关',
  'Create Intermediate/Boundary Event': '创建中间/边界事件',
  'Message Start Event': '消息开始事件',
  'Timer Start Event': '定时开始事件',
  'Conditional Start Event': '条件开始事件',
  'Signal Start Event': '信号开始事件',
  'Error Start Event': '错误开始事件',
  'Escalation Start Event': '升级开始事件',
  'Compensation Start Event': '补偿开始事件',
  'Message Start Event (non-interrupting)': '消息开始事件（非中断）',
  'Timer Start Event (non-interrupting)': '定时开始事件（非中断）',
  'Conditional Start Event (non-interrupting)': '条件开始事件（非中断）',
  'Signal Start Event (non-interrupting)': '信号开始事件（非中断）',
  'Escalation Start Event (non-interrupting)': '升级开始事件（非中断）',
  'Message Intermediate Catch Event': '消息中间捕获事件',
  'Message Intermediate Throw Event': '消息中间抛出事件',
  'Timer Intermediate Catch Event': '定时中间捕获事件',
  'Escalation Intermediate Throw Event': '升级中间抛出事件',
  'Conditional Intermediate Catch Event': '条件中间捕获事件',
  'Link Intermediate Catch Event': '链接中间捕获事件',
  'Link Intermediate Throw Event': '链接中间抛出事件',
  'Compensation Intermediate Throw Event': '补偿中间抛出事件',
  'Signal Intermediate Catch Event': '信号中间捕获事件',
  'Signal Intermediate Throw Event': '信号中间抛出事件',
  'Message End Event': '消息结束事件',
  'Escalation End Event': '定时结束事件',
  'Error End Event': '错误结束事件',
  'Cancel End Event': '取消结束事件',
  'Compensation End Event': '补偿结束事件',
  'Signal End Event': '信号结束事件',
  'Terminate End Event': '终止结束事件',
  'Message Boundary Event': '消息边界事件',
  'Message Boundary Event (non-interrupting)': '消息边界事件（非中断）',
  'Timer Boundary Event': '定时边界事件',
  'Timer Boundary Event (non-interrupting)': '定时边界事件（非中断）',
  'Escalation Boundary Event': '升级边界事件',
  'Escalation Boundary Event (non-interrupting)': '升级边界事件（非中断）',
  'Conditional Boundary Event': '条件边界事件',
  'Conditional Boundary Event (non-interrupting)': '条件边界事件（非中断）',
  'Error Boundary Event': '错误边界事件',
  'Cancel Boundary Event': '取消边界事件',
  'Signal Boundary Event': '信号边界事件',
  'Signal Boundary Event (non-interrupting)': '信号边界事件（非中断）',
  'Compensation Boundary Event': '补偿边界事件',
  'Exclusive Gateway': '互斥网关',
  'Parallel Gateway': '并行网关',
  'Inclusive Gateway': '相容网关',
  'Complex Gateway': '复杂网关',
  'Event based Gateway': '事件网关',
  'Transaction': '转运',
  'Sub Process': '子流程',
  'Event Sub Process': '事件子流程',
  'Collapsed Pool': '折叠池',
  'Expanded Pool': '展开池',
  // Errors
  'no parent for {element} in {parent}': '在{parent}里，{element}没有父类',
  'no shape type specified': '没有指定的形状类型',
  'flow elements must be children of pools/participants': '流元素必须是池/参与者的子类',
  'out of bounds release': 'out of bounds release',
  'more than {count} child lanes': '子道大于{count} ',
  'element required': '元素不能为空',
  'diagram not part of bpmn:Definitions': '流程图不符合bpmn规范',
  'no diagram to display': '没有可展示的流程图',
  'no process or collaboration to display': '没有可展示的流程/协作',
  'element {element} referenced by {referenced}#{property} not yet drawn': '由{referenced}#{property}引用的{element}元素仍未绘制',
  'already rendered {element}': '{element} 已被渲染',
  'failed to import {element}': '导入{element}失败',
  //属性面板的参数
  'Id':'编号',
  'Name':'名称',
  'General':'常规',
  'Details':'详情',
  'Message Name':'消息名称',
  'Message':'消息',
  'Initiator':'创建者',
  'Asynchronous Continuations':'持续异步',
  'Asynchronous Before':'异步前',
  'Asynchronous After':'异步后',
  'Job Configuration':'工作配置',
  'Exclusive':'排除',
  'Job Priority':'工作优先级',
  'Retry Time Cycle':'重试时间周期',
  'Documentation':'文档',
  'Element Documentation':'元素文档',
  'History Configuration':'历史配置',
  'History Time To Live':'历史的生存时间',
  'Forms':'表单',
  'Form Key':'表单key',
  'Form Fields':'表单字段',
  'Business Key':'业务key',
  'Form Field':'表单字段',
  'ID':'编号',
  'Type':'类型',
  'Label':'名称',
  'Default Value':'默认值',
  'Validation':'校验',
  'Add Constraint':'添加约束',
  'Config':'配置',
  'Properties':'属性',
  'Add Property':'添加属性',
  'Value':'值',
  'Add':'添加',
  'Values':'值',
  'Add Value':'添加值',
  'Listeners':'监听器',
  'Execution Listener':'执行监听',
  'Event Type':'事件类型',
  'Listener Type':'监听器类型',
  'Java Class':'Java类',
  'Expression':'表达式',
  'Must provide a value':'必须提供一个值',
  'Delegate Expression':'代理表达式',
  'Script':'脚本',
  'Script Format':'脚本格式',
  'Script Type':'脚本类型',
  'Inline Script':'内联脚本',
  'External Script':'外部脚本',
  'Resource':'资源',
  'Field Injection':'字段注入',
  'Extensions':'扩展',
  'Input/Output':'输入/输出',
  'Input Parameters':'输入参数',
  'Output Parameters':'输出参数',
  'Parameters':'参数',
  'Output Parameter':'输出参数',
  'Timer Definition Type':'定时器定义类型',
  'Timer Definition':'定时器定义',
  'Date':'日期',
  'Duration':'持续',
  'Cycle':'循环',
  'Signal':'信号',
  'Signal Name':'信号名称',
  'Escalation':'升级',
  'Error':'错误',
  'Link Name':'链接名称',
  'Condition':'条件名称',
  'Variable Name':'变量名称',
  'Variable Event':'变量事件',
  'Specify more than one variable change event as a comma separated list.':'多个变量事件以逗号隔开',
  'Wait for Completion':'等待完成',
  'Activity Ref':'活动参考',
  'Version Tag':'版本标签',
  'Executable':'可执行文件',
  'External Task Configuration':'扩展任务配置',
  'Task Priority':'任务优先级',
  'External':'外部',
  'Connector':'连接器',
  'Must configure Connector':'必须配置连接器',
  'Connector Id':'连接器编号',
  'Implementation':'实现方式',
  'Field Injections':'字段注入',
  'Fields':'字段',
  'Result Variable':'结果变量',
  'Topic':'主题',
  'Configure Connector':'配置连接器',
  'Input Parameter':'输入参数',
  'Assignee':'代理人',
  'Candidate Users':'候选用户',
  'Candidate Groups':'候选组',
  'Due Date':'到期时间',
  'Follow Up Date':'跟踪日期',
  'Priority':'优先级',
  'The follow up date as an EL expression (e.g. ${someDate} or an ISO date (e.g. 2015-06-26T09:54:00)':'跟踪日期必须符合EL表达式，如： ${someDate} ,或者一个ISO标准日期，如：2015-06-26T09:54:00',
  'The due date as an EL expression (e.g. ${someDate} or an ISO date (e.g. 2015-06-26T09:54:00)':'跟踪日期必须符合EL表达式，如： ${someDate} ,或者一个ISO标准日期，如：2015-06-26T09:54:00',
  'Variables':'变量',
  'Candidate Starter Configuration':'候选开始配置',
  'Task Listener':'任务监听器',
  'Candidate Starter Groups':'候选开始组',
  'Candidate Starter Users':'候选开始用户',
  'Tasklist Configuration':'任务列表配置',
  'Startable':'启动',
  'Specify more than one group as a comma separated list.':'指定多个组,用逗号分隔',
  'Specify more than one user as a comma separated list.':'指定多个用户,用逗号分隔',
  'This maps to the process definition key.':'这会映射为流程定义的键',
  'CallActivity Type':'调用活动类型',
  'Condition Type':'条件类型',
  'Create UserTask':'创建用户任务',
  'Create CallActivity':'创建调用活动',
  'Called Element':'调用元素',
  'Create DataObjectReference':'创建数据对象引用',
  'Create DataStoreReference':'创建数据存储引用',
  'Multi Instance':'多实例',
  'Loop Cardinality':'实例数量',
  'Collection':'任务参与人列表',
  'Element Variable':'元素变量',
  'Completion Condition': '完成条件',
  'Open minimap': '打开小地图',
  'Close minimap':'关闭小地图'
};

2.创建汉化翻译 translate.js

import translations from "./zh";

export default function customTranslate(template, replacements) {
  replacements = replacements || {};

  // Translate
  template = translations[template] || template;

  // Replace
  return template.replace(/{([^}]+)}/g, function(_, key) {
    let str = replacements[key];
    if (
      translations[replacements[key]] !== null &&
      translations[replacements[key]] !== "undefined"
    ) {
      // eslint-disable-next-line no-mixed-spaces-and-tabs
      str = translations[replacements[key]];
      // eslint-disable-next-line no-mixed-spaces-and-tabs
    }
    return str || "{" + key + "}";
  });
}

3.使用

import translate from './hooks/translate.js'
initModeler() {
      this.bpmnModeler = new BpmnModeler({
		...
		//汉化
        additionalModules: [{ translate: ['value', translate] }]
      })
    }

安装properties-panel(属性栏）和camunda

import propertiesPanelModule from 'bpmn-js-properties-panel'
import propertiesProviderModule from 'bpmn-js-properties-panel/lib/provider/camunda'
import camundaModdleDescriptor from 'camunda-bpmn-moddle/resources/camunda'

导入配置
 additionalModules: [
          propertiesProviderModule,
          propertiesPanelModule,
          {
            translate: ['value', translate]
            // 禁用滚轮滚动
            // zoomScroll: ["value", ""],
            // // 禁止拖动线
            // bendpoints: ["value", ""],
            // // 禁用左侧面板
            // paletteProvider: ["value", ""],
            // // 禁止点击节点出现contextPad
            // contextPadProvider: ["value", ""],
            // // 禁止双击节点出现label编辑框
            // labelEditingProvider: ["value", ""]
          }
        ],
        moddleExtensions: {
          camunda: camundaModdleDescriptor
        }

完整代码

<!--
 * @Author: qiangding2 qiangding2@iflytek.com
 * @Date: 2023-03-16 09:49:23
 * @LastEditors: qiangding2 qiangding2@iflytek.com
 * @LastEditTime: 2023-03-21 09:36:56
 * @FilePath: \vue2_demo-qiankun\src\views\bpmn\index.vue
 * @Description: 这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE
-->
<template>
  <div class="containerBox" style="position: relative;">
            <div id="canvas"  style="width: 90%; height: 70vh">
            </div>
            <div id="js-properties-panel" class="panel"></div>
        </div>
</template>
<script>
import translate from './hooks/translate.js'
import BpmnModeler from 'bpmn-js/lib/Modeler'
import 'bpmn-js/dist/assets/diagram-js.css' // 左边工具栏以及编辑节点的样式
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn.css'
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn-codes.css'
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn-embedded.css'
import "bpmn-js-properties-panel/dist/assets/bpmn-js-properties-panel.css";
import propertiesPanelModule from 'bpmn-js-properties-panel'
import propertiesProviderModule from 'bpmn-js-properties-panel/lib/provider/camunda'
import camundaModdleDescriptor from 'camunda-bpmn-moddle/resources/camunda'

const xmlStr = `<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:omgdi="http://www.omg.org/spec/DD/20100524/DI" xmlns:omgdc="http://www.omg.org/spec/DD/20100524/DC" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="sid-38422fae-e03e-43a3-bef4-bd33b32041b2" targetNamespace="http://bpmn.io/bpmn" exporter="bpmn-js (https://demo.bpmn.io)" exporterVersion="5.1.2">
<process id="Process_1" isExecutable="false">
    <startEvent id="StartEvent_1y45yut" name="开始">
    <outgoing>SequenceFlow_0h21x7r</outgoing>
    </startEvent>
    <task id="Task_1hcentk">
    <incoming>SequenceFlow_0h21x7r</incoming>
    </task>
    <sequenceFlow id="SequenceFlow_0h21x7r" sourceRef="StartEvent_1y45yut" targetRef="Task_1hcentk" />
</process>
<bpmndi:BPMNDiagram id="BpmnDiagram_1">
    <bpmndi:BPMNPlane id="BpmnPlane_1" bpmnElement="Process_1">
    <bpmndi:BPMNShape id="StartEvent_1y45yut_di" bpmnElement="StartEvent_1y45yut">
        <omgdc:Bounds x="152" y="102" width="36" height="36" />
        <bpmndi:BPMNLabel>
        <omgdc:Bounds x="160" y="145" width="22" height="14" />
        </bpmndi:BPMNLabel>
    </bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="Task_1hcentk_di" bpmnElement="Task_1hcentk">
        <omgdc:Bounds x="240" y="80" width="100" height="80" />
    </bpmndi:BPMNShape>
    <bpmndi:BPMNEdge id="SequenceFlow_0h21x7r_di" bpmnElement="SequenceFlow_0h21x7r">
        <omgdi:waypoint x="188" y="120" />
        <omgdi:waypoint x="240" y="120" />
    </bpmndi:BPMNEdge>
    </bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
</definitions>`

export default {
  data() {
    return {
      bpmnModeler: null,
      containerEl: null
    }
  },
  mounted() {
    this.initModeler()
  },
  methods: {
    initModeler() {
      this.containerEl = document.getElementById('canvas')
      this.bpmnModeler = new BpmnModeler({
        container: this.containerEl,
        propertiesPanel: {
          parent: '#js-properties-panel'
        },
        additionalModules: [
          propertiesProviderModule,
          propertiesPanelModule,
          {
            translate: ['value', translate]
            // 禁用滚轮滚动
            // zoomScroll: ["value", ""],
            // // 禁止拖动线
            // bendpoints: ["value", ""],
            // // 禁用左侧面板
            // paletteProvider: ["value", ""],
            // // 禁止点击节点出现contextPad
            // contextPadProvider: ["value", ""],
            // // 禁止双击节点出现label编辑框
            // labelEditingProvider: ["value", ""]
          }
        ],
        moddleExtensions: {
          camunda: camundaModdleDescriptor
        }
      })
      var canvas = this.bpmnModeler.get('canvas')
      // 设置画布背景色
      canvas._container.style.backgroundColor = '#f2f2f2'

      this.createNewDiagram()
    },
    createNewDiagram() {
      // 将字符串转换成图显示出来
      this.bpmnModeler.importXML(xmlStr, err => {
        if (err) {
          // console.error(err)
        } else {
          // 这里是成功之后的回调, 可以在这里做一系列事情
          this.success()
        }
      })
    },
    success() {
      console.log('创建成功!')
    }
  }
}
</script>

<style>
 .containerBox {
        height: 100%;
    }
    .containerBox #container {
        height: 100%;
        border: 1px solid rgb(121, 121, 121);
    }
    .bpp-properties-panel [type=text] {
        box-sizing: border-box;
    }
    .panel {
        width: 400px;
        position: absolute;
        top: 1px;
        right: 1px;
        height:100%;
        overflow: auto;
    }
    /* 右下角logo */
    .bjs-powered-by {
        display: none;
    }
</style>

添加小地图

1.在汉化文件中添加汉化

  'Open minimap': '打开小地图',
  'Close minimap':'关闭小地图'

2.安装diagram-js-minimap 版本2.0.4
3.使用

import minimapModule from 'diagram-js-minimap' //导入小地图
import './hooks/minimap.css'//自定义小地图样式

minimap.css

.djs-minimap {
  position: absolute;
  top: 20px;
  /*自定义样式*/
  right: 420px;
  overflow: hidden;
  background-color: rgba(255, 255, 255, 0.9);
  border: solid 1px #CCC;
  border-radius: 2px;
  box-sizing: border-box;
  user-select: none;
  -moz-user-select: none;
  -ms-user-select: none;
  -webkit-user-select: none;
}

.djs-minimap:not(.open) {
  overflow: hidden;
}

.djs-minimap .map {
  display: none;
}

.djs-minimap.open .map {
  display: block;
}

.djs-minimap .map {
  width: 320px;
  height: 180px;
}

.djs-minimap:not(.open) .toggle {
  padding: 10px;
  text-align: center;
}

.djs-minimap .toggle:before {
  content: attr(title);
}

.djs-minimap.open .toggle {
  position: absolute;
  right: 0;
  padding: 6px;
  z-index: 1;
}

.djs-minimap .map {
  cursor: crosshair;
}

.djs-minimap .viewport {
  /* fill: rgba(255, 116, 0, 0.25); */
  fill: none;
  stroke: none;
}

.djs-minimap .viewport-dom {
  position: absolute;
  border: solid 2px orange;
  border-radius: 2px;
  box-sizing: border-box;
  cursor: move;
}

.djs-minimap:not(.open) .viewport-dom {
  display: none;
}

.djs-minimap.open .overlay {
  position: absolute;
  top: 0;
  right: 0;
  bottom: 0;
  left: 0;
  background: rgba(255, 255, 255, 0.2);
  pointer-events: none;
}

.djs-minimap .cursor-crosshair {
  cursor: crosshair;
}

.djs-minimap .cursor-move {
  cursor: move;
}

4.使用model

 additionalModules: [
 			...
             minimapModule,
        ],

效果

下载与保存

        <el-button type="primary" @click="saveSVG">保存SVG</el-button>
        <el-button type="primary" @click="saveDiagram">保存XML</el-button>
        <el-button type="primary" @click="exportBPMN">下载XML</el-button>
        <el-button type="primary" @click="exportSVG">下载SVG</el-button>

  //保存XML
    saveDiagram() {
      // 把传入的done再传给bpmn原型的saveXML函数调用
      this.bpmnModeler.saveXML().then(res => {
        //调用接口 进行保存
        console.log(res)
      })
    },
    //保存SVG
    saveSVG() {
      this.bpmnModeler.saveSVG().then(res => {
        //调用接口 进行保存
        console.log(res)
      })
    },
    // 下载 SVG 格式
    exportBPMN() {
      this.bpmnModeler.saveXML().then(res => {
        //调用接口 进行保存
        this.download('xml', res.xml)
      })
    },
    exportSVG() {
        this.bpmnModeler.saveSVG().then(res => {
        //调用接口 进行保存
        this.download('svg', res.svg)
      })
    },
    // 下载xml/svg
    download(type, data, name) {
      let dataTrack = ''
      const a = document.createElement('a')

      switch (type) {
        case 'xml':
          dataTrack = 'bpmn'
          break
        case 'svg':
          dataTrack = 'svg'
          break
        default:
          break
      }
      name = name || `diagram.${dataTrack}`
      a.setAttribute(
        'href',
        `data:application/bpmn20-xml;charset=UTF-8,${encodeURIComponent(data)}`
      )
      a.setAttribute('target', '_blank')
      a.setAttribute('dataTrack', `diagram:download-${dataTrack}`)
      a.setAttribute('download', name)
      document.body.appendChild(a)
      a.click()
      document.body.removeChild(a)
    }

参考：《全网最详bpmn.js教材》