今天来和小伙伴们聊一聊流程的挂起和激活。
这块实际上涉及到两部分内容:
- 流程定义的挂起和激活。
- 流程实例的挂起和激活。
一个定义好的流程,如果挂起了,那么就无法据此创建新的流程。
一个流程实例如果挂起了,那么就无法执行流程中的任务。
小伙伴们注意区分这两个概念(看了前面几篇文章的小伙伴,应该对于这两个概念不在话下了)。
我们分别来看。
1. 流程定义的挂起与激活
1.1 查询是否挂起
对于一个定义好的流程,我们可以通过如下方法来查看这个流程是否挂起:
@Test
void test05() {
List list = repositoryService.createProcessDefinitionQuery().list();
for (ProcessDefinition processDefinition : list) {
String id = processDefinition.getId();
boolean suspended = repositoryService.isProcessDefinitionSuspended(id);
if (suspended) {
logger.info("流程定义 {} 已挂起",processDefinition.getName());
}else{
logger.info("流程定义 {} 未挂起",processDefinition.getName());
}
}
}
这个查询 SQL 涉及到的表是 ACT_RE_PROCDEF
,该表中有一个名为 SUSPENSION_STATE_
的字段,该字段表示这个流程是否挂起。如下图:
1 表示流程没有挂起。
1.2 挂起
执行如下方法,可以挂起一个流程定义,如下:
@Test
void test06() {
List list = repositoryService.createProcessDefinitionQuery().list();
for (ProcessDefinition pd : list) {
repositoryService.suspendProcessDefinitionById(pd.getId());
}
}
挂起的原理其实很简单,就是去 ACT_RE_PROCDEF
表中,将 SUSPENSION_STATE_
字段的值设置为 2,就表示这个流程定义挂起了,我们可以看下流程定义挂起时执行的 SQL:
从这个执行的 SQL 中我们可以清晰的看到,操作的表是 ACT_RE_PROCDEF
,修改的字段就是 SUSPENSION_STATE_
,将该字段的值修改为 2(乐观锁相关的 REV_ 字段不考虑)。
对于一个已经挂起的流程定义,如果我们想据此启动一个流程,如下:
@Test
void test01() {
identityService.setAuthenticatedUserId("wangwu");
ProcessInstance pi = runtimeService.startProcessInstanceByKey("leave");
logger.info("id:{},activityId:{}", pi.getId(), pi.getActivityId());
}
此时就会抛出如下异常:
这个异常说的很明白了,流程定义被挂起了,无法开启一个新的流程实例。
1.3 激活
已经挂起的流程定义,还可以激活,方式如下:
@Test
void test07() {
List list = repositoryService.createProcessDefinitionQuery().list();
for (ProcessDefinition pd : list) {
repositoryService.activateProcessDefinitionById(pd.getId());
}
}
激活的原理也很简单,,就是去 ACT_RE_PROCDEF
表中,将 SUSPENSION_STATE_
字段的值设置为 1,就表示这个流程定义激活了,我们可以看下流程定义激活时执行的 SQL:
大家注意看操作的表、字段以及对应的参数。
2. 流程实例的挂起与激活
第一小节搞懂了,第二小节就容易多了。
2.1 挂起
挂起一个流程实例的方式如下:
@Test
void test08() {
List list = repositoryService.createProcessDefinitionQuery().list();
for (ProcessDefinition pd : list) {
repositoryService.suspendProcessDefinitionById(pd.getId(), true, null);
}
}
小伙伴们看到,其实还是刚才上面的那个方法,只不过这里多了两个参数:
- 第二个参数 true 表示是否要挂起这个流程定义对应的所有的流程实例,true 表示挂起。
- 第三个参数 null 表示流程挂起的具体时间,如果该参数为 null,则流程会被立马挂起,如果该参数是一个具体的日期,则到期之后流程才会被挂起,但是这个需要 job executor 的支持,关于 job executor,松哥后面再单独发文章和小伙伴们介绍。
执行完成之后,这个流程实例就被挂起了。流程实例被挂起,涉及到两个地方:
- 流程的执行实例被挂起。
- 流程的 Task 被挂起。
也就是首先 ACT_RU_EXECUTION
表中对应的流程实例会被挂起:
最后一列两个 2 就说明这两个执行实例被挂起了。
同时,流程实例的 Task 其实也被挂起了,即 ACT_RU_TASK
表中与之对应的任务被挂起了,如下:
可以看到,SUSPENSION_STATE_
字段的值为 2,表示这 Task 也被挂起了。
我们来看看挂起流程实例时执行的 SQL:
注意,流程定义本身也被挂起了。
对于处于挂起状态的流程实例,是无法继续执行的,如果强行执行,如下:
@Test
void test03() {
List list = taskService.createTaskQuery().taskAssignee("wangwu").list();
for (Task task : list) {
taskService.complete(task.getId());
}
}
则会抛出异常,如下:
这个异常也说的很清楚了,无法完成一个处于挂起状态的 Task。
2.2 激活
处于挂起状态的流程实例,可以通过如下方式激活:
@Test
void test09() {
List list = repositoryService.createProcessDefinitionQuery().list();
for (ProcessDefinition pd : list) {
repositoryService.activateProcessDefinitionById(pd.getId(), true, null);
}
}
一共三个参数:
- 流程定义的 ID。
- 是否激活流程定义对应的流程实例。
- 激活流程实例的时间,null 表示立马激活,如果是一个具体的时间,则到期激活,不过和之前的一样,这里也需要 job executor 的支持。
激活就是反向操作,将 ACT_RU_EXECUTION
、ACT_RU_TASK
以及 ACT_RE_PROCDEF
表中的 SUSPENSION_STATE_
字段值再改为 1。对应的 SQL 如下:
好啦,挂起与激活就先聊这么多,下篇文章继续~