vue项目中使用bpmn.js详细流程（结合activiti版）

爱被打了一巴掌 2024-04-07 12:22 58阅读 0赞

最近项目需求需要用到Activiti以及Bpmn.js，我就去查阅资料学习了一下，然后整理记录一下项目步骤及操作。最后附上demo。

#### 一：创建vue项目 ####

// 创建一个Vue项目 选择vue2 default 然后一路next
     vue create bpmn-demo 
    // 安装一下项目依赖
    npm install

项目创建完成以后我们要安装一下bpmn.js的依赖然后进行整合。

#### 二：安装bpmn依赖库 ####

// npm安装 最新版9.4.0
    npm install bpmn-js@9.4.0

npm install @bpmn-io/properties-panel@0.19.0
    	 npm install activiti-bpmn-moddle@4.4.0
    	npm install bpmn-js-properties-panel@1.5.0
    	npm install camunda-bpmn-moddle@4.5.0

然后在main.js文件，引入bpmn.js的字体库及样式文件

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'

#### 三：完整实例 ####

<template>
      <div class="containers" ref="content">
        <div class="canvas" ref="canvas"></div>
        <div id="js-properties-panel" class="panel"></div>
        <ul class="buttons">
          <li>下载</li>
          <li>
            <a ref="saveDiagram" href="javascript:" title="download BPMN diagram">BPMN diagram</a>
          </li>
          <li>
            <a ref="saveSvg" href="javascript:" title="download as SVG image">SVG image</a>
          </li>
        </ul>
      </div>
    </template>
     
    <script>
    // 引入相关的依赖
    // import BpmnViewer from 'bpmn-js'
    import BpmnModeler from 'bpmn-js/lib/Modeler'
    import propertiesPanelModule from 'bpmn-js-properties-panel/lib/PropertiesPanel'
    import propertiesProviderModule from 'bpmn-js-properties-panel/lib/provider/activiti'
    import activitiModdleDescriptor from 'activiti-bpmn-moddle/resources/activiti'
    
    // import BpmnModeler from "bpmn-js/lib/Modeler";
    // import propertiesPanelModule from "bpmn-js-properties-panel/lib/PropertiesPanel";
    // import propertiesProviderModule from "bpmn-js-properties-panel/lib/provider/camunda";
    // import camundaModdleDescriptor from "camunda-bpmn-moddle/resources/camunda";
     
    export default {
      data () {
        return {
          // bpmn建模器
          bpmnModeler: null,
          container: null,
          canvas: null,
          xmlStr: null,
          processName: ''
        }
      },
      methods: {
        createNewDiagram () {
          const bpmnXmlStr = `<?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: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="6.0.4">
              <process id="Process_1" isExecutable="true">
                <startEvent id="StartEvent_1acpsqt" />
              </process>
              <bpmndi:BPMNDiagram id="BpmnDiagram_1">
                <bpmndi:BPMNPlane id="BpmnPlane_1" bpmnElement="Process_1">
                  <bpmndi:BPMNShape id="StartEvent_1acpsqt_di" bpmnElement="StartEvent_1acpsqt">
                    <omgdc:Bounds x="152" y="82" width="36" height="36" />
                  </bpmndi:BPMNShape>
                </bpmndi:BPMNPlane>
              </bpmndi:BPMNDiagram>
            </definitions>`
          // 将字符串转换成图显示出来
          this.bpmnModeler.importXML(bpmnXmlStr, function (err) {
            if (err) {
              console.error(err)
            }
          })
        },
        // 下载为SVG格式,done是个函数，调用的时候传入的
        saveSVG (done) {
          // 把传入的done再传给bpmn原型的saveSVG函数调用
          this.bpmnModeler.saveSVG(done)
        },
        // 下载为SVG格式,done是个函数，调用的时候传入的
        saveDiagram (done) {
          // 把传入的done再传给bpmn原型的saveXML函数调用
          this.bpmnModeler.saveXML({ format: true }, function (err, xml) {
            done(err, xml)
          })
        },
        // 当图发生改变的时候会调用这个函数，这个data就是图的xml
        setEncoded (link, name, data) {
          // 把xml转换为URI，下载要用到的
          const encodedData = encodeURIComponent(data)
          // 获取到图的xml，保存就是把这个xml提交给后台
          this.xmlStr = data
          // 下载图的具体操作,改变a的属性，className令a标签可点击，href令能下载，download是下载的文件的名字
          if (data) {
            link.className = 'active'
            link.href = 'data:application/bpmn20-xml;charset=UTF-8,' + encodedData
            link.download = name
          }
        }
      },
      mounted () {
        // 获取到属性ref为“content”的dom节点
        this.container = this.$refs.content
        // 获取到属性ref为“canvas”的dom节点
        const canvas = this.$refs.canvas
     
        // 建模，官方文档这里讲的很详细
        this.bpmnModeler = new BpmnModeler({
          container: canvas,
          // 添加控制板
          propertiesPanel: {
            parent: '#js-properties-panel'
          },
          additionalModules: [
            // 左边工具栏以及节点
            propertiesProviderModule,
            // 右边的工具栏
            propertiesPanelModule
          ],
          moddleExtensions: {
            activiti: activitiModdleDescriptor
          }
        })
     
        // 下载画图
        let _this = this
        // 获取a标签dom节点
        const downloadLink = this.$refs.saveDiagram
        const downloadSvgLink = this.$refs.saveSvg
        // 给图绑定事件，当图有发生改变就会触发这个事件
        this.bpmnModeler.on('commandStack.changed', function () {
          _this.saveSVG(function (err, svg) {
            _this.setEncoded(downloadSvgLink, 'diagram.svg', err ? null : svg)
          })
     
          _this.saveDiagram(function (err, xml) {
            _this.setEncoded(downloadLink, 'diagram.bpmn', err ? null : xml)
          })
        })
     
        this.createNewDiagram(this.bpmnModeler)
      }
    }
    </script>
     
    <style lang="scss">
      /*左边工具栏以及编辑节点的样式*/
      @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/properties-panel.css';
      .containers{
        position: absolute;
        background-color: #ffffff;
        width: 100%;
        height: 90%;
      }
      .canvas{
        width: 100%;
        height: 100%;
      }
      .panel{
        position: absolute;
        right: 0;
        top: 0;
        width: 300px;
      }
      .buttons{
        position: absolute;
        left: 20px;
        bottom: 20px;
        &>li{
          display:inline-block;margin: 5px;
          &>a{
            color: #999;
            background: #eee;
            cursor: not-allowed;
            padding: 8px;
            border: 1px solid #ccc;
            &.active{
              color: #333;
              background: #fff;
              cursor: pointer;
            }
          }
        }
      }
    </style>

#### 四：最终效果 ####

![在这里插入图片描述][309f08f3bf974f49830c664afaef30ae.png]

#### 五：完整demo（gitee地址） ####

gitee地址：[https://gitee.com/spring2020/bpmn-js-demo][https_gitee.com_spring2020_bpmn-js-demo]

[309f08f3bf974f49830c664afaef30ae.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d41dd9bdf00d4e4b9f0ed737d28ce20c.png
[https_gitee.com_spring2020_bpmn-js-demo]: https://gitee.com/spring2020/bpmn-js-demo