前言
? ? ? ? 本文基于 Activiti 7.0.0.GA 源碼,研究?Activiti 如何啟動一個流程實例。
審批流程圖
如下圖,在此流程圖中,存在兩個UserTask節點,第一個節點是主管審批,第二個節點是產品經理審批,兩個節點中間有一個排他網關,此網關用來對主管審批的結果進行判斷,如果主管審批通過,則流程走到產品經理審批節點,如果主管審批拒絕,則流程走到結束節點。
主管審批節點通過UEL表達式${assignManager}動態賦值,產品經理審批節點通過UEL表達式${assignProductLineManager}動態賦值,網關節點通過UEL表達式${isPass}動態賦值。
啟動流程實例
以RuntimeService接口的startProcessInstanceById(String, Map)為源碼入口,研究Activiti框架如何啟動一個流程實例。
ProcessInstance startProcessInstanceById(String processDefinitionId, Map<String, Object> variables)
RuntimeService接口的實現類RuntimeServiceImpl實現如下,把傳入的processDefinitionId和variable封裝成StartProcessInstanceCmd,然后把StartProcessInstanceCmd放入commandExecutor命令執行器的execute方法中,待后續調用。
public ProcessInstance startProcessInstanceById(String processDefinitionId, Map<String, Object> variables) {return commandExecutor.execute(new StartProcessInstanceCmd<ProcessInstance>(null, processDefinitionId, null, variables));
}
CommandExecutor內部持有一個命令攔截器LogInterceptor,LogInterceptor是CommandInteceptor命令攔截器鏈中的第一個攔截器,StartProcessInstanceCmd在執行前會經過攔截器鏈中的所有攔截器。
攔截器鏈中的各個攔截器的前后順序如下,CommandInvoker是攔截器鏈中的處于最末端的攔截器,專用于調用實現了Command接口的各種CMD類。
StartProcessInstanceCmd實現了Command接口,該接口只有一個execute方法,此方法會被CommandInvoker攔截器調用,從而開始執行StartProcessInstanceCmd實現的execute方法,用以啟動一個流程實例。
@Internal
public interface Command<T> {T execute(CommandContext commandContext);
}
StartProcessInstanceCmd實現execute方法如下:
package org.activiti.engine.impl.cmd;import java.io.Serializable;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;import org.activiti.bpmn.model.ValuedDataObject;
import org.activiti.engine.ActivitiIllegalArgumentException;
import org.activiti.engine.ActivitiObjectNotFoundException;
import org.activiti.engine.ProcessEngineConfiguration;
import org.activiti.engine.impl.interceptor.Command;
import org.activiti.engine.impl.interceptor.CommandContext;
import org.activiti.engine.impl.persistence.deploy.DeploymentManager;
import org.activiti.engine.impl.runtime.ProcessInstanceBuilderImpl;
import org.activiti.engine.impl.util.ProcessInstanceHelper;
import org.activiti.engine.repository.ProcessDefinition;
import org.activiti.engine.runtime.ProcessInstance;/*** 開啟流程實例-命令類*/
public class StartProcessInstanceCmd<T> implements Command<ProcessInstance>, Serializable {private static final long serialVersionUID = 1L;protected String processDefinitionKey;protected String processDefinitionId;protected Map<String, Object> variables;protected Map<String, Object> transientVariables;protected String businessKey;protected String tenantId;protected String processInstanceName;protected ProcessInstanceHelper processInstanceHelper;public StartProcessInstanceCmd(String processDefinitionKey, String processDefinitionId, String businessKey, Map<String, Object> variables) {this.processDefinitionKey = processDefinitionKey;this.processDefinitionId = processDefinitionId;this.businessKey = businessKey;this.variables = variables;}public StartProcessInstanceCmd(String processDefinitionKey, String processDefinitionId, String businessKey, Map<String, Object> variables, String tenantId) {this(processDefinitionKey, processDefinitionId, businessKey, variables);this.tenantId = tenantId;}public StartProcessInstanceCmd(ProcessInstanceBuilderImpl processInstanceBuilder) {this(processInstanceBuilder.getProcessDefinitionKey(), processInstanceBuilder.getProcessDefinitionId(), processInstanceBuilder.getBusinessKey(), processInstanceBuilder.getVariables(), processInstanceBuilder.getTenantId());this.processInstanceName = processInstanceBuilder.getProcessInstanceName();this.transientVariables = processInstanceBuilder.getTransientVariables();}/*** 從 CommandInvoker 調用下面這個方法* @param commandContext* @return*/public ProcessInstance execute(CommandContext commandContext) {// 取出已經部署好的流程信息DeploymentManager deploymentCache = commandContext.getProcessEngineConfiguration().getDeploymentManager();// Find the process definitionProcessDefinition processDefinition = null;// 傳入了processDefinitionId,所以進入到這個if中,if (processDefinitionId != null) {// 通過 processDefinitionId 從緩存中找到 processDefinition 流程定義processDefinition = deploymentCache.findDeployedProcessDefinitionById(processDefinitionId);if (processDefinition == null) {throw new ActivitiObjectNotFoundException("No process definition found for id = '" + processDefinitionId + "'", ProcessDefinition.class);}} else if (processDefinitionKey != null && (tenantId == null || ProcessEngineConfiguration.NO_TENANT_ID.equals(tenantId))) {processDefinition = deploymentCache.findDeployedLatestProcessDefinitionByKey(processDefinitionKey);if (processDefinition == null) {throw new ActivitiObjectNotFoundException("No process definition found for key '" + processDefinitionKey + "'", ProcessDefinition.class);}} else if (processDefinitionKey != null && tenantId != null && !ProcessEngineConfiguration.NO_TENANT_ID.equals(tenantId)) {processDefinition = deploymentCache.findDeployedLatestProcessDefinitionByKeyAndTenantId(processDefinitionKey, tenantId);if (processDefinition == null) {throw new ActivitiObjectNotFoundException("No process definition found for key '" + processDefinitionKey + "' for tenant identifier " + tenantId, ProcessDefinition.class);}} else {throw new ActivitiIllegalArgumentException("processDefinitionKey and processDefinitionId are null");}// 獲取一個 ProcessInstanceHelper,用于啟動流程processInstanceHelper = commandContext.getProcessEngineConfiguration().getProcessInstanceHelper();ProcessInstance processInstance = createAndStartProcessInstance(processDefinition, businessKey, processInstanceName, variables, transientVariables);return processInstance;}protected ProcessInstance createAndStartProcessInstance(ProcessDefinition processDefinition, String businessKey, String processInstanceName, Map<String,Object> variables, Map<String, Object> transientVariables) {return processInstanceHelper.createAndStartProcessInstance(processDefinition, businessKey, processInstanceName, variables, transientVariables);}protected Map<String, Object> processDataObjects(Collection<ValuedDataObject> dataObjects) {Map<String, Object> variablesMap = new HashMap<String, Object>();// convert data objects to process variablesif (dataObjects != null) {for (ValuedDataObject dataObject : dataObjects) {variablesMap.put(dataObject.getName(), dataObject.getValue());}}return variablesMap;}
}
ProcessInstanceHelper的createAndStartProcessInstance中用 processDefinition 的 id 查找出 Process 流程模型。
protected ProcessInstance createAndStartProcessInstance(ProcessDefinition processDefinition,String businessKey, String processInstanceName,Map<String, Object> variables, Map<String, Object> transientVariables, boolean startProcessInstance) {CommandContext commandContext = Context.getCommandContext(); // Todo: ideally, context should be passed here// Do not start process a process instance if the process definition is suspendedif (ProcessDefinitionUtil.isProcessDefinitionSuspended(processDefinition.getId())) {throw new ActivitiException("Cannot start process instance. Process definition " + processDefinition.getName() + " (id = " + processDefinition.getId() + ") is suspended");}// Get model from cache// 用 processDefinition 的 id 查找出 Process 流程模型Process process = ProcessDefinitionUtil.getProcess(processDefinition.getId());if (process == null) {throw new ActivitiException("Cannot start process instance. Process model " + processDefinition.getName() + " (id = " + processDefinition.getId() + ") could not be found");}// 獲取流程定義中的第一個節點(初始節點)FlowElement initialFlowElement = process.getInitialFlowElement();if (initialFlowElement == null) {throw new ActivitiException("No start element found for process definition " + processDefinition.getId());}return createAndStartProcessInstanceWithInitialFlowElement(processDefinition, businessKey,processInstanceName, initialFlowElement, process, variables, transientVariables, startProcessInstance);
}
在ProcessInstanceHelper的createAndStartProcessInstanceWithInitialFlowElement方法中,創建了 ExecutionEntity 流程實例,此實例的生命周期貫穿整個流程實例,從StartEvent開始,到EndEvent結束。Process流程模型就好比一條人工運河,而ExecutionEntity就是這條河流上的一條船。
public ProcessInstance createAndStartProcessInstanceWithInitialFlowElement(ProcessDefinition processDefinition,String businessKey, String processInstanceName, FlowElement initialFlowElement,Process process, Map<String, Object> variables, Map<String, Object> transientVariables, boolean startProcessInstance) {CommandContext commandContext = Context.getCommandContext();// Create the process instanceString initiatorVariableName = null;// 如果初始節點是StartEvent,就獲取 Initiatorif (initialFlowElement instanceof StartEvent) {initiatorVariableName = ((StartEvent) initialFlowElement).getInitiator();}// 創建 ExecutionEntity,后續會有很多地方用到。ExecutionEntity processInstance = commandContext.getExecutionEntityManager().createProcessInstanceExecution(processDefinition, businessKey, processDefinition.getTenantId(), initiatorVariableName);// 創建完成,記錄流程已經開始commandContext.getHistoryManager().recordProcessInstanceStart(processInstance, initialFlowElement);processInstance.setVariables(processDataObjects(process.getDataObjects()));// Set the variables passed into the start commandif (variables != null) {for (String varName : variables.keySet()) {// 把傳入的流程變量綁定到 ProcessInstance 上processInstance.setVariable(varName, variables.get(varName));}}if (transientVariables != null) {for (String varName : transientVariables.keySet()) {processInstance.setTransientVariable(varName, transientVariables.get(varName));}}// Set processInstance nameif (processInstanceName != null) {processInstance.setName(processInstanceName);commandContext.getHistoryManager().recordProcessInstanceNameChange(processInstance.getId(), processInstanceName);}// Fire eventsif (Context.getProcessEngineConfiguration().getEventDispatcher().isEnabled()) {Context.getProcessEngineConfiguration().getEventDispatcher().dispatchEvent(ActivitiEventBuilder.createEntityWithVariablesEvent(ActivitiEventType.ENTITY_INITIALIZED, processInstance, variables, false));}// Create the first execution that will visit all the process definition elements// 用父級ExecutionEntity(processInstance)創建一個子級ExecutionEntity// 后續父級ExecutionEntity(processInstance)通過getExecutions().get(0)訪問ExecutionEntity execution = commandContext.getExecutionEntityManager().createChildExecution(processInstance);// 這個 setCurrentFlowElement 操作非常重要,它表示 execution 當前活躍在哪個 FlowNode 或者 SequenceFlow 上。// execution 每到一個新的節點上,都會調用這個方法更新一下活躍的節點,在這里這個 initialFlowElement 是 StartEventexecution.setCurrentFlowElement(initialFlowElement);if (startProcessInstance) {// 已經成功啟動一個新流程,從這里流程將流向下個節點startProcessInstance(processInstance, commandContext, variables);}return processInstance;
}
ProcessInstanceHelper的startProcessInstance方法中有關于如何處理Process流程模型中含有子流程的邏輯,但這里為方便學習不做研究,知道即可。在此方法中,流程實例將通過commandContext.getAgenda().planContinueProcessOperation(execution);前往下一個節點。
public void startProcessInstance(ExecutionEntity processInstance, CommandContext commandContext, Map<String, Object> variables) {// 通過 processDefinitionId 獲取流程詳情 ProcessProcess process = ProcessDefinitionUtil.getProcess(processInstance.getProcessDefinitionId());// Event sub process handlingList<MessageEventSubscriptionEntity> messageEventSubscriptions = new LinkedList<>();for (FlowElement flowElement : process.getFlowElements()) {// 處理流程中含有子流程的審批流if (flowElement instanceof EventSubProcess) {EventSubProcess eventSubProcess = (EventSubProcess) flowElement;for (FlowElement subElement : eventSubProcess.getFlowElements()) {if (subElement instanceof StartEvent) {StartEvent startEvent = (StartEvent) subElement;if (CollectionUtil.isNotEmpty(startEvent.getEventDefinitions())) {EventDefinition eventDefinition = startEvent.getEventDefinitions().get(0);if (eventDefinition instanceof MessageEventDefinition) {MessageEventDefinition messageEventDefinition = (MessageEventDefinition) eventDefinition;BpmnModel bpmnModel = ProcessDefinitionUtil.getBpmnModel(processInstance.getProcessDefinitionId());if (bpmnModel.containsMessageId(messageEventDefinition.getMessageRef())) {messageEventDefinition.setMessageRef(bpmnModel.getMessage(messageEventDefinition.getMessageRef()).getName());}ExecutionEntity messageExecution = commandContext.getExecutionEntityManager().createChildExecution(processInstance);messageExecution.setCurrentFlowElement(startEvent);messageExecution.setEventScope(true);messageEventSubscriptions.add(commandContext.getEventSubscriptionEntityManager().insertMessageEvent(messageEventDefinition.getMessageRef(), messageExecution));}}}}}}// 取出父級ExecutionEntity(processInstance)的子executionExecutionEntity execution = processInstance.getExecutions().get(0); // There will always be one child execution created// 將通過 planContinueProcessOperation 繼續走向流程中的下一個節點。commandContext.getAgenda().planContinueProcessOperation(execution);// 分發事件if (Context.getProcessEngineConfiguration().getEventDispatcher().isEnabled()) {ActivitiEventDispatcher eventDispatcher = Context.getProcessEngineConfiguration().getEventDispatcher();// 創建并分發流程開始事件eventDispatcher.dispatchEvent(ActivitiEventBuilder.createProcessStartedEvent(execution, variables, false));for (MessageEventSubscriptionEntity messageEventSubscription : messageEventSubscriptions) {commandContext.getProcessEngineConfiguration().getEventDispatcher().dispatchEvent(ActivitiEventBuilder.createMessageEvent(ActivitiEventType.ACTIVITY_MESSAGE_WAITING, messageEventSubscription.getActivityId(),messageEventSubscription.getEventName(), null, messageEventSubscription.getExecution().getId(),messageEventSubscription.getProcessInstanceId(), messageEventSubscription.getProcessDefinitionId()));}}
}
至此,流程實例啟動完成。
后續將通過 commandContext.getAgenda().planContinueProcessOperation(execution) 流轉到下一個節點。
總結
流程啟動過程中主要涉及到命令執行器(CommandExecutor)、命令攔截器(CommandInteceptor)、流程開始命令(StartProcessInstanceCmd)、流程定義(ProcessDefinition)、流程模型(Process)以及流程實例(ProcessInstance,即ExecutionEntity),這些元素共構成了啟動一個流程實例的必需條件。
在啟動流程實例過程的源碼中,我個人感覺非常精妙的設計之處在于攔截器,得益于攔截器的使用,Activiti抽出了業務中的公共代碼(比如內置的日志記錄、CommandContext、Transaction、CommandInvoker),使得主業務與附屬業務邊界感更強,啟動過程逐漸遞進,前后邏輯順序清晰明了,源碼學習者更容易掌握業務邏輯。