流程定义相关

流程定义查询

查询流程相关信息，包含流程定义，流程部署，流程定义版本

@Test
public void testDefinitionQuery(){//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取仓库服务RepositoryService repositoryService = processEngine.getRepositoryService();//获取流程定义集合List processDefinitionList = repositoryService.createProcessDefinitionQuery().processDefinitionKey("leaveProcess")//查询关于这个流程的所有流程定义对象.list();//遍历集合for (ProcessDefinition definition:processDefinitionList){System.out.println("流程定义ID:"+definition.getId());System.out.println("流程定义名称:"+definition.getName());System.out.println("流程定义key:"+definition.getKey());System.out.println("流程定义版本:"+definition.getVersion());System.out.println("流程部署ID:"+definition.getDeploymentId());System.out.println("====================");}
}

流程资源下载

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

@Test
public void testDownloadResource() throws Exception {//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取仓库服务RepositoryService repositoryService = processEngine.getRepositoryService();//获取流程定义集合List list = repositoryService.createProcessDefinitionQuery().processDefinitionKey("leaveProcess").orderByProcessDefinitionVersion()//按照版本排序.desc()//降序.list();//获取最新那个ProcessDefinition definition =list.get(0);//获取部署IDString deploymentId = definition.getDeploymentId();//获取bpmn的输入流InputStream bpmnInput = repositoryService.getResourceAsStream(deploymentId,//部署iddefinition.getResourceName()//bpmn文件名称);//获取png的输入流InputStream pngInput = repositoryService.getResourceAsStream(deploymentId,definition.getDiagramResourceName()//流程图片名称);//设置bpmn输出位置FileOutputStream bpmnOutPut = new FileOutputStream("D:/leave.bpmn");//设置png输出位置FileOutputStream pngOutPut = new FileOutputStream("D:/leave.png");//复制文件到指定位置IOUtils.copy(bpmnInput,bpmnOutPut);IOUtils.copy(pngInput,pngOutPut);
}

流程定义删除

根据部署Id删除对应的流程定义

@Test
public void testDeleteDeploy(){//流程部署IdString deploymentId = "10001";//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取仓库服务RepositoryService repositoryService = processEngine.getRepositoryService();//删除部署对象后自动删除流程定义等于部署相关的信息(历史的表会保留)，如果该流程定义已有流程实例启动则删除时出错repositoryService.deleteDeployment(deploymentId); //如果需要强制删除,设置true,即使该流程有流程实例启动也可以删除//repositoryService.deleteDeployment(deploymentId,true);
}

1. 如果该流程定义下没有正在运行的流程，则可以用普通删除。

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

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

流程实例相关

什么是流程实例

用户或程序按照流程定义内容发起一个流程，这就是一个流程实例。

流程定义和流程实例的图解：

BusinessKey（业务标识）

流程发起之后，目前设定的部门审批人都是李四，李四在审批之前需要看到申请人申请的时间和申请的理由，才能决定是否同意.

那么申请人的请假信息【请假时间、请假理由】是如何绑定到流程中的呢?

此时就需要使用到BusinessKey

• 启动流程实例时，指定的businessKey，就会在act_run_execution表中存储businessKey。
• BusinessKey：业务标识，通常为业务表的主键，每个流程实例存储一个业务标识。业务标识来源于业务系统。存储业务标识就是根据业务标识来关联查询业务系统的数据。比如：请假流程启动一个流程实例，就可以将请假表的id作为业务标识存储到Activiti中，将来查询Activiti的流程实例信息就可以获取请假单的id从而关联查询业务系统数据库得到请假单信息。
  

@Test
public void testStartProcess(){String businessKey = "8001";//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取RuntimeService对象RuntimeService runtimeService = processEngine.getRuntimeService();//根据流程定义的key启动流程实例,这个key是在画bpmn的时候设置的//在启动流程的时候将业务key加入进去ProcessInstance instance = runtimeService.startProcessInstanceByKey("leaveProcess",businessKey);//获取流程实例的相关信息System.out.println("流程定义的id = " + instance.getProcessDefinitionId());System.out.println("流程实例的id = " + instance.getId());
}

