BPMN流程规范
前面介绍过，工作流程其实就是以XML形式定义的，这个XML定义遵循BPMN2.0规范，Activiti负责解析工作流程定义，并提供API供我们的程序操作。除此之外，Activiti也自己定义了一些非标准的规范，来简化BPMN定义。根据BPMN2.0和Activiti规范的分类，我们需要掌握以下概念：
- 启动与结束事件 StartEvent/EndEvent
- 顺序流 Sequence Flow
- 任务 Task
- 网关 Gateway
- 子流程 Subprocess
- 边界事件 Boundary Event
- 中间事件 Intermediate Event
- 监听器 Listener
要想顺利使用Activiti工作流引擎实现我们的业务功能，就必须知道如何基于以上概念定义工作流。这篇笔记我们介绍一些最常用的规范内容。
StartEvent 启动事件
启动事件定义了流程的触发条件，流程触发后会产生一个新的流程实例并按预定义的步骤运行。
StartEvent 空启动事件
最普通的启动事件就是空启动事件，它没有任何自动的触发条件，而是需要我们在Java代码中调用RuntimeService.startProcessInstanceByKey()方法手动启动流程。
空启动事件的符号是一个空心圆圈。
空启动事件的XML表示：
<startEvent id="startevent" name="Start"></startEvent>
BPMN属性：
id：流程节点的标识符name：流程节点的名字，可以为中文字符串、带空格字符串等任意形式
上述两个属性每个节点都存在，后续就不多赘述了。
Activiti扩展属性：
activiti:formKey：用于指定关联的表单数据，有关表单内容将在后续章节介绍activiti:initiator：可以用来指定一个记录启动流程人ID的变量
TimerStartEvent 定时启动事件
定时启动事件能够定义一系列和时间相关的启动触发条件，满足时间条件时触发。
下面例子定义了从2012-01-01 00:00起，每月触发一次该流程：
<startEvent id="timestartevent" name="Timer Start">
<timerEventDefinition>
<timeCycle>R1/2012-01-01T00:00/P1M</timeCycle>
</timerEventDefinition>
</startEvent>
定时启动事件接收三种类型的时间条件：
timeDate：在指定日期时间一次性启动流程timeDuration：在指定时间后启动流程timeCycle：根据参数表达式周期性启动流程
注：Activiti使用的日期时间是ISO8601格式，上面例子中，R1代表执行一次；2012-01-01T00:00代表起始时间，其中T为日期和时间的分隔；P1M表示每一个月。
ErrorStartEvent 异常启动事件
异常启动事件只能使用在事件子流程中，而且只能通过主流程抛出异常来被动触发，而不能手动触发。在主流程抛出异常结束事件后，如果异常启动事件错误码和主流程抛出的错误码匹配，对应的异常启动事件子流程会被触发并执行。
下面例子中，异常启动事件会捕获ERR_01错误并启动错误处理子流程。
<startEvent id="suberrorstartevent" name="Error start">
<errorEventDefinition errorRef="ERR_01"></errorEventDefinition>
</startEvent>
EndEvent 结束事件
结束事件标志着流程实例执行完成。
EndEvent 空结束事件
空结束事件表示不抛出任何结果，当前流程输出流成功结束，没什么需要流程引擎继续处理的了。
<endEvent id="endevent" name="End"></endEvent>
ErrorEndEvent 异常结束事件
异常结束事件必须定义抛出的错误代码，如果定义了对应错误代码的异常启动事件，它就会被启动，否则流程也和空结束事件一样彻底结束了。
下面例子定义了一个错误码为ERR_001的异常结束事件。
<endEvent id="errorendevent1" name="ErrorEnd">
<errorEventDefinition errorRef="ERR_001"></errorEventDefinition>
</endEvent>
实际上，异常结束事件一般用在子流程中，抛出的异常通过异常边界事件来捕获。
TerminateEndEvent 终止结束事件
终止结束事件可以立即终止一个流程实例（和空结束事件区别：空结束事件结束的是输出流，它可能结束的是子流程，而主流程还没结束）。
<endEvent id="terminateendevent" name="TerminateEndEvent">
<terminateEventDefinition></terminateEventDefinition>
</endEvent>
SequenceFlow 顺序流
所谓的顺序流其实就是流程图中的箭头，顺序流分为两种：
- 普通顺序流：无条件向下一步执行
- 条件顺序流：根据条件决定是否向下执行
普通顺序流定义：
<sequenceFlow id="flow1" sourceRef="startevent" targetRef="usertask1"></sequenceFlow>
条件顺序流定义：
<sequenceFlow id="flow1" sourceRef="startevent" targetRef="usertask1">
<conditionExpression xsi:type="tFormalExpression"><![CDATA[${pass == true}]]></conditionExpression>
</sequenceFlow>
条件顺序流中，需要通过UEL表达式计算逻辑值的方式，进行条件判断。因为表达式编写在XML中，所以我们需要CDATA标签来包裹。
当然，如果流程的输出流中只有一条路径，对它设置条件也是没意义的，因为如果条件不满足，流程就走不下去了。条件顺序流一般配合网关使用。
Task 任务
任务是工作流程的核心部分，Activiti中定义了很多种任务类型：
- 用户任务 UserTask
- Java任务 ServiceTask
- 脚本任务 ScriptTask
- 邮件任务 MailTask
- 手动任务 ManualTask
- 接收任务 ReceiveTask
- 规则引擎任务 BusinessRuleTask
其中，前两种是最常用的。之前例子中，我们经常使用用户任务，实际开发中，Java任务使用也比较多。
UserTask 用户任务
用户任务顾名思义，必须有系统的用户参数，比如按一个“同意”按钮，或是提交一个表单，然后，通过系统中的Java代码来触发工作流的下一步。
下面的用户任务例子中，我们将该任务指定给tom这个人来处理。
<userTask id="usertask2" name="User Task" activiti:assignee="tom"></userTask>
Activiti扩展属性：
activiti:assignee：指定任务处理人activiti:candidateUsers：指定可用的处理候选人，多个用逗号分隔activiti:candidateGroups：指定可用的处理候选用户组，多个用逗号分隔activiti:dueDate：设定任务的到期时间activiti:priority：设定用户任务的优先级
注：assignee和candidateUsers的区别，是assignee是指定让某用户处理，而candidateUsers是允许若干用户作为处理候选人，其中任何一人处理即可，处理后流程就向下流转了，而非多个人处理。
除了将用户任务指定给用户让其点一下“处理”按钮，用户任务还可以关联表单，收集一些必要的信息，有关表单关联的内容，将在后续章节介绍。
ServiceTask Java任务
Java任务可以执行一段工程中的Java代码。
下面例子，调用了com.gacfox.demo.activiti.service.MyServiceTask类。
<serviceTask id="servicetask1" name="Service Task" activiti:class="com.gacfox.demo.activiti.service.MyServiceTask"></serviceTask>
被调用的类需要实现org.activiti.engine.delegate.JavaDelegate接口。
MyServiceTask.java
package com.gacfox.demo.activiti.service;
import org.activiti.engine.delegate.DelegateExecution;
import org.activiti.engine.delegate.JavaDelegate;
public class MyServiceTask implements JavaDelegate {
@Override
public void execute(DelegateExecution execution) throws Exception {
// ...
}
}
任务多实例
工作流管理中，有个学名叫“会签”，比如一个提案需要至少三个人审核，那么审核这一步任务可以并行的让审核人员去做，满足“至少三个人审核通过”后，流程再向下流转。由于三个人审核其实是同一个任务（Task），因此这个功能可以用任务多实例实现。
多实例任务用三个横线或三个竖线表示，横线代表串行多实例，竖线代表并行多实例。
下面例子中，我们提前设置了一个流程变量assigneeList = ['tom', 'jerry', 'lucy']，表示该任务需要指定给的三个人。
<userTask id="usertask1" name="User Task" activiti:assignee="${assignee}">
<multiInstanceLoopCharacteristics isSequential="false" activiti:collection="assigneeList" activiti:elementVariable="assignee">
<completionCondition>${nrOfCompletedInstances >= 2}</completionCondition>
</multiInstanceLoopCharacteristics>
</userTask>
上面代码中，<completionCondition>指定了一个表达式，其中nrOfCompletedInstances是Activiti自带的一个变量，代表当前多实例任务中，已经完成的数量，这里我们设置三个人中有大于等于两个人完成该任务时，流程就向下流转。
BPMN属性：
isSequential：是否为串行任务
Activiti扩展属性：
activiti:collection：遍历生成多任务实例的集合activiti:elementVariable：遍历集合时存储的变量
Gateway 网关
Activiti中，网关用于控制流程的走向，可以实现流程的分支功能。Activiti定义了四种网关：
- 排他网关 ExclusiveGateway
- 并行网关 ParallelGateway
- 包容网关 InclusiveGateway
- 事件网关 EventGateway
ExclusiveGateway 排他网关
排他网关可以连接多个条件顺序流，根据判断条件来决定流程接下来的走向。“排他”顾名思义，如果后续有多个顺序流满足判断条件，也只会执行第一个。
<exclusiveGateway id="exclusivegateway1" name="Exclusive Gateway" default="flow3"></exclusiveGateway>
BPMN属性：
default：所有后续顺序流都不满足条件时，默认的顺序流
ParallelGateway 并行网关
并行网关用于将一个流程中可以并行部分拆分或合并。
- 拆分：并行执行后续顺序流
- 合并：并行顺序流在此等候，直到所有并行顺序流都执行完成
<parallelGateway id="parallelgateway1" name="Parallel Gateway"></parallelGateway>
InclusiveGateway 包容网关
包容网关既可以连接条件顺序流，也可以并行执行，和排他网关的区别是后续可以是多个顺序流并行执行。
<inclusiveGateway id="inclusivegateway1" name="Inclusive Gateway"></inclusiveGateway>
Subprocess 子流程
在实际开发中，业务流程肯定是相当复杂的，编写一个巨大复杂的流程是不合适的，因此划分子流程相当必要。Activiti中的子流程可以分为四种：
- 普通子流程 Subprocess
- 调用活动 CallActivity
- 事件子流程 EventSubprocess
- 事务子流程 TransactionSubprocess
Subprocess 普通子流程
子流程，即把一部分需要处理的流程归结到一起作为主流程的一部分，使得业务流程更加清晰。
<subProcess id="subprocess1" name="Sub Process">
<startEvent id="startevent2" name="Start"></startEvent>
<endEvent id="endevent1" name="End"></endEvent>
<userTask id="usertask2" name="User Task"></userTask>
<sequenceFlow id="flow3" sourceRef="startevent2" targetRef="usertask2"></sequenceFlow>
<sequenceFlow id="flow4" sourceRef="usertask2" targetRef="endevent1"></sequenceFlow>
</subProcess>
CallActivity 调用活动
调用活动和普通子流程不同，它能够通过流程ID调用外部流程作为当前流程的子流程，能够起到子流程复用的作用。
<callActivity id="callactivity1" name="Call activity" calledElement="errorStartProcess"></callActivity>
BPMN属性：
calledElement：外部流程的ID
Activiti扩展属性：
activiti:in：调用外部流程传入变量名activiti:out：调用外部流程结果变量名
EventSubprocess 事件子流程
事件子流程和普通子流程的区别是事件子流程只能通过事件来触发。
下面例子中，我们的流程通过异常边界事件来捕获异常，并让一个事件子流程来处理，事件子流程的启动事件是异常启动事件。
<boundaryEvent id="boundaryerror" name="Error" attachedToRef="servicetask">
<errorEventDefinition errorRef="ERR_01"></errorEventDefinition>
</boundaryEvent>
TransactionSubprocess 事务子流程
事务子流程具有ACID特性，能够保证整个子流程要么全部成功，有一个失败就全部回滚。
Boundary Event 边界事件
边界事件是一种捕获型事件，能够捕获定时器、异常等信息，然后中断当前流程，让流程转向边界事件的后续输出流。Activiti中定义了如下几种边界事件：
- 定时器边界事件 TimerBoundaryEvent
- 异常边界事件 ErrorBoundaryEvent
- 消息边界事件 MessageBoundaryEvent
- 取消边界事件 CancelBoundaryEvent
- 补偿边界事件 CompensationBoundaryEvent
- 信号边界事件 SignalBoundaryEvent
TimerBoundaryEvent 定时器边界事件
定时器边界事件可以附加在用户任务、子流程等上，在任务执行完成后开始倒计时，倒计时结束执行边界事件后续流程。
下面例子的定时器边界事件，设定了5分钟计时：
<boundaryEvent id="boundarytimer1" name="Timer" attachedToRef="usertask1" cancelActivity="true">
<timerEventDefinition>
<timeDuration>PT5M</timeDuration>
</timerEventDefinition>
</boundaryEvent>
BPMN属性：
cancelActivity：任务未处理完而触发边界事件时，是否取消原任务
ErrorBoundaryEvent 异常边界事件
异常边界事件能够捕获子流程或Java任务代码抛出的异常，这里的异常指Activiti业务异常，具有一个指定的错误码，而不是代码报错等其他情况。
异常边界事件需要指定一个错误码，比如我们可以在Java任务种手动抛出一个org.activiti.engine.delegate.BpmnError类型，并指定错误码，那么捕获对应错误码的异常边界事件就能够触发。
抛出异常的Java代码：
package com.gacfox.demo.activiti.service;
import org.activiti.engine.delegate.BpmnError;
import org.activiti.engine.delegate.DelegateExecution;
import org.activiti.engine.delegate.JavaDelegate;
public class MyServiceTask implements JavaDelegate {
@Override
public void execute(DelegateExecution execution) throws Exception {
throw new BpmnError("ERR_01");
}
}
异常边界事件定义：
<boundaryEvent id="boundaryerror" name="Error" attachedToRef="servicetask">
<errorEventDefinition errorRef="ERR_01"></errorEventDefinition>
</boundaryEvent>
CompensationBoundaryEvent 补偿边界事件
补偿边界事件用于事务子流程，用于事务执行失败，回滚时的补偿操作。
<boundaryEvent id="boundarycompensation1" name="Compensate" attachedToRef="servicetask1" cancelActivity="true">
<compensateEventDefinition></compensateEventDefinition>
</boundaryEvent>
IntermediateEvent 中间事件
中间事件分为两种：
- 中间抛出事件
- 中间捕获事件
中间抛出事件能够抛出一些信息，供中间捕获事件等节点接收。Activiti中定义了如下几种中间抛出事件：
- 信号抛出事件 SignalThrowingEvent
- 补偿抛出事件 CompensationThrowingEvent
- 空中间抛出事件 NoneThrowingEvent
中间捕获事件能够让流程“阻塞”，直到满足某一条件后，再继续执行。Activiti中定义了如下几种中间捕获事件：
- 定时器捕获事件 TimerCatchingEvent
- 信号捕获事件 SignalCatchingEvent
- 消息捕获事件 MessageCatchingEvent
信号抛出和捕获
信号抛出事件能够抛出一个信号（Signal），而信号捕获事件能够监听一个信号。
下面例子中，上方分支会抛出信号，下方分支接收到信号后，才能继续执行。
<intermediateThrowEvent id="signalintermediatethrowevent1" name="SignalThrowEvent">
<signalEventDefinition signalRef="flag"></signalEventDefinition>
</intermediateThrowEvent>
<intermediateCatchEvent id="signalintermediatecatchevent1" name="SignalCatchEvent">
<signalEventDefinition signalRef="flag"></signalEventDefinition>
</intermediateCatchEvent>
这里，我们使用的信号名为flag。
注：信号是Activiti中的一个概念，可以是全局的，也可以是流程实例局部的，用于触发事件等。
Listener 监听器
监听器是Activiti的扩展功能，相当于在工作流程的各个生命周期中插入了一些钩子函数。Activiti中监听器分为两类：
- 执行监听器：监听流程、任务、事件等启动、结束
- 用户任务监听器：监听用户任务创建、分配、完成