Activiti基础02：手把手带你来创建一个Activiti工作流

更多Java从0-1的笔记均在专栏中&＃xff5e;
Activiti基础01&＃xff1a;从认识Activiti7开始&＃xff0c;到环境配置

在本章内容中&＃xff0c;我们来创建一个Activiti工作流&＃xff0c;并启动这个流程。

创建Activiti工作流主要包含以下几步&＃xff1a;

1、定义流程&＃xff0c;按照BPMN的规范&＃xff0c;使用流程定义工具&＃xff0c;用流程符号把整个流程描述出来

2、部署流程&＃xff0c;把画好的流程定义文件&＃xff0c;加载到数据库中&＃xff0c;生成表的数据

3、启动流程&＃xff0c;使用java代码来操作数据库表中的内容

1.1 流程符号

BPMN 2.0是业务流程建模符号2.0的缩写。

它由Business Process Management Initiative这个非营利协会创建并不断发展。作为一种标识&＃xff0c;BPMN 2.0是使用一些符号来明确业务流程设计流程图的一整套符号规范&＃xff0c;它能增进业务建模时的沟通效率。

目前BPMN2.0是最新的版本&＃xff0c;它用于在BPM上下文中进行布局和可视化的沟通。

接下来我们先来了解在流程设计中常见的 符号。

BPMN2.0的基本符合主要包含&＃xff1a;

事件 Event

活动 Activity

活动是工作或任务的一个通用术语。一个活动可以是一个任务&＃xff0c;还可以是一个当前流程的子处理流程&＃xff1b; 其次&＃xff0c;你还可以为活动指定不同的类型。常见活动如下&＃xff1a;

网关 GateWay

网关用来处理决策&＃xff0c;有几种常用网关需要了解&＃xff1a;

排他网关 (x)

——只有一条路径会被选择。流程执行到该网关时&＃xff0c;按照输出流的顺序逐个计算&＃xff0c;当条件的计算结果为true时&＃xff0c;继续执行当前网关的输出流&＃xff1b;

​ 如果多条线路计算结果都是 true&＃xff0c;则会执行第一个值为 true 的线路。如果所有网关计算结果没有true&＃xff0c;则引擎会抛出异常。

​ 排他网关需要和条件顺序流结合使用&＃xff0c;default 属性指定默认顺序流&＃xff0c;当所有的条件不满足时会执行默认顺序流。

并行网关 (&＃43;)

——所有路径会被同时选择

​ 拆分 —— 并行执行所有输出顺序流&＃xff0c;为每一条顺序流创建一个并行执行线路。

​ 合并 —— 所有从并行网关拆分并执行完成的线路均在此等候&＃xff0c;直到所有的线路都执行完成才继续向下执行。

包容网关 (&＃43;)

—— 可以同时执行多条线路&＃xff0c;也可以在网关上设置条件

​ 拆分 —— 计算每条线路上的表达式&＃xff0c;当表达式计算结果为true时&＃xff0c;创建一个并行线路并继续执行

​ 合并 —— 所有从并行网关拆分并执行完成的线路均在此等候&＃xff0c;直到所有的线路都执行完成才继续向下执行。

事件网关 (&＃43;)

—— 专门为中间捕获事件设置的&＃xff0c;允许设置多个输出流指向多个不同的中间捕获事件。当流程执行到事件网关后&＃xff0c;流程处于等待状态&＃xff0c;需要等待抛出事件才能将等待状态转换为活动状态。

流向 Flow

流是连接两个流程节点的连线。常见的流向包含以下几种&＃xff1a;

1.2 流程设计器使用

Activiti-Designer使用

Palette&＃xff08;画板&＃xff09;

在idea中安装插件即可使用&＃xff0c;画板中包括以下结点&＃xff1a;

Connection—连接

Event—事件

Task—任务

Gateway—网关

Container—容器

Boundary event—边界事件

Intermediate event- -中间事件

流程图设计完毕保存生成.bpmn文件