观察数据库可以发现，在activiti的act_ru_execution表，字段BUSINESS_KEY就是存放业务KEY的。

在用户执行任务的时候如何获取BusinessKey并关联对应的业务信息呢?

@Test
public void testGetBusinessKey(){//任务负责人String assignee = "李四";//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取TaskServiceTaskService taskService = processEngine.getTaskService();//获取RuntimeServiceRuntimeService runtimeService = processEngine.getRuntimeService();//获取任务集合List taskList = taskService.createTaskQuery().processDefinitionKey("leaveProcess").taskAssignee(assignee).list();//遍历任务列表for(Task task:taskList){System.out.println("流程定义id = " + task.getProcessDefinitionId());System.out.println("流程实例id = " + task.getProcessInstanceId());System.out.println("任务id = " + task.getId());System.out.println("任务名称 = " + task.getName());//根据任务上的流程实例Id查询出对应的流程实例对象，从流程实例对象中获取BusinessKeyProcessInstance instance = runtimeService.createProcessInstanceQuery().processInstanceId(task.getProcessInstanceId()).singleResult();System.out.println("业务key:"+instance.getBusinessKey());System.out.println("===================");}
}

流程定义/实例挂起/激活

全部流程实例挂起场景

1. 例如公司某个职位换新领导了,或者换人审批了,100个人的流程, 70个人已经完成,30个人流程正好在 换一个人审批阶段中,就需要挂起.

2. 比如我们的业务流程为:
   【开始节点】–>【A节点】–>【B节点】–>【C节点】–>【结束节点】

【C节点】的业务逻辑需要和外部接口交互，刚好外部接口出问题了,如果剩下的流程都走到【C节点】，执行【C节点】的业务逻辑，那都会报错，我们就可以把流程挂起，等待外部接口可用之后再重新激活流程.

3. 业务流程发生改变,已经发起的流程实例继续按照旧的流程走,如果新发起的流程就按照新的业务流程走.这时候我们就需要挂起流程定义(相当于这个旧流程不要了),但是不挂起流程实例.

• 操作流程定义为挂起状态，并且该流程定义将不允许启动新的流程实例

@Test
public void testSuspendAllProcessInstance(){//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取RepositoryServiceRepositoryService repositoryService = processEngine.getRepositoryService();//获取流程定义对象ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery().processDefinitionKey("leaveProcess").singleResult();boolean suspended = processDefinition.isSuspended();//判断是否已挂起//输出流程定义状态System.out.println("流程定义状态:"+(suspended ?"已挂起":"已激活"));//获取流程定义idString processDefinitionId = processDefinition.getId();if(suspended){//目前是挂起状态，可以执行激活操作 ,参数1 ：流程定义id ，参数2：是否激活该流程定义下的所有流程实例，参数3：激活时间repositoryService.activateProcessDefinitionById(processDefinitionId,true,null);System.out.println("流程ID:"+processDefinitionId+",已激活");}else{//目前是激活状态，可以执行挂起操作 ,参数1 ：流程定义id ，参数2：是否挂起暂停该流程定义下的所有流程实例，参数3：挂起时间repositoryService.suspendProcessDefinitionById(processDefinitionId,true,null);System.out.println("流程ID:"+processDefinitionId+",已挂起");}
}

当流程定义被挂起时,此时执行任务处理会抛出激活异常,xx流程已被挂起 org.activiti.engine.ActivitiException 错误
当流程实例被挂起时,此时执行任务处理会抛出不能完成一个被挂起的任务 org.activiti.engine.ActivitiException 错误

查询待办任务的状态,如果是【已挂起】,前台则应该不允许点击【任务处理】按钮

