Flowable执行完毕的流程查找方法
作者：江南一点雨
正文
@[toc]
在之前的文章中松哥和小伙伴们聊过，正在执行的流程信息是保存在以 ACT_RU_ 为前缀的表中，执行完毕的流程信息则保存在以 ACT_HI_ 为前缀的表中，也就是流程历史信息表，当然这个历史信息表继续细分的话，还有好多种，今天我们就来聊一聊这个话题。
假设我有如下一个流程：
当这个流程执行完毕后，以 ACT_RU_ 为前缀的表中的数据均已清空，现在如果想查看刚刚执行过的流程信息，我们就得去以 ACT_HI_ 为前缀的表中。
1. 历史流程信息
历史流程信息查看，方式如下：
@Test
void test05() {
List<HistoricProcessInstance> list = historyService.createHistoricProcessInstanceQuery().finished().list();
for (HistoricProcessInstance hpi : list) {
logger.info("name:{},startTime:{},endTime:{}",hpi.getName(),hpi.getStartTime(),hpi.getEndTime());
}
}调用的时候执行的 finished() 方法表示查询已经执行完毕的流程信息（从这里也可以看出，对于未执行完毕的流程信息也会保存在历史表中）。
我们来看下这个查询对应的 SQL，如下：
SELECT RES.* , DEF.KEY_ as PROC_DEF_KEY_, DEF.NAME_ as PROC_DEF_NAME_, DEF.VERSION_ as PROC_DEF_VERSION_, DEF.DEPLOYMENT_ID_ as DEPLOYMENT_ID_ from ACT_HI_PROCINST RES left outer join ACT_RE_PROCDEF DEF on RES.PROC_DEF_ID_ = DEF.ID_ WHERE RES.END_TIME_ is not NULL order by RES.ID_ asc
从这个 SQL 中可以看到，这个查询本质上就是查询的 ACT_HI_PROCINST 表。如下图：
如果我们在查询的时候不限制流程是否执行完毕，那么我们的查询方法如下：
@Test
void test05() {
List<HistoricProcessInstance> list = historyService.createHistoricProcessInstanceQuery().list();
for (HistoricProcessInstance hpi : list) {
logger.info("name:{},startTime:{},endTime:{}",hpi.getName(),hpi.getStartTime(),hpi.getEndTime());
}
}对应的查询 SQL 如下：
SELECT RES.* , DEF.KEY_ as PROC_DEF_KEY_, DEF.NAME_ as PROC_DEF_NAME_, DEF.VERSION_ as PROC_DEF_VERSION_, DEF.DEPLOYMENT_ID_ as DEPLOYMENT_ID_ from ACT_HI_PROCINST RES left outer join ACT_RE_PROCDEF DEF on RES.PROC_DEF_ID_ = DEF.ID_ order by RES.ID_ asc
和前面的 SQL 相比，后面的 SQL 少了 WHERE RES.END_TIME_ is not NULL 条件，也就是说，判断一个流程是否执行完毕，就看它的 END_TIME_ 是否为空，不为空就表示流程已经执行结束了，为空就表示流程尚在执行中。
2. 历史任务查询
刚刚我们查询的是历史流程，接下来我们来看下历史任务，也就是查询一个流程中执行过的 Task 信息，如下表示查询所有的历史流程任务：
@Test
void test06() {
List<HistoricTaskInstance> list = historyService.createHistoricTaskInstanceQuery().list();
for (HistoricTaskInstance hti : list) {
logger.info("name:{},assignee:{},createTime:{},endTime:{}",hti.getName(),hti.getAssignee(),hti.getCreateTime(),hti.getEndTime());
}
}这个查询对应的 SQL 如下：
SELECT RES.* from ACT_HI_TASKINST RES order by RES.ID_ asc
可以看到，历史任务表就是 ACT_HI_TASKINST，如下图：
当然，这里还有很多其他的玩法，例如查询某一个流程已经执行完毕的历史任务，如下：
@Test
void test07() {
List<HistoricProcessInstance> instanceList = historyService.createHistoricProcessInstanceQuery().list();
for (HistoricProcessInstance hpi : instanceList) {
List<HistoricTaskInstance> list = historyService.createHistoricTaskInstanceQuery().processInstanceId(hpi.getId()).finished().list();
for (HistoricTaskInstance hti : list) {
logger.info("name:{},assignee:{},createTime:{},endTime:{}", hti.getName(), hti.getAssignee(), hti.getCreateTime(), hti.getEndTime());
}
}
}这个里边的查询历史任务的 SQL 如下：
SELECT RES.* from ACT_HI_TASKINST RES WHERE RES.PROC_INST_ID_ = ? and RES.END_TIME_ is not null order by RES.ID_ asc
可以看到，跟前面相比，多了两个条件：
- 流程实例 ID
- 流程结束时间不为 null
从这里也可以看出来，这个 finish 方法的执行逻辑跟我们前面讲的是一样的。
3. 历史活动查询
历史任务就是各种 Task，历史活动则包括跟多内容，像开始/结束节点，连线等等这些信息都算是活动，这个在之前的文章中松哥已经和大家介绍过了。
查询代码如下：
@Test
void test08() {
List<HistoricActivityInstance> list = historyService.createHistoricActivityInstanceQuery().list();
for (HistoricActivityInstance hai : list) {
logger.info("name:{},startTime:{},assignee:{},type:{}",hai.getActivityName(),hai.getStartTime(),hai.getAssignee(),hai.getActivityType());
}
}这个查询对应的 SQL 如下：
SELECT RES.* from ACT_HI_ACTINST RES order by RES.ID_ asc
可以看到，ACT_HI_ACTINST 表中保存了历史活动信息。
4. 历史变量查询
查询流程执行的历史变量，方式如下：
@Test
void test09() {
HistoricProcessInstance pi = historyService.createHistoricProcessInstanceQuery().singleResult();
List<HistoricVariableInstance> list = historyService.createHistoricVariableInstanceQuery().processInstanceId(pi.getId()).list();
for (HistoricVariableInstance hvi : list) {
logger.info("name:{},type:{},value:{}", hvi.getVariableName(), hvi.getVariableTypeName(), hvi.getValue());
}
}这个查询对应的 SQL 如下：
SELECT RES.* from ACT_HI_VARINST RES WHERE RES.PROC_INST_ID_ = ? order by RES.ID_ asc
可以看到流程的历史变量信息保存在 ACT_HI_VARINST 表中。
5. 历史日志查询
有的小伙伴看到日志这两个字可能会觉得奇怪，咦？流程执行还有日志吗？没听说过呀！
其实历史日志查询就是前面那几种的一个集大成者，用法如下：
@Test
void test10() {
HistoricProcessInstance pi = historyService.createHistoricProcessInstanceQuery().singleResult();
ProcessInstanceHistoryLog historyLog = historyService.createProcessInstanceHistoryLogQuery(pi.getId())
//包括历史活动
.includeActivities()
//包括历史任务
.includeTasks()
//包括历史变量
.includeVariables()
.singleResult();
logger.info("id:{},startTime:{},endTime:{}", historyLog.getId(), historyLog.getStartTime(), historyLog.getEndTime());
List<HistoricData> historicData = historyLog.getHistoricData();
for (HistoricData data : historicData) {
if (data instanceof HistoricActivityInstance) {
HistoricActivityInstance hai = (HistoricActivityInstance) data;
logger.info("name:{},type:{}", hai.getActivityName(), hai.getActivityType());
}
if (data instanceof HistoricTaskInstance) {
HistoricTaskInstance hti = (HistoricTaskInstance) data;
logger.info("name:{},assignee:{}", hti.getName(), hti.getAssignee());
}
if (data instanceof HistoricVariableInstance) {
HistoricVariableInstance hvi = (HistoricVariableInstance) data;
logger.info("name:{},type:{},value:{}", hvi.getVariableName(), hvi.getVariableTypeName(), hvi.getValue());
}
}
}这个里边，首先是查询基本的流程日志信息，这个本质上就是查询历史流程实例信息，对应的 SQL 如下：
select RES.*, DEF.KEY_ as PROC_DEF_KEY_, DEF.NAME_ as PROC_DEF_NAME_, DEF.VERSION_ as PROC_DEF_VERSION_, DEF.DEPLOYMENT_ID_ as DEPLOYMENT_ID_ from ACT_HI_PROCINST RES left outer join ACT_RE_PROCDEF DEF on RES.PROC_DEF_ID_ = DEF.ID_ where PROC_INST_ID_ = ?
接下来我写了三个 include，每一个 include 都对应一句 SQL：
includeActivities 对应的 SQL 如下：
SELECT RES.* from ACT_HI_ACTINST RES WHERE RES.PROC_INST_ID_ = ? order by RES.ID_ asc
includeTasks 对应的 SQL 如下：
SELECT RES.* from ACT_HI_TASKINST RES WHERE RES.PROC_INST_ID_ = ? order by RES.ID_ asc
includeVariables 对应的 SQL 如下：
SELECT RES.* from ACT_HI_VARINST RES WHERE RES.PROC_INST_ID_ = ? order by RES.ID_ asc
最终查询完成后，调用 getHistoricData 方法可以查看这些额外的数据，List 集合中存放的 HistoricData 也分为不同的类型：
- includeActivities 方法对应最终查询出来的类型是 HistoricActivityInstance。
- includeTasks 方法对应最终查询出来的类型是 HistoricTaskInstance。
- includeVariables 方法对应最终查询出来的类型是 HistoricVariableInstance。
在遍历的时候通过类型判断去查看具体是哪一种变量类型。
综上，这个历史日志查询其实就是一个集大成者。
6. 历史权限查询
这个是用来查询流程或者任务的处理人，例如查询流程的处理人，方式如下：
@Test
void test11() {
HistoricProcessInstance pi = historyService.createHistoricProcessInstanceQuery().singleResult();
List<HistoricIdentityLink> links = historyService.getHistoricIdentityLinksForProcessInstance(pi.getId());
for (HistoricIdentityLink link : links) {
logger.info("userId:{}",link.getUserId());
}
}这个是查询流程对应的处理人，对应的 SQL 如下：
select * from ACT_HI_IDENTITYLINK where PROC_INST_ID_ = ?
如果想查询任务的处理人，对应的方式如下：
@Test
void test12() {
String taskName = "提交请假申请";
HistoricTaskInstance hti = historyService.createHistoricTaskInstanceQuery().taskName(taskName).singleResult();
List<HistoricIdentityLink> links = historyService.getHistoricIdentityLinksForTask(hti.getId());
for (HistoricIdentityLink link : links) {
logger.info("{} 任务的处理人是 {}",taskName,link.getUserId());
}
}这个查询对应的 SQL 如下：
select * from ACT_HI_IDENTITYLINK where TASK_ID_ = ?
和前面的相比，其实就多了一个查询条件 TASK_ID_。
7. 自定义查询 SQL
和前面讲的很多查询类似，当我们弄懂了每一个历史查询的 API 操作的是哪一个数据表，就会发现，历史数据的查询，也可以自定义 SQL。
举个例子和小伙伴们看下，例如查询某一个流程已经执行完毕的历史任务：
@Test
void test13() {
List<HistoricProcessInstance> instanceList = historyService.createHistoricProcessInstanceQuery().list();
for (HistoricProcessInstance hpi : instanceList) {
List<HistoricTaskInstance> list = historyService.createNativeHistoricTaskInstanceQuery()
.sql("SELECT RES.* from ACT_HI_TASKINST RES WHERE RES.PROC_INST_ID_ = #{pid} and RES.END_TIME_ is not null order by RES.ID_ asc")
.parameter("pid",hpi.getId()).list();
for (HistoricTaskInstance hti : list) {
logger.info("name:{},assignee:{},createTime:{},endTime:{}", hti.getName(), hti.getAssignee(), hti.getCreateTime(), hti.getEndTime());
}
}
}flowable 底层是 MyBatis，所有 SQL 中参数的传递形式和 MyBatis 一致。
8. 历史数据记录级别
Flowable 需要记录哪些历史数据，有一个日志级别用来描述这个事情，默认有四种级别：
- None: 这个表示不存储任何历史信息，好处是流程执行的时候效率会比较快，坏处是流程执行结束后，看不到曾经执行过的流程信息了。
- Activity: 这个会存储所有流程实例和活动实例，在流程实例结束时，顶级流程实例变量的最新值将复制到历史变量实例中，不会存储详细信息。
- Audit: 在 Activity 的基础上，还会存储历史详细信息，包括权限信息等。默认的日志记录级别即次。
- Full: 这个是在 Audit 的基础上，还会存储变量的变化信息，这会记录大量的数据，也会导致流程执行变慢。
一共就这四种级别，在 Spring Boot 项目中，如果我们想要配置这个日志记录的级别，其实非常方便，直接在 application.properties 中进行配置即可，如下：
flowable.history-level=none
配置加了这个配置，我们随便启动一个流程，然后去查询 ACT_HI_ 系列的表，发现都是空的，没有数据。
如果我们将历史日志记录的级别改为 activity，那么就会记录下来流程信息以及活动信息，但是像执行的 Task 这些信息都是没有的（ACT_HI_TASKINST），包括流程参与者的信息（ACT_HI_IDENTITYLINK）等都不会记录下来。
如果我们将历史日志记录的级别改为 audit，则上面提到的这几种日志就都会记录下来。但是 ACT_HI_DETAIL 表还是空的，详细一个流程变量的变化过程不会被记录下来。
如果我们将日志记录级别改为 full，那么将会记录下更多的信息。ACT_HI_DETAIL 表中会记录下流程变量的详细信息。
以上就是Flowable执行完毕的流程查找方法的详细内容，更多关于Flowable执行完毕流程查找的资料请关注脚本之家其它相关文章！