引子
在之前写的《activiti之事件日志》一文中讲到，通过配置enableDatabaseEventLogging属性可以达到事件触发后，自动保存相关日志对象。这里面的实现原理就是本文要讨论的内容。当一个事件触发后，会由已经注册好的监听器去监听到这个事件，然后在监听器内部去实现相关逻辑。
配置监听器Listener
- eventListeners 监听所有的事件
- typedEventListeners 监听指定事件类型的事件
- activiti:EventListener 只监听特定流程定义的事件
相关类
- ActivitiEvent 事件对象类
- ActivitiEventListener 事件监听器类
- ActivitiEventType 事件类型(枚举类型)
示例
首先编写一个监听器类来监听流程启动事件,它继承于ActivitiEventListener。
public class ProcessEventListener implements ActivitiEventListener {
private static final Logger logger = LoggerFactory.getLogger(HelloWorld.class);
public void onEvent(ActivitiEvent event) {
ActivitiEventType eventType = event.getType();
if(ActivitiEventType.ACTIVITY_STARTED.equals(eventType)){
logger.info("流程启动");
}
}
public boolean isFailOnException() {
return false;
}
}
另外配置activiti.cfg.xml文件：
<bean id="processEngineConfiguration" class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/db_activiti" />
<property name="jdbcDriver" value="com.mysql.jdbc.Driver" />
<property name="jdbcUsername" value="root" />
<property name="jdbcPassword" value="abc123" />
<property name="eventListeners">
<list>
<bean class="com.activiti.event.ProcessEventListener"></bean>
</list>
</property>
</bean>
将自己写的监听器类配置上去后，启动流程后，就回打印出我们想要的“流程启动”了。
上述配置方式监听的是所有的事件，如果想要监听特定的事件，需要配置如下：
<bean id="processEngineConfiguration" class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/db_activiti" />
<property name="jdbcDriver" value="com.mysql.jdbc.Driver" />
<property name="jdbcUsername" value="root" />
<property name="jdbcPassword" value="abc123" />
<property name="typedEventListeners">
<map>
<entry key="PROCESS_STARTED">
<list>
<bean class="com.activiti.event.ProcessEventListener"></bean>
</list>
</entry>
</map>
</property>
</bean>
这样流程启动后同样也能监听并打印日志了。
自定义事件监听和发布
之前的事件都是activiti自带的事件，如何自定义事件，并且监听和发布呢？实现如下：
runtimeService.addEventListener(new ProcessEventListener());
runtimeService.dispatchEvent(new ActivitiEventImpl(ActivitiEventType.CUSTOM));
即首先发布事件监听器，这里这个ProcessEventListener监听器监听所有事件，然后发布自定义事件。这样就能自己监听自己发布的事件了。
之前我们定义的监听器继承于ActivitiEventListener接口，实现了onEvent方法，自己去判断事件类型，进行相应处理，这里再介绍一下工作流内部提供的实现类BaseEntityEventListener，这个类重写了ActivitiEventListener接口的onEvent方法：
@Override
public final void onEvent(ActivitiEvent event) {
if (isValidEvent(event)) {
// Check if this event
if (event.getType() == ActivitiEventType.ENTITY_CREATED) {
onCreate(event);
} else if (event.getType() == ActivitiEventType.ENTITY_INITIALIZED) {
onInitialized(event);
} else if (event.getType() == ActivitiEventType.ENTITY_DELETED) {
onDelete(event);
} else if (event.getType() == ActivitiEventType.ENTITY_UPDATED) {
onUpdate(event);
} else {
// Entity-specific event
onEntityEvent(event);
}
}
}
protected void onCreate(ActivitiEvent event) {
// Default implementation is a NO-OP
}
......
所以如果只是用到基本的监听事件，也可以继承BaseEntityEventListener这个类，复写它的onCreate等方法来实现监听，会更加方便。