@Test
public void testSuspendStatus(){//任务负责人String assignee = "李四";//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取TaskServiceTaskService taskService = processEngine.getTaskService();//获取任务集合List taskList = taskService.createTaskQuery().processDefinitionKey("leaveProcess").taskAssignee(assignee).list();//遍历任务列表for(Task task:taskList){System.out.println("流程定义id = " + task.getProcessDefinitionId());System.out.println("流程实例id = " + task.getProcessInstanceId());System.out.println("任务id = " + task.getId());System.out.println("任务名称 = " + task.getName());System.out.println("任务状态:"+(task.isSuspended()?"已挂起":"已激活"));System.out.println("===================");}
}

单个流程实例挂起场景

评分流程：可设置多级评分，评分流程会按照从上往下的顺序，依次评分；评分人必须在评分截至时间内完成评分，否则不允许继续评分，流程将会挂起，停止流转；

• 操作流程实例对象，针对单个流程执行挂起操作，这个流程实例挂起则此流程不再执行，完成该流程实例的当前任务将报异常。

挂起某个流程实例

@Test
public void testSuspendSingleProcessInstance(){//流程实例IdString processInstanceId = "2501";//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取RepositoryServiceRuntimeService runtimeService = processEngine.getRuntimeService();//根据流程实例Id获取流程实例对象ProcessInstance processInstance = runtimeService.createProcessInstanceQuery().processInstanceId(processInstanceId).singleResult();//流程实例挂起状态boolean suspended = processInstance.isSuspended();System.out.println("流程实例ID:"+processInstanceId+",状态:"+ (suspended?"已挂起":"已激活"));if(suspended){//之前已经被挂起,可以执行激活操作runtimeService.activateProcessInstanceById(processInstanceId);System.out.println("流程实例ID:"+processInstanceId+",状态修改为已激活");}else{//之前没被挂起,可以执行挂起操作runtimeService.suspendProcessInstanceById(processInstanceId);System.out.println("流程实例ID:"+processInstanceId+",状态修改为已挂起");}
}

任务分配处理人

固定分配

在进行业务流程建模的时候指定固定的任务负责人。

UEL表达式分配

Activiti 使用 UEL 表达式， UEL 是 java EE6 规范的一部分， UEL（Unified Expression Language）即 统一表达式语言。

语法 ${变量名}

IDEA中的actiBPM插件在修改Assignee存在bug,在界面上修改了,但是实际文件并没有修改.所以我们需要借助编辑器打开bpmn.xml文件中修改一下Assignee

• 修改流程定义之后重新进行部署

• 编写代码配置处理人

@Test
public void testStartProcess(){//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取RuntimeService对象RuntimeService runtimeService = processEngine.getRuntimeService();//使用map封装流程图中需要的参数Map variables  = new HashMap();variables.put("assignee0","zhangsan");variables.put("assignee1","lisi");//根据流程定义的key启动流程实例,这个key是在画bpmn的时候设置的ProcessInstance instance = runtimeService.startProcessInstanceByKey("leaveProcess",variables);//将参数放入,这个方法有重载,也可以多放 业务标识//获取流程实例的相关信息System.out.println("流程定义的id = " + instance.getProcessDefinitionId());System.out.println("流程实例的id = " + instance.getId());
}

执行成功后，可以在act_ru_variable表中看到刚才map中的数据

流程变量

什么是流程变量？

• 流程变量在Activiti中是一个非常重要的角色，流程运转有时需要靠流程变量改变流程顺序，业务系统和Activiti结合时少不了流程变量，流程变量就是Activiti在管理工作流时根据管理需要而设置的变量。
• 比如在请假流程流转时如果请假天数>3天则有总经理审批，否则由人事直接审批，请假天数就可以设置成流程变量，在流程流转时使用。

注意：虽然流程变量中可以存储业务数据，可以通过Activiti的API查询流程变量从而实现查询业务数据，但是不建议这么使用，因为业务数据查询由业务系统负责，Activiti设置流程变量是为了流程执行需要而创建的。

流程变量类型

注意：
如果将实体类对象存储到流程变量中，必须实现序列化接口Serializable，为了防止由于新增字段无法反序列化。

流程变量的作用域

流程变量的作用域范围可以是一个流程实例（ProcessInstance）、一个任务（Task）或一个执行实例（Execution）。

