activiti processEngineLifecycleListener使用

1.1.1. 前言

实际开发中，有需求如下：

第一：项目启动部署的时候，我们需要监控activiti 工作流引擎是否真正的已经实例化启动了，这里说的是工作流引擎的启动，不是流程实例的启动，对此要特别说明一下。因为我们这里说的工作流引擎具体指的是ProcessEngine接口中的子类ProcessEngineImpl是否实例化，如果这个对象在项目启动的时候，没有被实例化，那肯定工作流引擎是用不成了，因为所有的xxxService肯定都没有。所有项目启动的时候监控这个对象还是很有必要的。

第二：项目停止的时候，也就是项目终止的时候，我们也要去销毁这个ProcessEngineImpl这个对象，不销毁这个对象，肯定容易引起内存泄露。

上面的两个问题，我们如何去实现呢？这就是本章我们要详细讲解的processEngineLifecycleListener的使用。

1.1.2. 配置

activiti 工作流引擎所以的配置信息都是在org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration,这个对象中配置的，当然了与spring集成的时候，就在spring配置对象中配置，配置信息如下：

1.1.2.1. 第一种方式

xml直接配置的方式，具体的配置信息如下：

<bean id="processEngineConfiguration" class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
 <property  name="processEngineLifecycleListener" ref="myProcessEngineLifecycleListener"/>
</bean>

1.1.2.2. 第二种方式

第二种方式是动态属性的配置方式，设置的属性信息如下：

@Override
public void beforeInit(
ProcessEngineConfigurationImpl processEngineConfiguration) {
DataSource dataSource = JdbcUtils.getReadDataSource();
processEngineConfiguration.setDataSource(dataSource);
processEngineConfiguration.setHistoryLevel(HistoryLevel.FULL);
processEngineConfiguration.setDbIdentityUsed(false);
//databaseSchemaUpdate
//processEngineConfiguration.setDatabaseSchemaUpdate("true");
processEngineConfiguration.setProcessEngineLifecycleListener(myProcessEngineConfigurator);
}

对于这种方式有疑问或者不会的可以参考： activiti 动态配置 activiti 监听引擎启动和初始化（高级源码篇）http://blog.csdn.net/qq_30739519/article/details/51170011

上面的两种方式，主要都是配置信息，那如何定义配置信息中的具体类呢？

1.1.2.3. ProcessEngineLifecycleListener接口说明

ProcessEngineLifecycleListener接口的具体定义如下：

public interface ProcessEngineLifecycleListener {
  //process-engine 构建的时候调用
  void onProcessEngineBuilt(ProcessEngine processEngine);
  //process-engine 关闭的时候调用
  void onProcessEngineClosed(ProcessEngine processEngine);
}

1.1.2.4. 自义类实现

上面的两种方式都需要自定义类myProcessEngineLifecycleListener，myProcessEngineLifecycleListener类的具体实现如下所示：

@Service("myProcessEngineLifecycleListener")
public class MyProcessEngineLifecycleListener  implements ProcessEngineLifecycleListener{
private final Logger log = LoggerFactory.getLogger(this.getClass());
@Override
public void onProcessEngineBuilt(ProcessEngine processEngine) {
log.debug("processEngine:onProcessEngineBuilt{}", processEngine);
System.out.println("processEngine:onProcessEngineBuilt:"+processEngine);
}
@Override
public void onProcessEngineClosed(ProcessEngine processEngine) {
log.debug("processEngine:onProcessEngineClosed{}", processEngine);
System.out.println("processEngine:onProcessEngineBuilt:"+processEngine);
}

}

这样就大功告成了，只需要在onProcessEngineBuilt()和onProcessEngineClosed()两个方法中书写自己的业务逻辑即可。

onProcessEngineBuilt():activiti 工作流引擎构建的时候执行。

onProcessEngineClosed():activiti 工作流引擎销毁的时候执行。

1.1.3. 源码解读

上面的配置生效的话，确实能实现我们需要的功能，那问题来了，activiti 工作流引擎是如何处理的呢？知其然还要知其所以然，下面我们就来看看底层是如何处理的。

主要看ProcessEngineImpl activiti 工作流引擎的核心实现类，看一下这个类的构造方法，具体实现如下：

public ProcessEngineImpl(ProcessEngineConfigurationImpl processEngineConfiguration) {

...

//获取配置文件信息，就是上面中的两种配置方式中processEngineLifecycleListener具体实现类

if (processEngineConfiguration.getProcessEngineLifecycleListener() != null) {

processEngineConfiguration.getProcessEngineLifecycleListener().onProcessEngineBuilt(this);

}

上面的代码可以清晰的看到，ctiviti 工作流引擎启动的时候实例化ProcessEngineImpl 类的时候直接触发了onProcessEngineBuilt方法.

那onProcessEngineClosed()方法在什么时候被触发呢？

很明显，要是经验丰富，对spring比较了解的朋友一下子就想到了close()方法，没错就是ProcessEngineImpl种的close()方法实现的。close()方法实现如下所示：

public void close() {

...

if (processEngineConfiguration.getProcessEngineLifecycleListener() != null) {

processEngineConfiguration.getProcessEngineLifecycleListener().onProcessEngineClosed(this);

}

...

}

上面的close()方法中确实调用了onProcessEngineClosed()方法。

ok，关于这个processEngineLifecycleListener使用，我们就详细介绍到这里。