activiti processEngineLifecycleListener使用

Posted 2020-11-01 llguanli

1.1.1.?前言

实际开发中。有需求例如以下：

第一：项目启动部署的时候。我们须要监控activiti 工作流引擎是否真正的已经实例化启动了，这里说的是工作流引擎的启动。不是流程实例的启动。对此要特别说明一下。

由于我们这里说的工作流引擎详细指的是ProcessEngine接口中的子类ProcessEngineImpl是否实例化。假设这个对象在项目启动的时候，没有被实例化，那肯定工作流引擎是用不成了，由于全部的xxxService肯定都没有。全部项目启动的时候监控这个对象还是非常有必要的。

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

上面的两个问题。我们怎样去实现呢？这就是本章我们要详细解说的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使用，我们就详细介绍到这里。