• global全局变量: 流程变量的作用域范围的默认值是流程实例，作用域范围最大。
• local局部变量 : 流程变量的作用域范围如果仅仅针对一个任务或一个执行实例，那么作用域范围没有流程实例大

实际开发中一般不用local变量，了解即可.

流程变量的使用方法

• 在属性上使用UEL表达式
  可以在 assignee 处设置 UEL 表达式，表达式的值为任务的负责人，比如：${assignee}，assignee 就是一个流程变量名称。
  Activiti获取UEL表达式的值，即流程变量assignee的值 ，将assignee的值作为任务的负责人进行任务分配

• 在连线上使用UEL表达式
  可以在连线上设置UEL表达式，决定流程走向。
  比如：${price<10000} 。price就是一个流程变量名称，uel表达式结果类型为布尔类型。
  如果UEL表达式是true，要决定 流程执行走向。

使用全局变量控制流程

如 : 员工创建请假流程申请单，由部门经理审批，部门经理审批通过后请假3天以下(含3天)的由人事经理直接审批，3天以上的由总经理审批，总经理审批通过再通过人事经理审批。

在连线处添加判断条件

注意事项

1.如果UEL表达式中流程变量名在执行时不存在则报错。
2.如果如果UEL表达式都不符合条件,流程报错。
3.如果连接不设置条件/条件都满足,每个连线都会走.

任务候选人

在流程定义中在任务结点的 assignee 固定设置任务负责人，在流程定义时将参与者固定设置在.bpmn 文件中，如果临时任务负责人变更则需要修改流程定义，系统可扩展性差。

针对这种情况可以给任务设置多个候选人，可以从候选人中选择参与者来完成任务。

在流程图中任务节点的配置中设置 candidate-users(候选人)，多个候选人之间用逗号分开。

领取任务与放弃任务

1. 部署&启动流程
2. 查询候选人可领取的任务

//查询候选任务
@Test
public void testSelectCandidateTaskList(){//任务负责人String candidateUser = "李四";//创建ProcessEngine对象ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();//获取TaskServiceTaskService taskService = processEngine.getTaskService();//获取任务集合List taskList = taskService.createTaskQuery().processDefinitionKey("leaveCandidateProcess").taskCandidateUser(candidateUser)//根据候选人查询.list();//遍历任务列表for(Task task:taskList){System.out.println("流程定义id = " + task.getProcessDefinitionId());System.out.println("流程实例id = " + task.getProcessInstanceId());System.out.println("任务id = " + task.getId());System.out.println("任务名称 = " + task.getName());//找到要领取的任务进行领取taskService.claim(taskId,candidateUser);}
}

3. 如果已经领取的任务想放弃,还是执行什么的方法参数设置为null,另一个候选人再领取

taskService.claim(taskId,null);

4. 完成任务
   …

如果候选任务没有进行领取就直接完成的话，那么在历史记录中就不会记录是哪个用户执行了这个任务,所以对于这种候选人的任务，我们需要先领取再完成.

网关

和之前的连线分支差不多,也可以实现,但这是更专业的写法,官方推荐写法

排他网关

排他网关(ExclusiveGateway),用来在流程中实现决策。当流程执行到这个网关的时候，所有分支都会判断条件是否为true，如果为true则执行该分支。排他网关只会选择一个为true的分支执行（即使有两个分支条件都为true，排他网关也只会选择一条分支去执行,选择序号小的路径执行）

其余步骤和之前一样

并行网关

并行网关(ParallelGateway)允许将流程分成多条分支，也可以把多条分支汇聚到一起(大概意思就是将多个分支看做为一个整体,现实中常用于多人联合审核,必须要多个审核人都同意了,才能进入到下一个节点)

并行网关不会解析条件。即使顺序流中定义了条件，也会被忽略

其余步骤和之前一样

包含网关

包含网关(InclusiveGateway)可以看做是排他网关和并行网关的结合体。

如 : 出差申请大于3天需要由项目经理审批，小于3等于天由技术经理审批，但出差申请必须经过人事助理审批。