工作流中的流程追溯！詳細解析Activiti框架中的歷史組件

• 2021 年 6 月 9 日
• 筆記
• Java框架, 框架技術

Activit中的歷史簡介

• 歷史: Activiti中的一個組件,可以捕獲發生在進程執行中的資訊並永久的保存.與運行時數據不同的是,當流程實例運行完成之後它還會存在於資料庫中
• 歷史實體對象有5個:
  • HistoricProcessInstances: 包含當前和已經結束的流程實例資訊
  • HistoricVariableInstances: 包含最新的流程變數或任務變數
  • HistoricActivityInstances: 包含一個活動即流程上的節點的執行資訊
  • HistoricTaskInstances: 包含關於當前和已完成或已刪除任務實例資訊
  • HistoricDetails: 包含歷史流程實例,活動實例,任務實例的各種資訊
• 因為資料庫中保存著歷史資訊以及正在運行的流程實例資訊,就要考慮怎樣盡量減少的對運行中的流程實例數據進行訪問的方式來查詢這些表以保證執行的性能

查詢歷史

• 在Activiti API中提供了5中實體的查詢方法,在HistoryService類中:
  • createHistoricProcessInstanceQuery()
  • createHistoricVariableInstanceQuery()
  • createHistoricActivityInstanceQuery()
  • createHistoricDetailQuery()
  • createHistoricTaskInstanceQuery()

HistoricProcessInstanceQuery

• 流程實例
• 獲取流程定義ID是’XXX’,已經結束,花費時間最長(持續時間最長)的10個HistoricProcessInstances

historyService.createHistoricProcessInstanceQuery()
  .finished()
  .processDefinitionId("XXX")
  .orderByProcessInstanceDuration().desc()
  .listPage(0, 10);

HistoricVariableInstanceQuery

• 在ID為’xxx’,已經結束的流程實例中查詢所有HistoricVariableInstances, 並按變數名排序

historyService.createHistoricVariableInstanceQuery()
  .processInstanceId("XXX")
  .orderByVariableName.desc()
  .list();

HistoricActivityInstanceQuery

• 獲取所有已經結束的流程定義ID為』XXX’並且類型是’serviceTask’中的最後一個 HistoricActivityInstance

historyService.createHistoricActivityInstanceQuery()
  .activityType("serviceTask")
  .processDefinitionId("XXX")
  .finished()
  .orderByHistoricActivityInstanceEndTime().desc()
  .listPage(0, 1);

HistoricDetailQuery

• 獲取所有id為123的流程實例中產生的可變更新資訊
  • 這個查詢只會返回HistoricVariableUpdates
  • 注意一些變數名可能包含多個HistoricVariableUpdate實體,每次流程運行時會更新變數.可以用orderByTime(變數被更新的時間)或者orderByVariableRevision(運行更新時變數的版本)來排序查詢.

historyService.createHistoricDetailQuery()
  .variableUpdates()
  .processInstanceId("123")
  .orderByVariableName().asc()
  .list()

• 獲取所有流程實例ID為123的流程中 ,提交任務或者啟動流程時的form-properties. 這個查詢只會返回 HistoricFormPropertiess

historyService.createHistoricDetailQuery()
  .formProperties()
  .processInstanceId("123")
  .orderByVariableName().asc()
  .list()

• 獲取所有在執行ID為123的任務時的變數更新.返回全部在任務中設置的變數 (任務局部變數)HistoricVariableUpdates, 不是流程實例變數

historyService.createHistoricDetailQuery()
  .variableUpdates()
  .taskId("123")
  .orderByVariableName().asc()
  .list()  

• 任務局部變數可以用TaskService設置,在TaskListener里設置

taskService.setVariableLocal("123", "myVariable", "Variable value");

• 任務局部變數也可以用DelegateTask設置,在TaskListener里設置

public void notify(DelegateTask delegateTask) {
  delegateTask.setVariableLocal("myVariable", "Variable value");
}

HistoricTaskInstanceQuery

• 獲取所有任務中10個花費時間最長(持續時間最長)並已經結束的HistoricTaskInstances

historyService.createHistoricTaskInstanceQuery()
  .finished()
  .orderByHistoricTaskInstanceDuration().desc()
  .listPage(0, 10);

• 獲取刪除原因包含”invalid”,最後分配給用戶”kermit”的HistoricTaskInstances

historyService.createHistoricTaskInstanceQuery()
  .finished()
  .taskDeleteReasonLike("%invalid%")
  .taskAssignee("kermit")
  .listPage(0, 10);

歷史配置

• 歷史級別可以用編寫程式碼的方法配置 :org.activiti.engine.impl.history.HistoryLevel (枚舉類型)

ProcessEngine processEngine = ProcessEngineConfiguration
  .createProcessEngineConfigurationFromResourceDefault()
  .setHistory(HistoryLevel.AUDIT.getKey())
  .buildProcessEngine();

• 級別可以在配置文件activiti.cfg.xml或者在spring-context中配置:

<bean id="processEngineConfiguration" class="org.activiti.engine.impl.cfg.StandaloneInMemProcessEngineConfiguration">
  <property name="history" value="audit" />
  ...
</bean>

• 歷史資訊級別:
  • none:
    • 忽略所有歷史存檔:
      • 這是流程執行時性能最好的狀態,但沒有任何歷史資訊可用
  • activity:
    • 保存所有流程實例資訊和活動實例資訊:
      • 在流程實例結束時,最後一個流程實例中的最新的變數值將賦值給歷史變數
      • 不會保存過程中的詳細資訊
  • audit:
    • 默認值,保存所有流程實例資訊,活動資訊,保證所有的變數和提交的表單屬性保持同步
      • 這樣所有用戶交互資訊都是可追溯的,可以用來審計
  • full:
    • 這個級別存儲發生在審核以及所有其它細節的資訊,主要是更新流程變數
      • 是最高級別的歷史資訊存檔,同樣也是最慢的

審計

• 歷史配置在audit級別之上,所有通過:
  • FormService.submitStartFormData(String processDefinitionId, Map<String, String> properties)
  • FormService.submitTaskFormData(String taskId, Map<String, String> properties)
    提交的屬性都會被記錄
• 表單屬性可以通過API查詢:

historyService
      .createHistoricDetailQuery()
      .formProperties()
      ...
      .list();

類型為HistoricFormProperty的詳細資訊會被查詢出來

• 在調用IdentityService.setAuthenticatedUserId(String) 提交之前設置了認證用戶:
  • 提交表單的用戶將被保存在歷史資訊中:
    • 在開始表單中使用HistoricProcessInstance.getStartUserId() 獲取
    • 在任務表單中用HistoricActivityInstance.getAssignee() 獲取