camunda之——错误事件（Error Events）

错误事件（Error Events）：

错误事件是一个被定义好的错误触发的事件

业务错误VS技术错误（Business Errors vs. Technical Errors）：

BPMN的错误是业务错误，这与技术错误是不一样的，所以它与Java的异常是不一样的

一、定义一个错误（Defining an Error）：

错误事件定义会引用一个error元素，下面就是一个error end事件的例子，引用了一个error申明：

<definitions>
  <error id="myError" errorCode="ERROR-OCCURED" name="ERROR-OCCURED"/>
  <!-- ... -->
  <process>
    <!-- ... -->
    <endEvent id="myErrorEndEvent">
      <errorEventDefinition errorRef="myError" />
    </endEvent>
  </process>
</definitions>

你可以通过抛出一个在流程中定义的错误事件来触发这个错误事件，或者通过委派给代码实现，详情见用户指南
另一种定义错误的方式是设置Java异常的类名，如下例：

<definitions>
  <error id="myException" errorCode="com.company.MyBusinessException" name="myBusinessException"/>
  <!-- ... -->
  <process>
    <!-- ... -->
    <endEvent id="myErrorEndEvent">
      <errorEventDefinition errorRef="myException" />
    </endEvent>
  </process>
</definitions>

这个异常应该只被用作业务异常，而不应该被用作技术异常

错误事件handler引用了相同的错误元素，以表明它是来捕获处理这个错误的

错误事件也可以通过camunda:errorMessage属性定义一个错误消息，来扩展错误元素，以提供有关错误的进一步信息。这个引用错误事件的定义必须指明camunda:errorMessageVariable去接收错误消息，这个错误消息也可以包含表达式。

<definitions>
  <error id="myError" errorCode="ERROR-OCCURED" name="ERROR-OCCURED"  camunda:errorMessage="Something went wrong: ${errorCause}" />
  <!-- ... -->
  <process>
    <!-- ... -->
    <endEvent id="myErrorEndEvent">
      <errorEventDefinition errorRef="myError" camunda:errorMessageVariable="err"/>
    </endEvent>
  </process>
</definitions>

当错误事件抛出的错误被捕获到，会创建一个名叫err的流程变量（process variable），用以保存解析出来的消息。

二、错误开始事件（Error Start Event）：

错误开始事件只能被用作触发一个事件子流程，它不能被用作发起一个流程实例，错误开始事件是可中断的

图1：错误开始事件

错误开始事件有三个可选属性：errorRef、camunda:errorCodeVariable和camunda:errorMessageVariable

<definitions>
  <error id="myException" errorCode="com.company.MyBusinessException" name="myBusinessException"/>
  ...
  <process>
    ...
    <subProcess id="SubProcess_1" triggeredByEvent="true">>
      <startEvent id="myErrorStartEvent">
        <errorEventDefinition errorRef="myException" camunda:errorCodeVariable="myErrorVariable" camunda:errorMessageVariable="myErrorMessageVariable" />
      </startEvent>
    ...
    </subProcess>
  ...
  </process>
</definitions>

1.如果errorRef属性被省略掉，那么任何一个错误事件发生，都会导致一个错误子流程被发起
2.camunda:errorCodeVariable可以包含一个由错误指定的错误码
3.camunda:errorMessageVariable可以包含一个由错误指定的错误消息

如果流程中设置了camunda:errorCodeVariable和camunda:errorMessageVariable属性，那么在流程中可以像获取其他变量一样获取这两个属性

三、错误结束事件（Error End Event）：

当流程执行到错误结束事件时，当前路径执行结束，并且向外抛出换一个错误，这个错误可以被匹配的中间错误边界事件（intermediate error boundary event）捕获，如果没有匹配的错误边界事件，这个执行的语义跟默认跟空结束事件的语义类似（啥也不干）

四、错误边界事件（Error Boundary Event）：

     依附于一个活动的边界上的中间捕获错误事件或者简称为错误边界事件，用于捕获定义于这个活动作用域内的错误。
     大多数场景下定义一个错误边界事件是为了包含一个子流程或者调用一个活动，作为一个子流程，会为所有包含在子流程内的活动创建一个作用域。错误会被错误结束事件抛出，这个错误会传播到它的父作用域，直到有一个匹配的错误边界事件。
     当错误事件被捕获，错误边界事件就会被销毁，也会销毁所有当前包含在子流程里的活动，流程会沿着错误边界事件所在的路径进行

图2：错误边界事件

错误边界事件时一个典型的边界事件，和其他错误事件一样，errorRef引用一个定义在process元素之外的error

<definitions>
  <error id="myError" errorCode="ERROR-OCCURED" name="name of error"/>
  <!-- ... -->
  <process>
    <!-- ... -->
    <subProcess id="mySubProcess">
      <!-- ... -->
    </subProcess>
    <boundaryEvent id="catchError" attachedToRef="mySubProcess">
      <errorEventDefinition errorRef="myError" camunda:errorCodeVariable="myErrorVariable"
        camunda:errorMessageVariable="myErrorMessageVariable" />
    </boundaryEvent>
  </process>
</definitions>

errorCode被用作匹配其他被捕获到的错误：
     1.如果errorRef被忽略掉，错误边界事件会捕获所有的错误事件，不管是什么错误的errorCode
     2.如果errorRef有，并且它引用一个存在的错误，边界事件将只会捕获定义过error code的错误
     3.如果errorCodeVariable被设置过，error code可以被提取出来用作变量
     4.如果errorMessageVariable被设置，error message可以被提取出来用作变量

五、没有处理的BPMN错误（Unhandled BPMN Error）：

如果发生的错误事件没有被定义错误边界事件，在这种情况下，默认行为是打印log日志并结束当前任务，这个行为可以通过设置enableExceptionsAfterUnhandledBpmnError属性为true来改变，如果没有处理的BPMN错误发生，一个流程引擎错误将会被抛出

六、捕获并再次抛出模式（Catch and Re-Throw Pattern）：

错误事件可以在错误开始事件中被handle，子流程可以抛出跟它handle的相同的错误到更高级的作用域里

图3：捕获并再次抛出相同的错误