工作流中的流程追溯！Activiti架構的曆史元件詳細解析

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() 擷取