Liferay7 BPM门户开发之4: Activiti事件处理和监听Event handlers

事件机制从Activiti 5.15开始引入，这非常棒，他可以让你实现委托。

可以通过配置添加事件监听器，也可以通过Runtime API加入注册事件。

所有的事件参数子类型都来自org.activiti.engine.delegate.event.ActivitiEvent

包含的信息:

• type
• executionId
• processInstanceId
• processDefinitionId

事件监听

其中，JOB_EXECUTION_SUCCESS 和JOB_EXECUTION_FAILURE 是ActivitiEvent的 type 信息，即事件类型

public class MyEventListener implements ActivitiEventListener {

  @Override
  public void onEvent(ActivitiEvent event) {
    switch (event.getType()) {

      case JOB_EXECUTION_SUCCESS:
        System.out.println("A job well done!");
        break;

      case JOB_EXECUTION_FAILURE:
        System.out.println("A job has failed...");
        break;

      default:
        System.out.println("Event received: " + event.getType());
    }
  }

  @Override
  public boolean isFailOnException() {
    // The logic in the onEvent method of this listener is not critical, exceptions
    // can be ignored if logging fails...
    return false;
  }
}

org.activiti.engine.delegate.event.BaseEntityEventListener

BaseEntityEventListener 是entity-events事件监听器的基类，不需要类型检查，可以用来监听一种特定类型的实体或所有实体相关的事件：

• onCreate(..)
• onUpdate(..)
• onDelete(..)
• onEntityEvent(..)

通过配置注册事件实例

配置方法：

<bean id="processEngineConfiguration" class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
    ...
    <property name="eventListeners">
      <list>
         <bean class="org.activiti.engine.example.MyEventListener" />
      </list>
    </property>
</bean>

属性eventListeners 用来设置org.activiti.engine.delegate.event.ActivitiEventListener 的实例，注意：它是列表，可以多个。

typedEventListeners 用来设置基于事件类型分发的ActivitiEventListener 的实例：

<bean id="processEngineConfiguration" class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
    ...
    <property name="typedEventListeners">
      <map>
        <entry key="JOB_EXECUTION_SUCCESS,JOB_EXECUTION_FAILURE" >
          <list>
            <bean class="org.activiti.engine.example.MyJobEventListener" />
          </list>
        </entry>
      </map>
    </property>
</bean>

通过Runtime API注册事件实例

方法是通过RuntimeService

void addEventListener(ActivitiEventListener listenerToAdd);

void addEventListener(ActivitiEventListener listenerToAdd, ActivitiEventType... types);

void removeEventListener(ActivitiEventListener listenerToRemove);

通过流程定义注册事件实例

可以将事件监听器添加到一个特定的流程定义中，侦听器只会被调用与流程定义相关的事件，用于抛出message/signal/error 到BPMN event
而processEngineConfiguration配置的方法是全局的。
下面的例子：
第一个监听器将接收任何类型的事件，基于一个完全限定的类名称（fully-qualified class name）的监听器实现。
第二个监听器只通知当一个作业成功执行或失败时，使用已被定义在进程引擎配置的bean属性中的监听器。

<process id="testEventListeners">
  <extensionElements>
    <activiti:eventListener class="org.activiti.engine.test.MyEventListener" />
    <activiti:eventListener delegateExpression="${testEventListener}" events="JOB_EXECUTION_SUCCESS,JOB_EXECUTION_FAILURE" />
  </extensionElements>

  ...

</process>

BaseEntityEventListener 也可以注册：

entityType实体类型包含:

• attachment
• comment
• execution
• identity-link
• job
• process-instance
• process-definition
• task

<process id="testEventListeners">
  <extensionElements>
    <activiti:eventListener class="org.activiti.engine.test.MyEventListener" entityType="task" />
    <activiti:eventListener delegateExpression="${testEventListener}" events="ENTITY_CREATED" entityType="task" />
  </extensionElements>

  ...

</process>

throwing BPMN events

<process id="testEventListeners">
  <extensionElements>
    <activiti:eventListener throwEvent="signal" signalName="My signal" events="TASK_ASSIGNED" />
  </extensionElements>
</process>

<process id="testEventListeners">
  <extensionElements>
    <activiti:eventListener throwEvent="globalSignal" signalName="My signal" events="TASK_ASSIGNED" />
  </extensionElements>
</process>

<process id="testEventListeners">
  <extensionElements>
    <activiti:eventListener throwEvent="message" messageName="My message" events="TASK_ASSIGNED" />
  </extensionElements>
</process>

<process id="testEventListeners">
  <extensionElements>
    <activiti:eventListener throwEvent="error" errorCode="123" events="TASK_ASSIGNED" />
  </extensionElements>
</process>

只能通过RuntimeService 分发：

void dispatchEvent(ActivitiEvent event);

事件类型

事件名称                             描述                                                                                           事件类型