BPMN 结合 Activiti
安装依赖，bpmn-js 的版本需要与bpmn-js-properties-panel-for-activiti 中使用的一致，相关的读取文件，等就不写了，业务比较简单，网上很多。
pnpm i bpmn-js bpmn-js-properties-panel-for-activiti less
导入相关样式，与activiti引擎
// 导入 BPMN-JS 样式
import 'bpmn-js/dist/assets/diagram-js.css' // Diagram-JS 的基本样式
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn.css' // BPMN 字体样式
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn-codes.css' // BPMN 字体代码样式
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn-embedded.css' // BPMN 嵌入字体样式
// 导入 Activiti 的 BPMN 属性面板样式
import 'bpmn-js-properties-panel-for-activiti/dist/assets/bpmn-js-properties-panel-for-activiti.css' // Activiti 属性面板样式
// 导入自定义样式
import '@/assets/style.less' // 自定义项目样式
// 导入 BPMN-JS 及其模块
import BpmnModeler from 'bpmn-js/lib/Modeler' // BPMN 模型器
import propertiesPanelModule from 'bpmn-js-properties-panel-for-activiti' // Activiti 属性面板模块
import propertiesProviderModule from 'bpmn-js-properties-panel-for-activiti/lib/provider/activiti' // Activiti 属性提供者模块
import activitiModdleExtension from 'bpmn-js-properties-panel-for-activiti/config/activiti.json' // Activiti 模型扩展配置
// 导入 BPMN 图表 XML
import diagramXML from './newDiagram.bpmn' // 示例 BPMN 图表 XML
- 初始化bpmn图
// 初始化
const init = () => {
modeler.value = new BpmnModeler({
container: '#js-canvas',
propertiesPanel: {
parent: '#js-properties-panel'
},
additionalModules: [
propertiesPanelModule,
propertiesProviderModule
],
moddleExtensions: {
activiti: activitiModdleExtension
}
})
}
结构
<template>
<div class="content" ref="jsDropZone" @drop.prevent="handleFileSelect" @dragover.prevent="handleDragOver">
<div class="message intro">
<div class="note">
从桌面拖放 BPMN 图，或者 <a @click.prevent="openDiagram(diagramXML)" href="#">创建新图表</a> 以开始使用。
</div>
</div>
<div class="message error">
<div class="note">
<p>哎呀，我们无法显示 BPMN 2.0 图。</p>
<div class="details">
<span>问题的原因</span>
<pre></pre>
</div>
</div>
</div>
<div class="canvas" id="js-canvas"></div>
<div class="properties-panel-parent" id="js-properties-panel"></div>
</div>
<ul class="buttons">
<li>下载</li>
<li>
<a @click.prevent="debounce(2)" href="#" title="下载 BPMN 图表">
BPMN 图
</a>
</li>
<li>
<a @click.prevent="debounce(1)" href="#" title="下载为 SVG 图像">
SVG 图像
</a>
</li>
</ul>
</template>
<style lang="less">
.content {
height: 100vh;
}
.djs-palette.two-column.open {
width: min-content;
}
.properties-panel-parent {
height: 100vh;
}
</style>
配置汉化
// 汉化
import customTranslate from '@/css/customTranslate/customTranslate'
customTranslate
其中translations.js 文件是中英文对应关系
import translations from './translationsGerman.js'
export default function customTranslate(template, replacements) {
replacements = replacements || {}
template = translations[template] || template
return template.replace(/{([^}]+)}/g, function (_, key) {
let str = replacements[key]
if (translations[replacements[key]] != null && translations [replacements[key]] !== 'undefined') {
str = translations[replacements[key]]
}
return str || '{' + key + '}'
})
}
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':'完成条件'
};
应用汉化包
// 初始化
const init = () => {
const customTranslateModule = {
translate: ['value', customTranslate]
}
modeler.value = new BpmnModeler({
container: '#js-canvas',
propertiesPanel: {
parent: '#js-properties-panel'
},
additionalModules: [
propertiesPanelModule,
propertiesProviderModule,
// 汉化
customTranslateModule
],
moddleExtensions: {
activiti: activitiModdleExtension
}
})
}
附代码
<script lang="ts" setup>
import { SysUser } from '@/api/sys-user'
// 导入 BPMN-JS 样式
import 'bpmn-js/dist/assets/diagram-js.css' // Diagram-JS 的基本样式
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn.css' // BPMN 字体样式
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn-codes.css' // BPMN 字体代码样式
import 'bpmn-js/dist/assets/bpmn-font/css/bpmn-embedded.css'
// 导入 Activiti 的 BPMN 属性面板样式
import 'bpmn-js-properties-panel-for-activiti/dist/assets/bpmn-js-properties-panel-for-activiti.css' // Activiti 属性面板样式
import { defineComponent, ref } from 'vue' // BPMN 嵌入字体样式
// 导入 BPMN-JS 及其模块
import BpmnModeler from 'bpmn-js/lib/Modeler' // BPMN 模型器
import propertiesPanelModule from 'bpmn-js-properties-panel-for-activiti' // Activiti 属性面板模块
import propertiesProviderModule from 'bpmn-js-properties-panel-for-activiti/lib/provider/activiti' // Activiti 属性提供者模块
import activitiModdleExtension from 'bpmn-js-properties-panel-for-activiti/config/activiti.json' // Activiti 模型扩展配置
// 汉化
import customTranslate from '@/utils/customTranslate'
import bpmn from '../init.bpmn?raw'
defineComponent({
name: 'Definition'
})
// 弹框控制
const visible = ref(false)
// 工作流在线绘制
const modeler = ref<BpmnModeler>()
const formModel = ref<SysUser>({
userId: undefined,
name: '',
nickName: '',
phonenumber: undefined,
status: undefined,
createTime: '',
deptName: ''
})
// 导入文件
async function openDiagram(xml) {
try {
await modeler.value.importXML(xml)
} catch (err) {
console.error(err)
}
}
// 初始化
const init = () => {
const customTranslateModule = {
translate: ['value', customTranslate]
}
modeler.value = new BpmnModeler({
container: '#js-canvas',
propertiesPanel: {
parent: '#js-properties-panel'
},
additionalModules: [
propertiesPanelModule,
propertiesProviderModule,
customTranslateModule
],
moddleExtensions: {
activiti: activitiModdleExtension
}
})
openDiagram(bpmn)
}
// 下载函数
function setEncoded(data, type) {
// 从 SVG 内容创建一个 Blob
let blob
let name
if (type === 'bpmn') {
blob = new Blob([data], { type: 'application/xml' })
name = 'diagram.bpmn'
} else {
blob = new Blob([data], { type: 'image/svg+xml' })
name = 'diagram.svg'
}
// 创建一个下载链接
const link = document.createElement('a')
link.href = URL.createObjectURL(blob)
link.download = name
// 模拟点击链接以触发下载
link.click()
// 清理资源
URL.revokeObjectURL(link.href)
}
function loadSave() {
modeler.value.saveXML({ format: true }, (res, xml) => {
setEncoded(xml, 'bpmn')
})
}
</script>
<template>
<div class="container">
<Breadcrumb :items="['menu.workflow', 'menu.workflow.definition']" />
<a-card class="general-card" :title="$t('menu.workflow.definition')">
<!-- 查询 -->
<!-- <a-row>
<a-col :flex="1">
<a-form :model="formModel">
<a-row :gutter="16">
<a-col :span="8">
<a-form-item field="name" :label="$t('user.name')">
<a-input
v-model="formModel.name"
:placeholder="$t('user.name.placeholder')"
/>
</a-form-item>
</a-col>
<a-col :span="8">
<a-form-item field="phonenumber" :label="$t('user.phonenumber')">
<a-input-number
v-model="formModel.phonenumber"
:placeholder="$t('user.phonenumber.placeholder')"
/>
</a-form-item>
</a-col>
<a-col :span="8">
<a-form-item field="status" :label="$t('user.status')">
<a-select
v-model="formModel.status" allow-clear
:placeholder="$t('user.status.placeholder')">
<a-option label="正常" :value="0" />
<a-option label="停用" :value="1" />
</a-select>
</a-form-item>
</a-col>
</a-row>
</a-form>
</a-col>
</a-row>-->
<a-divider style="margin-top: 0" />
<!-- 新建 -->
<a-row style="margin-bottom: 16px">
<a-col :span="12">
<a-space>
<a-button type="primary" @click="visible = true">
<template #icon>
<icon-plus />
</template>
{{ $t('searchTable.operation.create') }}
</a-button>
</a-space>
</a-col>
</a-row>
<a-modal v-model:visible="visible" title="新建流程" fullscreen @open="init">
<div class="box">
<div id="js-canvas"></div>
<div id="js-properties-panel"></div>
</div>
<template #footer>
<a-button>取消</a-button>
<a-button status="warning" @click.prevent="loadSave">下载</a-button>
<a-button type="primary">提交</a-button>
</template>
</a-modal>
</a-card>
</div>
</template>
<style scoped lang="less">
.container {
padding: 0 20px 20px 20px;
}
.box {
display: flex;
height: 100vh;
#js-canvas {
flex-grow: 1;
overflow: hidden;
}
#js-properties-panel {
height: 100vh;
overflow-y: auto;
}
}
</style>
activiti 的bpmn文件
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:activiti="http://activiti.org/bpmn" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" expressionLanguage="http://www.w3.org/1999/XPath" id="m1595657046886" name="" targetNamespace="http://www.activiti.org/testm1595657046886" typeLanguage="http://www.w3.org/2001/XMLSchema">
<process id="Process_Part1" isClosed="false" isExecutable="true" name="流程定义名称" processType="None">
<startEvent id="startEvent_1" />
</process>
<bpmndi:BPMNDiagram id="Diagram-_1">
<bpmndi:BPMNPlane bpmnElement="Process_Part1">
<bpmndi:BPMNShape bpmnElement="startEvent_1" id="Shape-startEvent_1">
<dc:Bounds height="36.0" width="36.0" x="412.0" y="240.0"/>
</bpmndi:BPMNShape>
</bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
</definitions>
