如何查詢已經(jīng)執(zhí)行過的流程信息？
今天我們就來看看 HistoryService 的使用。
本文使用的流程圖依然是上篇文章中使用過的，如下：
1. 查詢歷史流程
查詢歷史流程的方式很簡答，如下：
@SpringBootTest
public class HiTest {
@Autowired
HistoryService historyService;
private static final Logger logger = LoggerFactory.getLogger(HiTest.class);
@Test
void test01() {
List<HistoricProcessInstance> list = historyService.createHistoricProcessInstanceQuery().list();
for (HistoricProcessInstance hi : list) {
logger.info("==={},{},{},{},{},{}",hi.getId(),hi.getName(),hi.getStartActivityId(),hi.getStartTime(),hi.getEndActivityId(),hi.getEndTime());
}
}
}
由于我們這是 Spring Boot 項目，所以基本上不需要什么額外的配置，直接注入 HistoryService 實例即可。
test01 方法中的代碼就是查詢出來目前所有的流程實例，包括正在執(zhí)行的和已經(jīng)執(zhí)行完畢的都可以查詢到。查詢之后，控制臺打印結(jié)果如下：
==> Preparing: 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
==> Parameters:
<== Total: 1
Flushing dbSqlSession
flush summary: 0 insert, 0 update, 0 delete.
now executing flush...
--- HistoricProcessInstanceQueryImpl finished --------------------------------------------------------
===a3786614-38eb-11ed-afc8-acde48001122,null,startEvent1,Tue Sep 20 21:53:42 CST 2022,null,null
首先大家看到，這里查詢的 SQL，查詢的表是 ACT_HI_PROCINST，簡單截個圖大家看下：
大家看到，這張表中記錄了流程實例 ID，流程定義 ID，流程開始的時間，流程結(jié)束的時間，流程執(zhí)行耗時，流程開始的節(jié)點，流程發(fā)起人，流程結(jié)束的節(jié)點等等。
同時大家也可以看到，在打印出來的查詢結(jié)果中，getEndActivityId 和 getEndTime 這兩個字段的值都為 null，這就說明這個流程目前還在執(zhí)行中，還沒執(zhí)行完畢，當(dāng)一個流程執(zhí)行完畢的時候，這兩個字段就不會為 null 了，小伙伴們可以根據(jù)這個特點去判斷一個流程是否執(zhí)行完畢。
現(xiàn)在根據(jù)我們上篇文章中介紹的知識點，我將流程這個流程中的任務(wù)都執(zhí)行完畢，執(zhí)行完畢之后，ACT_RU_EXECUTION 表中關(guān)于流程的記錄就會被刪除掉，也就是執(zhí)行如下代碼現(xiàn)在是查詢不到上面這個流程了：
@Autowired
RuntimeService runtimeService;
@Test
void test02() {
ProcessInstance pi = runtimeService.createProcessInstanceQuery().processInstanceId("a3786614-38eb-11ed-afc8-acde48001122").singleResult();
logger.info("pi:{}",pi);
}
這個方法執(zhí)行返回的 pi 對象現(xiàn)在為 null。
現(xiàn)在我們想查詢剛剛執(zhí)行的流程，得去查詢歷史流程，也就是去 ACT_HI_PROCINST 表中去查詢，執(zhí)行我們最上面那個方法：
@Test
void test01() {
List<HistoricProcessInstance> list = historyService.createHistoricProcessInstanceQuery().list();
for (HistoricProcessInstance hi : list) {
logger.info("==={},{},{},{},{},{}",hi.getId(),hi.getName(),hi.getStartActivityId(),hi.getStartTime(),hi.getEndActivityId(),hi.getEndTime());
}
}
現(xiàn)在去查詢，返回的結(jié)果中就可以看到 EndActivityId 以及 EndTime 這兩個字段了，因為流程已經(jīng)執(zhí)行結(jié)束了。
通過上面的介紹，大家應(yīng)該也發(fā)現(xiàn)了，在流程執(zhí)行的過程中，ACT_HI_PROCINST 表中的流程記錄和 ACT_RU_EXECUTION 表中的流程記錄是一一對應(yīng)的。
2. 查詢歷史活動
一個流程中的每一個節(jié)點都是一個活動，當(dāng)一個流程執(zhí)行結(jié)束的時候，如果我們還想查看每一個活動執(zhí)行的細節(jié)，就得通過查詢歷史活動來實現(xiàn)了。
在查詢之前，小伙伴們先來了解下跟歷史活動相關(guān)的兩張表。
ACT_HI_ACTINST
這張表中保存一個流程中的所有活動細節(jié)。包括流程的啟動節(jié)點、結(jié)束節(jié)點、各種 Task 甚至節(jié)點之間的連線，大家來看下這張表中的信息：
大家看到，這剛好是一個流程的完整記錄，從上往下，分別是：
- 啟動流程。
- 連線
- 提交請假申請這個 UserTask
- 連線
- 主管審批這個 UserTask
- 連線
- 經(jīng)理審批這個 UserTask
- 連線
- 結(jié)束
事無巨細，全部都記錄下來了。
ACT_HI_TASKINST
這個表看名字就知道只記錄下來了 Task 的信息，我截個圖大家來看下：
小伙伴們看下，這張表記錄下來了每一個 Task 的具體信息，包括這個 Task 是由誰處理的，Task 的名字，開始時間、結(jié)束時間、耗時等信息。
那么針對這兩張表，也有不同的查詢方式。
首先來看查詢歷史活動：
@Test
void test03() {
List<HistoricActivityInstance> list = historyService.createHistoricActivityInstanceQuery().orderByHistoricActivityInstanceStartTime().asc().list();
for (HistoricActivityInstance hai : list) {
logger.info("流程ID：{}，活動名稱：{}，活動ID:{}，活動處理人：{}",hai.getProcessInstanceId(),hai.getActivityName(),hai.getActivityId(),hai.getAssignee());
}
}
查詢結(jié)果如下圖：
小伙伴們看查詢 SQL 也印證我們說的沒有問題。由于我這里目前只執(zhí)行了一個流程，所以這里就只顯示了一個流程的所有活動，大家看打印出來的流程 ID 都是一樣的。
再來看查詢歷史 Task：
@Test
void test04() {
List<HistoricTaskInstance> list = historyService.createHistoricTaskInstanceQuery().orderByHistoricTaskInstanceStartTime().asc().list();
for (HistoricTaskInstance hti : list) {
logger.info("流程ID：{}，Task 開始時間：{}，Task 結(jié)束時間:{}，Task 處理人：{}",hti.getProcessInstanceId(),hti.getCreateTime(),hti.getEndTime(),hti.getAssignee());
}
}
查詢結(jié)果如下：
查詢 SQL 也如我們所預(yù)料的。