新建流程(IDEA工具)

首先选中存放图形的目录(选择resources下的bpmn目录)&＃xff0c;点击菜单&＃xff1a;New -> BpmnFile&＃xff0c;如图&＃xff1a;

弹出如下图所示框&＃xff0c;输入evection 表示 出差审批流程&＃xff1a;

起完名字evection后&＃xff08;默认扩展名为bpmn&＃xff09;&＃xff0c;就可以看到流程设计页面&＃xff0c;如图所示&＃xff1a;

左侧区域是绘图区&＃xff0c;右侧区域是palette画板区域

鼠标先点击画板的元素即可在左侧绘图

绘制流程

使用滑板来绘制流程&＃xff0c;通过从右侧把图标拖拽到左侧的画板&＃xff0c;最终效果如下&＃xff1a;

指定流程定义Key

流程定义key即流程定义的标识&＃xff0c;通过properties视图查看流程的key

指定任务负责人

在properties视图指定每个任务结点的负责人&＃xff0c;如&＃xff1a;填写出差申请的负责人为 zhangsan

经理审批负责人为 jerry

总经理审批负责人为 jack

财务审批负责人为 rose

2.1 流程定义

概述

流程定义是线下按照bpmn2.0标准去描述 业务流程&＃xff0c;通常使用idea中的插件对业务流程进行建模。

使用idea下的designer设计器绘制流程&＃xff0c;并会生成两个文件&＃xff1a;.bpmn和.png

.bpmn文件

使用activiti-desinger设计业务流程&＃xff0c;会生成.bpmn文件&＃xff0c;上面我们已经创建好了bpmn文件

BPMN 2.0根节点是definitions节点。 这个元素中&＃xff0c;可以定义多个流程定义&＃xff08;不过我们建议每个文件只包含一个流程定义&＃xff0c; 可以简化开发过程中的维护难度&＃xff09;。 注意&＃xff0c;definitions元素 最少也要包含xmlns 和 targetNamespace的声明。 targetNamespace可以是任意值&＃xff0c;它用来对流程实例进行分类。

流程定义部分&＃xff1a;定义了流程每个结点的描述及结点之间的流程流转。

流程布局定义&＃xff1a;定义流程每个结点在流程图上的位置坐标等信息。

生成.png图片文件

IDEA工具中的操作方式

1、修改文件后缀为xml

首先将evection.bpmn文件改名为evection.xml&＃xff0c;如下图&＃xff1a;

evection.xml修改前的bpmn文件&＃xff0c;效果如下&＃xff1a;

2、使用designer设计器打开.xml文件

在evection.xml文件上面&＃xff0c;点右键并选择Diagrams菜单&＃xff0c;再选择Show BPMN2.0 Designer…

3、查看打开的文件

打开后&＃xff0c;却出现乱码&＃xff0c;如图&＃xff1a;

4、解决中文乱码

1、打开Settings&＃xff0c;找到File Encodings&＃xff0c;把encoding的选项都选择UTF-8

2、打开IDEA安装路径&＃xff0c;找到如下的安装目录

根据自己所安装的版本来决定&＃xff0c;我使用的是64位的idea&＃xff0c;所以在idea64.exe.vmoptions文件的最后一行追加一条命令&＃xff1a; -Dfile.encoding&＃61;UTF-8

如下所示&＃xff1a;

一定注意&＃xff0c;不要有空格&＃xff0c;否则重启IDEA时会打不开&＃xff0c;然后 重启IDEA。

如果以上方法已经做完&＃xff0c;还出现乱码&＃xff0c;就再修改一个文件&＃xff0c;并在文件的末尾添加&＃xff1a; -Dfile.encoding&＃61;UTF-8&＃xff0c;然后重启idea&＃xff0c;如图&＃xff1a;

最后重新在evection.xml文件上面&＃xff0c;点右键并选择Diagrams菜单&＃xff0c;再选择Show BPMN2.0 Designer…&＃xff0c;看到生成图片&＃xff0c;如图&＃xff1a;

