全網(wǎng)最詳bpmn.js教材-基礎篇

前言

Q: bpmn.js是什么? ???

bpmn.js是一個BPMN2.0渲染工具包和web建模器, 使得畫流程圖的功能在前端來完成.

Q: 我為什么要寫該系列的教材? ???

因為公司業(yè)務的需要因而要在項目中使用到bpmn.js,但是由于bpmn.js的開發(fā)者是國外友人, 因此國內對這方面的教材很少, 也沒有詳細的文檔. 所以很多使用方式很多坑都得自己去找.在將其琢磨完之后, 決定寫一系列關于它的教材來幫助更多bpmn.js的使用者或者是期于找到一種好的繪制流程圖的開發(fā)者. 同時也是自己對其的一種鞏固.

由于是系列的文章, 所以更新的可能會比較頻繁, 您要是無意間刷到了且不是您所需要的還請諒解??.

不求贊??不求心??. 只希望能對你有一點小小的幫助.

所有教材的github地址: 《bpmn-chinese-document》

bpmn.js基本的使用

這一章節(jié)主要是介紹了bpmn.js最基本的幾種實用方式, 適合完全沒有接觸過bpmn.js的新手或者想要在vue項目中使用它的開發(fā)者.

通過這一章節(jié)的講解你可以學習到:

為了方便大家對后面的講解有一個大概認識, 我們先來看一下使用bpmn.js畫圖都有哪些內容:

image

bpmn.js最簡單的一種使用

我們可以直接使用CDN將bpmn.js引入到代碼中使用:

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>BPMNJS</title>
    <!--CDN加速-->
    <script src="https://unpkg.com/bpmn-js@6.0.2/dist/bpmn-viewer.development.js"></script>          <!--引入一個簡單的xml字符串-->
    <script src="./xmlStr.js"></script>
    <style>
        #canvas {
            height: 400px;
        }
    </style>
</head>

<body>
    <div id="canvas"></div>
    <script>
        var bpmnJS = new BpmnJS({
            container: '#canvas'
        });
        bpmnJS.importXML(xmlStr, function(err) {
            if (!err) {
                console.log('success!');
                // 讓圖能自適應屏幕
                var canvas = bpmnJS.get('canvas')
                canvas.zoom('fit-viewport')
            } else {
                console.log('something went wrong:', err);
            }
        });
    </script>
</body>

</html>

(上面的xmlStr.js以及案例代碼在這里LinDaiDai-bpmn-basic-demo)

如上面的案例所示, 我們使用DNS加速直接引入bpmn.js, 然后本地指定一個容器(也就是id為canvas的那個div), 接著用bpmn.js提供的方法importXML就可以解析xml字符串生成對應的工作流圖了.

打開頁面可以看到

img1

使用npm安裝bpmn.js

上面提供的使用方式是一種最基本的方式,僅僅是將圖展示出來,不能自己繪畫也不能操作. 所以在工作中使用更多的還是采用npm安裝到項目中使用. 我們可以使用以下命令進行安裝:

npm install --save bpmn-js

在應用程序中使用:

import BpmnViewer from 'bpmn-js';
import testDiagram from './test-diagram.bpmn';

var viewer = new BpmnViewer({
  container: '#canvas'
});

viewer.importXML(testDiagram, function(err) {
  if (!err) {
    console.log('success!');
    viewer.get('canvas').zoom('fit-viewport');
  } else {
    console.log('something went wrong:', err);
  }
});

上面的testDiagram指的是某個bpmn 文件了,而不是第一個案例中的xml字符串.

官方這邊也提供了一個例子, 可以看一下: bpmn-js-example-bunding

vue中使用bpmn.js

在vue 中的使用可以分為以下幾個部分:

為了方便講解, 我先創(chuàng)建一個空的vue項目(只安裝了路由):

vue create vue-bpmn-basic
cd vue-bpmn-basic
npm i vue-router --save-D

注???

你可以不用本地創(chuàng)建, 此項目地址

LinDaiDai/bpmn-vue-basic

vue中使用bpmn.js-基礎篇

我在項目的components文件夾下創(chuàng)建一個名為basic.vue的文件, 且配置好路由:

const routes = [
    {
        path: '/basic',
        component: () => import('./../components/basic')
    }
]

項目結構如圖所示:

img5
  1. 安裝相關依賴
npm i bpmn-js --save-D
  1. 編寫HTML代碼
// basic.vue
<template>
  <div class="containers">
    <div class="canvas" ref="canvas"></div>
  </div>
</template>
  1. 編寫JS代碼
