1、什么是流程实例
参与者(可以是用户也可以是程序)按照流程定义内容发起一个流程,这就是一个流程实例,是动态的。
流程定义和流程实例的图解:
2、启动流程实例
流程定义部署在activiti后,就可以在系统中通过activiti去管理该流程的执行,执行流程表示流程的一次执行。比如部署系统请假流程后,如果某用户要申请请假这时就需要执行这个流程,如果另外一个用户也要申请请假则也需要执行该流程,每个执行互不影响,每个执行是单独的流程实例。
执行流程首先需要启动流程实例:
package com.zdw.activiti;
import org.activiti.engine.ProcessEngine;
import org.activiti.engine.ProcessEngines;
import org.activiti.engine.RuntimeService;
import org.activiti.engine.runtime.ProcessInstance;
/**
* Create By zdw on 2019/8/2
* 启动流程实例:
* 前提是先已经完成流程定义的部署工作
* 背后影响的表:
* act_hi_actinst 已完成的活动信息
act_hi_identitylink 参与者信息
act_hi_procinst 流程实例
act_hi_taskinst 任务实例
act_ru_execution 执行表
act_ru_identitylink 参与者信息
act_ru_task 任务
*/
public class ActivitiStartInstance {
public static void main(String[] args) {
//1.得到ProcessEngine对象
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
//2.得到RuntimeService
RuntimeService runtimeService = processEngine.getRuntimeService();
//3.根据流程定义key启动流程,得到流程实例ProcessInstance
ProcessInstance instance = runtimeService.startProcessInstanceByKey("myholiday");
//4.输出实例的相关信息
System.out.println("流程部署ID"+instance.getDeploymentId());
System.out.println("流程定义ID"+instance.getProcessDefinitionId());
System.out.println("流程实例ID"+instance.getId());
System.out.println("活动ID"+instance.getActivityId());
}
}
3、Businesskey(业务标识)
启动流程实例时,指定的businesskey,就会在act_ru_execution #流程实例的执行表中存储businesskey。
Businesskey:业务标识,通常为业务表的主键,业务标识和流程实例一一对应。业务标识来源于业务系统。存储业务标识就是根据业务标识来关联查询业务系统的数据。
比如:请假流程启动一个流程实例,就可以将请假单的id作为业务标识存储到activiti中,将来查询activiti的流程实例信息就可以获取请假单的id从而关联查询业务系统数据库得到请假单信息。
代码:
//3.根据流程定义key启动流程,得到流程实例ProcessInstance
String businessKey = "yw001";
ProcessInstance instance = runtimeService.startProcessInstanceByKey("myholiday",businessKey);
4、流程实例操作的数据库表
启动流程实例,操作如下数据库表:
SELECT * FROM act_ru_execution #流程实例执行表,记录当前流程实例的执行情况
说明:
流程实例执行,如果当前只有一个分支时,一个流程实例只有一条记录且执行表的主键id和流程实例id相同,如果当前有多个分支正在运行则该执行表中有多条记录,存在执行表的主键和流程实例id不相同的记录。不论当前有几个分支总会有一条记录的执行表的主键和流程实例id相同
一个流程实例运行完成,此表中与流程实例相关的记录删除。
SELECT * FROM act_ru_task #任务执行表,记录当前执行的任务
说明:启动流程实例,流程当前执行到第一个任务结点,此表会插入一条记录表示当前任务的执行情况,如果任务完成则记录删除。
SELECT * FROM act_ru_identitylink #任务参与者,记录当前参与任务的用户或组
SELECT * FROM act_hi_procinst #流程实例历史表
流程实例启动,会在此表插入一条记录,流程实例运行完成记录也不会删除。
SELECT * FROM act_hi_taskinst #任务历史表,记录所有任务
开始一个任务,不仅在act_ru_task表插入记录,也会在历史任务表插入一条记录,任务历史表的主键就是任务id,任务完成此表记录不删除。
SELECT * FROM act_hi_actinst #活动历史表,记录所有活动
活动包括任务,所以此表中不仅记录了任务,还记录了流程执行过程的其它活动,比如开始事件、结束事件。
5、查询流程实例
流程在运行过程中可以查询流程实例的状态,当前运行结点等信息。
package com.zdw.activiti02;
import org.activiti.engine.ProcessEngine;
import org.activiti.engine.ProcessEngines;
import org.activiti.engine.RuntimeService;
import org.activiti.engine.runtime.ProcessInstance;
import org.activiti.engine.runtime.ProcessInstanceQuery;
import java.util.List;
/**
* 查询流程实例信息
*/
public class QueryProcessInstanceInfo {
public static void main(String[] args) {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
RuntimeService runtimeService = processEngine.getRuntimeService();
//得到流程实例查询对象ProcessInstanceQuery
ProcessInstanceQuery processInstanceQuery = runtimeService.createProcessInstanceQuery();
//根据流程定义的key查询对应的所有的流程实例对象集合
List<ProcessInstance> instanceList = processInstanceQuery.processDefinitionKey("myholiday").list();
//遍历流程实例对象
for (ProcessInstance processInstance : instanceList) {
System.out.println("=============================");
System.out.println("流程实例ID:"+processInstance.getProcessInstanceId());
System.out.println("所属的流程定义的ID:"+processInstance.getProcessDefinitionId());
System.out.println("是否执行完成:"+processInstance.isEnded());
System.out.println("是否挂起:"+processInstance.isSuspended());
System.out.println("当前活动标识:"+processInstance.getActivityId());
}
}
}
5.1 关联 businessKey
需求:
在activiti实际应用时,查询流程实例列表时可能要显示出业务系统的一些相关信息,比如:查询当前运行的请假流程列表需要将请假单名称、请假天数等信息显示出来,请假天数等信息在业务系统中存在,而并没有在activiti数据库中存在,所以是无法通过activiti的api查询到请假天数等信息。
实现:
在查询流程实例时,通过businessKey(业务标识 )关联查询业务系统的请假单表,查询出请假天数等信息。
通过下面的代码就可以获取activiti中所对应实例保存的业务Key。而这个业务Key一般都会保存相关联的业务操作表的主键,再通过主键ID去查询业务信息,比如通过请假单的ID,去查询更多的请假信息(请假人,请假时间,请假天数,请假事由等)
String businessKey = processInstance.getBusinessKey();
在activiti的act_ru_execution表,字段BUSINESS_KEY就是存放业务KEY的。
5.2 挂起、激活流程实例
某些情况可能由于流程变更需要将当前运行的流程暂停而不是直接删除,流程暂停后将不会继续执行。
5.2.1 某个流程定义对应的全部流程实例挂起
操作流程定义为挂起状态,该流程定义下边所有的流程实例全部暂停;
流程定义为挂起状态,则该流程定义将不允许启动新的流程实例,同时该流程定义下所有的流程实例将全部挂起暂停执行。
package com.zdw.activiti02;
import org.activiti.engine.ProcessEngine;
import org.activiti.engine.ProcessEngines;
import org.activiti.engine.RepositoryService;
import org.activiti.engine.repository.ProcessDefinition;
import org.activiti.engine.repository.ProcessDefinitionQuery;
import java.util.List;
/**
* 流程定义的挂起和激活
*/
public class ProcessDefinitionOperate {
流程定义下面的所有流程实例挂起和激活
public static void main(String[] args) {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
RepositoryService repositoryService = processEngine.getRepositoryService();
//得到流程定义查询对象
ProcessDefinitionQuery processDefinitionQuery = repositoryService.createProcessDefinitionQuery();
//根据流程定义key查询得到流程定义对象
List<ProcessDefinition> processDefinitionList = processDefinitionQuery.processDefinitionKey("myholiday").list();
//遍历
for (ProcessDefinition processDefinition : processDefinitionList) {
//判断该流程定义是否挂起
boolean suspended = processDefinition.isSuspended();
String processDefinitionId = processDefinition.getId();
if(suspended){//如果暂停则激活,这里将流程定义下的所有流程实例全部激活
repositoryService.activateProcessDefinitionById(processDefinitionId,true,null);
System.out.println("流程定义:"+processDefinitionId+"激活");
}else{//如果是激活的,那就先挂起
repositoryService.suspendProcessDefinitionById(processDefinitionId,true,null);
System.out.println("流程定义:"+processDefinitionId+"挂起");
}
}
}
}
注意:如果我们操作了挂起该流程定义,那么该流程定义下面的流程实例将不能再进行执行任务,会报错:
org.activiti.engine.ActivitiException: Cannot complete a suspended task
5.2.2 单个流程实例挂起
操作流程实例对象,针对单个流程执行挂起操作,某个流程实例挂起则此流程不再继续执行,完成该流程实例的当前任务将报异常。
//单个流程实例的挂起和激活
public static void main(String[] args) {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
RuntimeService runtimeService = processEngine.getRuntimeService();
//得到流程实例查询对象 ProcessInstanceQuery
ProcessInstanceQuery processInstanceQuery = runtimeService.createProcessInstanceQuery();
//根据流程实例的ID查询流程定义对象
String processInstanceId = "2501";//流程实例id
ProcessInstance processInstance = processInstanceQuery.processInstanceId(processInstanceId).singleResult();
//得到流程实例的挂起状态
boolean suspended = processInstance.isSuspended();
if(suspended){
runtimeService.activateProcessInstanceById(processInstanceId);
System.out.println("流程实例:"+processInstanceId+"激活");
}else{
runtimeService.suspendProcessInstanceById(processInstanceId);
System.out.println("流程实例:"+processInstanceId+"挂起");
}
}