到此&＃xff0c;解决乱码问题

5、导出为图片文件

点击Export To File的小图标&＃xff0c;打开如下窗口&＃xff0c;注意填写文件名及扩展名&＃xff0c;选择好保存图片的位置&＃xff1a;

然后&＃xff0c;我们把png文件拷贝到resources下的bpmn目录&＃xff0c;并且把evection.xml改名为evection.bpmn。

2.2 流程定义部署

概述

将上面在设计器中定义的流程部署到activiti数据库中&＃xff0c;就是流程定义部署。

通过调用activiti的api将流程定义的bpmn和png两个文件一个一个添加部署到activiti中&＃xff0c;也可以将两个文件打成zip包进行部署。

单个文件部署方式

分别将bpmn文件和png图片文件部署。

package com.itheima.test;import org.activiti.engine.ProcessEngine;
import org.activiti.engine.ProcessEngines;
import org.activiti.engine.RepositoryService;
import org.activiti.engine.repository.Deployment;
import org.junit.Test;public class ActivitiDemo {/*** 部署流程定义*/&＃64;Testpublic void testDeployment(){
// 1、创建ProcessEngineProcessEngine processEngine &＃61; ProcessEngines.getDefaultProcessEngine();
// 2、得到RepositoryService实例RepositoryService repositoryService &＃61; processEngine.getRepositoryService();
// 3、使用RepositoryService进行部署Deployment deployment &＃61; repositoryService.createDeployment().addClasspathResource("bpmn/evection.bpmn") // 添加bpmn资源.addClasspathResource("bpmn/evection.png") // 添加png资源.name("出差申请流程").deploy();
// 4、输出部署信息System.out.println("流程部署id&＃xff1a;" &＃43; deployment.getId());System.out.println("流程部署名称&＃xff1a;" &＃43; deployment.getName());}
}

执行此操作后activiti会将上边代码中指定的bpm文件和图片文件保存在activiti数据库。

压缩包部署方式

将evection.bpmn和evection.png压缩成zip包。

&＃64;Testpublic void deployProcessByZip() {// 定义zip输入流InputStream inputStream &＃61; this.getClass().getClassLoader().getResourceAsStream("bpmn/evection.zip");ZipInputStream zipInputStream &＃61; new ZipInputStream(inputStream);// 获取repositoryServiceRepositoryService repositoryService &＃61; processEngine.getRepositoryService();// 流程部署Deployment deployment &＃61; repositoryService.createDeployment().addZipInputStream(zipInputStream).deploy();System.out.println("流程部署id&＃xff1a;" &＃43; deployment.getId());System.out.println("流程部署名称&＃xff1a;" &＃43; deployment.getName());}

执行此操作后activiti会将上边代码中指定的bpm文件和图片文件保存在activiti数据库。

操作数据表

流程定义部署后操作activiti的3张表如下&＃xff1a;

act_re_deployment 流程定义部署表&＃xff0c;每部署一次增加一条记录

act_re_procdef 流程定义表&＃xff0c;部署每个新的流程定义都会在这张表中增加一条记录

act_ge_bytearray 流程资源表

接下来我们来看看&＃xff0c;写入了什么数据&＃xff1a;

SELECT * FROM act_re_deployment #流程定义部署表&＃xff0c;记录流程部署信息


结果&＃xff1a;

SELECT * FROM act_re_procdef #流程定义表&＃xff0c;记录流程定义信息


结果&＃xff1a;

注意&＃xff0c;KEY 这个字段是用来唯一识别不同流程的关键字

SELECT * FROM act_ge_bytearray #资源表


结果&＃xff1a;

注意&＃xff1a;

act_re_deployment和act_re_procdef一对多关系&＃xff0c;一次部署在流程部署表生成一条记录&＃xff0c;但一次部署可以部署多个流程定义&＃xff0c;每个流程定义在流程定义表生成一条记录。每一个流程定义在act_ge_bytearray会存在两个资源记录&＃xff0c;bpmn和png。

建议&＃xff1a;一次部署一个流程&＃xff0c;这样部署表和流程定义表是一对一有关系&＃xff0c;方便读取流程部署及流程定义信息。

2.3 启动流程实例

流程定义部署在activiti后就可以通过工作流管理业务流程了&＃xff0c;也就是说上边部署的出差申请流程可以使用了。

针对该流程&＃xff0c;启动一个流程表示发起一个新的出差申请单&＃xff0c;这就相当于java类与java对象的关系&＃xff0c;类定义好后需要new创建一个对象使用&＃xff0c;当然可以new多个对象。对于请出差申请流程&＃xff0c;张三发起一个出差申请单需要启动一个流程实例&＃xff0c;出差申请单发起一个出差单也需要启动一个流程实例。

代码如下&＃xff1a;

/*** 启动流程实例*/&＃64;Testpublic void testStartProcess(){
// 1、创建ProcessEngineProcessEngine processEngine &＃61; ProcessEngines.getDefaultProcessEngine();
// 2、获取RunTimeServiceRuntimeService runtimeService &＃61; processEngine.getRuntimeService();
// 3、根据流程定义Id启动流程ProcessInstance processInstance &＃61; runtimeService.startProcessInstanceByKey("myEvection");
// 输出内容System.out.println("流程定义id&＃xff1a;" &＃43; processInstance.getProcessDefinitionId());System.out.println("流程实例id&＃xff1a;" &＃43; processInstance.getId());System.out.println("当前活动Id&＃xff1a;" &＃43; processInstance.getActivityId());}

输出内容如下&＃xff1a;

操作数据表

act_hi_actinst 流程实例执行历史

act_hi_identitylink 流程的参与用户历史信息

act_hi_procinst 流程实例历史信息

act_hi_taskinst 流程任务历史信息

act_ru_execution 流程执行信息

act_ru_identitylink 流程的参与用户信息

act_ru_task 任务信息

2.4 任务查询

流程启动后&＃xff0c;任务的负责人就可以查询自己当前需要处理的任务&＃xff0c;查询出来的任务都是该用户的待办任务。

/*** 查询当前个人待执行的任务*/&＃64;Testpublic void testFindPersonalTaskList() {
// 任务负责人String assignee &＃61; "zhangsan";ProcessEngine processEngine &＃61; ProcessEngines.getDefaultProcessEngine();
// 创建TaskServiceTaskService taskService &＃61; processEngine.getTaskService();
// 根据流程key 和 任务负责人 查询任务List<Task> list &＃61; taskService.createTaskQuery().processDefinitionKey("myEvection") //流程Key.taskAssignee(assignee)//只查询该任务负责人的任务.list();for (Task task : list) {System.out.println("流程实例id&＃xff1a;" &＃43; task.getProcessInstanceId());System.out.println("任务id&＃xff1a;" &＃43; task.getId());System.out.println("任务负责人&＃xff1a;" &＃43; task.getAssignee());System.out.println("任务名称&＃xff1a;" &＃43; task.getName());}}


输出结果如下&＃xff1a;

流程实例id&＃xff1a;2501
任务id&＃xff1a;2505
任务负责人&＃xff1a;zhangsan
任务名称&＃xff1a;创建出差申请


2.5 流程任务处理

任务负责人查询待办任务&＃xff0c;选择任务进行处理&＃xff0c;完成任务。

// 完成任务&＃64;Testpublic void completTask(){
// 获取引擎ProcessEngine processEngine &＃61; ProcessEngines.getDefaultProcessEngine();
// 获取taskServiceTaskService taskService &＃61; processEngine.getTaskService();// 根据流程key 和 任务的负责人 查询任务
// 返回一个任务对象Task task &＃61; taskService.createTaskQuery().processDefinitionKey("myEvection") //流程Key.taskAssignee("zhangsan") //要查询的负责人.singleResult();// 完成任务,参数&＃xff1a;任务idtaskService.complete(task.getId());}

2.6 流程定义信息查询

查询流程相关信息&＃xff0c;包含流程定义&＃xff0c;流程部署&＃xff0c;流程定义版本

/*** 查询流程定义*/&＃64;Testpublic void queryProcessDefinition(){// 获取引擎ProcessEngine processEngine &＃61; ProcessEngines.getDefaultProcessEngine();
// repositoryServiceRepositoryService repositoryService &＃61; processEngine.getRepositoryService();
// 得到ProcessDefinitionQuery 对象ProcessDefinitionQuery processDefinitionQuery &＃61; repositoryService.createProcessDefinitionQuery();
// 查询出当前所有的流程定义
// 条件&＃xff1a;processDefinitionKey &＃61;evection
// orderByProcessDefinitionVersion 按照版本排序
// desc倒叙
// list 返回集合List<ProcessDefinition> definitionList &＃61; processDefinitionQuery.processDefinitionKey("myEvection").orderByProcessDefinitionVersion().desc().list();
// 输出流程定义信息for (ProcessDefinition processDefinition : definitionList) {System.out.println("流程定义 id&＃61;"&＃43;processDefinition.getId());System.out.println("流程定义 name&＃61;"&＃43;processDefinition.getName());System.out.println("流程定义 key&＃61;"&＃43;processDefinition.getKey());System.out.println("流程定义 Version&＃61;"&＃43;processDefinition.getVersion());System.out.println("流程部署ID &＃61;"&＃43;processDefinition.getDeploymentId());}}


输出结果&＃xff1a;

流程定义id&＃xff1a;myEvection:1:4
流程定义名称&＃xff1a;出差申请单
流程定义key&＃xff1a;myEvection
流程定义版本&＃xff1a;1


2.7 流程删除

public void deleteDeployment() {// 流程部署idString deploymentId &＃61; "1";ProcessEngine processEngine &＃61; ProcessEngines.getDefaultProcessEngine();// 通过流程引擎获取repositoryServiceRepositoryService repositoryService &＃61; processEngine.getRepositoryService();//删除流程定义&＃xff0c;如果该流程定义已有流程实例启动则删除时出错repositoryService.deleteDeployment(deploymentId);//设置true 级联删除流程定义&＃xff0c;即使该流程有流程实例启动也可以删除&＃xff0c;设置为false非级别删除方式&＃xff0c;如果流程//repositoryService.deleteDeployment(deploymentId, true);}

说明&＃xff1a;

1. 使用repositoryService删除流程定义&＃xff0c;历史表信息不会被删除


2. 如果该流程定义下没有正在运行的流程&＃xff0c;则可以用普通删除。


如果该流程定义下存在已经运行的流程&＃xff0c;使用普通删除报错&＃xff0c;可用级联删除方法将流程及相关记录全部删除。

先删除没有完成流程节点&＃xff0c;最后就可以完全删除流程定义信息

项目开发中级联删除操作一般只开放给超级管理员使用.

2.8 流程资源下载

现在我们的流程资源文件已经上传到数据库了&＃xff0c;如果其他用户想要查看这些资源文件&＃xff0c;可以从数据库中把资源文件下载到本地。

解决方案有&＃xff1a;

1、jdbc对blob类型&＃xff0c;clob类型数据读取出来&＃xff0c;保存到文件目录

2、使用activiti的api来实现

使用commons-io.jar 解决IO的操作

引入commons-io依赖包

<dependency><groupId>commons-iogroupId><artifactId>commons-ioartifactId><version>2.6version>
dependency>


通过流程定义对象获取流程定义资源&＃xff0c;获取bpmn和png

import org.apache.commons.io.IOUtils;&＃64;Testpublic void deleteDeployment(){
// 获取引擎ProcessEngine processEngine &＃61; ProcessEngines.getDefaultProcessEngine();
// 获取repositoryServiceRepositoryService repositoryService &＃61; processEngine.getRepositoryService();
// 根据部署id 删除部署信息,如果想要级联删除&＃xff0c;可以添加第二个参数&＃xff0c;truerepositoryService.deleteDeployment("1");}public void queryBpmnFile() throws IOException {
// 1、得到引擎ProcessEngine processEngine &＃61; ProcessEngines.getDefaultProcessEngine();
// 2、获取repositoryServiceRepositoryService repositoryService &＃61; processEngine.getRepositoryService();
// 3、得到查询器&＃xff1a;ProcessDefinitionQuery&＃xff0c;设置查询条件,得到想要的流程定义ProcessDefinition processDefinition &＃61; repositoryService.createProcessDefinitionQuery().processDefinitionKey("myEvection").singleResult();
// 4、通过流程定义信息&＃xff0c;得到部署IDString deploymentId &＃61; processDefinition.getDeploymentId();
// 5、通过repositoryService的方法&＃xff0c;实现读取图片信息和bpmn信息
// png图片的流InputStream pngInput &＃61; repositoryService.getResourceAsStream(deploymentId, processDefinition.getDiagramResourceName());
// bpmn文件的流InputStream bpmnInput &＃61; repositoryService.getResourceAsStream(deploymentId, processDefinition.getResourceName());
// 6、构造OutputStream流File file_png &＃61; new File("d:/evectionflow01.png");File file_bpmn &＃61; new File("d:/evectionflow01.bpmn");FileOutputStream bpmnOut &＃61; new FileOutputStream(file_bpmn);FileOutputStream pngOut &＃61; new FileOutputStream(file_png);
// 7、输入流&＃xff0c;输出流的转换IOUtils.copy(pngInput,pngOut);IOUtils.copy(bpmnInput,bpmnOut);
// 8、关闭流pngOut.close();bpmnOut.close();pngInput.close();bpmnInput.close();}

说明&＃xff1a;

1. deploymentId为流程部署ID


2. resource_name为act_ge_bytearray表中NAME_列的值


3. 使用repositoryService的getDeploymentResourceNames方法可以获取指定部署下得所有文件的名称


4. 使用repositoryService的getResourceAsStream方法传入部署ID和资源图片名称可以获取部署下指定名称文件的输入流


最后的将输入流中的图片资源进行输出。

2.9 流程历史信息的查看

即使流程定义已经删除了&＃xff0c;流程执行的历史信息通过前面的分析&＃xff0c;依然保存在activiti的act_hi_*相关的表中。所以我们还是可以查询流程执行的历史信息&＃xff0c;可以通过HistoryService来查看相关的历史记录。

/*** 查看历史信息*/&＃64;Testpublic void findHistoryInfo(){
// 获取引擎ProcessEngine processEngine &＃61; ProcessEngines.getDefaultProcessEngine();
// 获取HistoryServiceHistoryService historyService &＃61; processEngine.getHistoryService();
// 获取 actinst表的查询对象HistoricActivityInstanceQuery instanceQuery &＃61; historyService.createHistoricActivityInstanceQuery();
// 查询 actinst表&＃xff0c;条件&＃xff1a;根据 InstanceId 查询
// instanceQuery.processInstanceId("2501");
// 查询 actinst表&＃xff0c;条件&＃xff1a;根据 DefinitionId 查询instanceQuery.processDefinitionId("myEvection:1:4");
// 增加排序操作,orderByHistoricActivityInstanceStartTime 根据开始时间排序 asc 升序instanceQuery.orderByHistoricActivityInstanceStartTime().asc();
// 查询所有内容List<HistoricActivityInstance> activityInstanceList &＃61; instanceQuery.list();
// 输出for (HistoricActivityInstance hi : activityInstanceList) {System.out.println(hi.getActivityId());System.out.println(hi.getActivityName());System.out.println(hi.getProcessDefinitionId());System.out.println(hi.getProcessInstanceId());System.out.println("<&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;&＃61;>");}}