// basic.vue
  <script>
    // 引入相關的依賴
    import BpmnModeler from 'bpmn-js/lib/Modeler'
    import {
      xmlStr
    } from '../mock/xmlStr' // 這里是直接引用了xml字符串
    export default {
      name: '',
      components: {},
      // 生命周期 - 創(chuàng)建完成（可以訪問當前this實例）
      created() { },
      // 生命周期 - 載入后, Vue 實例掛載到實際的 DOM 操作完成，一般在該過程進行 Ajax 交互
      mounted() {
        this.init()
      },
      data() {
        return {
          // bpmn建模器
          bpmnModeler: null,
          container: null,
          canvas: null
        }
      },
      methods: {
        init() {
          // 獲取到屬性ref為“canvas”的dom節(jié)點
          const canvas1 = this.$refs.canvas1
          // 建模
          this.bpmnModeler = new BpmnModeler({
            container: canvas
          })
          this.createNewDiagram()
        },
        createNewDiagram() {
          // 將字符串轉換成圖顯示出來
          this.bpmnModeler.importXML(xmlStr, (err) => {
            if (err) {
              // console.error(err)
            } else {
              // 這里是成功之后的回調, 可以在這里做一系列事情
              this.success()
            }
          })
        },
        success() {
          // console.log('創(chuàng)建成功!')
        }
      }
    }
  </script>
  1. 編寫CSS 
// basic.vue
<style scoped>
.containers{
    position: absolute;
    background-color: #ffffff;
    width: 100%;
    height: 100%;
}
.canvas{
    width: 100%;
    height: 100%;
}
.panel{
    position: absolute;
    right: 0;
    top: 0;
    width: 300px;
}
</style>

使用命令npm run start啟動項目, 打開可以看到:

img2

vue中使用bpmn.js-左側工具欄

左側工具欄作用: 給圖形添加新的節(jié)點

如圖所示:

img3

要想使用左側工具欄, 需要在項目中引用相應的樣式:

  1. 在main.js中引用css:
// main.js
import Vue from 'vue'
import App from './App.vue'
import router from './router'
Vue.config.productionTip = false
// 以下為bpmn工作流繪圖工具的樣式
import 'bpmn-js/dist/assets/diagram-js.css' // 左邊工具欄以及編輯節(jié)點的樣式
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'
new Vue({
    router,
    render: h => h(App),
}).$mount('#app')
  1. 頁面上引入propertiesProviderModule:
// provider.vue
<script>
...
import propertiesProviderModule from 'bpmn-js-properties-panel/lib/provider/camunda'
...
methods: {
    init () {
    // 獲取到屬性ref為“canvas”的dom節(jié)點
    const canvas = this.$refs.canvas
    // 建模
    this.bpmnModeler = new BpmnModeler({
      container: canvas,
      //添加控制板
      propertiesPanel: {
        parent: '#js-properties-panel'
      },
      additionalModules: [
        // 左邊工具欄以及節(jié)點
        propertiesProviderModule
      ]
    })
    this.createNewDiagram()
    },
    ...
}
</script>

provider.vue的其他代碼片段都和basic.vue 相同.

此時打開頁面就發(fā)現(xiàn)多了左側的工具欄, 且可以添加節(jié)點.

vue中使用bpmn.js-右側屬性欄

屬性欄的作用: 用戶在點擊圖上的節(jié)點的時候, 能獲取到該節(jié)點的屬性信息

如圖所示:

img4

想要使用右側的屬性欄就得安裝上一個名為bpmn-js-properties-panel的插件了.

  1. 安裝插件
npm i bpmn-js-properties-panel --save-D
  1. 在main.js中引入相應樣式:
// main.js
import Vue from 'vue'
...
import 'bpmn-js-properties-panel/dist/assets/bpmn-js-properties-panel.css' // 右邊工具欄樣式
...
  1. 在頁面中引入propertiesProviderModule:
// panel.vue
<script>
...
import propertiesProviderModule from 'bpmn-js-properties-panel/lib/provider/camunda'
...
methods: {
  init() {
    // 獲取到屬性ref為“canvas”的dom節(jié)點
    const canvas = this.$refs.canvas
    // 建模
    this.bpmnModeler = new BpmnModeler({
      container: canvas,
      //添加控制板
      propertiesPanel: {
        parent: '#js-properties-panel'
      },
      additionalModules: [
        // 左邊工具欄以及節(jié)點
        propertiesProviderModule,
        // 右邊的工具欄
        propertiesPanelModule
      ]
    })
    this.createNewDiagram()
  }
}

后語

上述案例項目Git地址 : https://github.com/LinDaiDai/bpmn-vue-basic 喜歡的小伙伴請給個Star??呀, 謝謝??

系列全部目錄請查看此處: 《全網(wǎng)最詳bpmn.js教材》

系列相關推薦:

《全網(wǎng)最詳bpmn.js教材-http請求篇》

《全網(wǎng)最詳bpmn.js教材-事件篇》

《全網(wǎng)最詳bpmn.js教材-renderer篇》

《全網(wǎng)最詳bpmn.js教材-contextPad篇》

《全網(wǎng)最詳bpmn.js教材-編輯、刪除節(jié)點篇》

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發(fā)布，文章內容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容