osworkflow初始化分析

转载请说明出处。该文档的版权属于http://zstzah.blog.bokee.net

该文档原始地址

本文档内容完全取之我对osworkflow2.7.0源代码的理解，因此在阅读的时候请参照源代码。文档的撰写是以配置XMLWorkflowFactory上，使用jdbc持久化的基础上整理。如果你不熟悉osworkflow代码结构，在阅读该文档前请务必先阅读<oswrkflow代码结构>。文档的撰写是在我从来没有接触osworkflow的前提下，难免有错误，请指正。

1、 osworkflow的初始化：

通常osworkflow将在流程第一次实例化的时候来初始化流程模型等资源，当然也可以进行扩展，让容器在启动的时候来初始化基本的信息。

在AbstractWorkflow中的initialize方法中有这么几行代码：

 

        WorkflowDescriptor wf = getConfiguration().getWorkflow(workflowName);

        WorkflowStore store = getPersistence();

        WorkflowEntry entry = store.createEntry(workflowName);

 

 WorkflowDescriptor wf = getConfiguration().getWorkflow(workflowName);

//这行代码其实包含的内容很多，最初的getConfiguration()，获取了Configuration对象，在AbstractWorkflow中返回的是DefaultConfiguration，引擎将在系统首次访问流程数据的时候初始化持久信息，以及流程工厂对象。它负责全部的流程“静态”信息，这些静态信息将被插入到一个map中，包括装载流程配置信息，设置workflow descriptor factory,也对workflow descriptor factory的调用进行了代理。

//在getWorkflow(workflowName)中，使用了Configuration的具体实现类获取了指定名称对应的模型静态对象，事实上是一个WorkflowConfig对象，通常情况下这个对象是XMLWorkflowFactory的inner class， XMLWorkflowFactory会依据配置文件中的流程模型列表生成的模型对象map中获取. WorkflowConfig这个内部类记录了一个模型文件的静态信息，包括最后修改时间，位置，路径，以及模型文件对应的逻辑类WorkflowDescriptor，这个字段，在WorkflowConfig最初被创建的时候并不进行初始，通常会在第一次获取一个模型对应的实例时被初始化，如果在流程工厂结点中设置了reload为true的参数，那么在这个流程模版被修改的时候将再一次被重新初始化。这个XMLWorkflowFactory使用的是典型的flyweight(享元)模式，这个模式无疑会提高系统效率。

 该文档原始地址

WorkflowStore store = getPersistence(); //获取流程数据的操作类，在实际的使用中它通常是一个数据库操作的封装，ejb，hibernate, 或者jdbc等

WorkflowEntry entry = store.createEntry(workflowName);//这里就是依据模型名称，来激活一个流程实例,在实际的系统中，我们通常是将一条数据插入到数据库，代表一个被激活的流程

 

我们再来看看这个initialize方法的三个参数：

workflowName (String)，initialAction(int)，inputs(Map)`

 

workflowName: 无疑是一个流程模型的名称，这个事实上是配置文件中配置的xml模型文件的别名，如下面代码中的simple

 

<workflows>

    <workflow name="simple" type="resource" location="oswk/test/config/simple.xml"/>

</workflows>

 

 

 

 

 

 

 

initialAction: xml模型文件中的action元素的id属性.光从字面上理解，通常是<initial-actions>元素中的一个<action>元素是id属性

 该文档原始地址

inputs: 可以利用这个map来传递其他的一些参数信息，完成更丰富的流程控制。

 

 

再往下走，我们会看见这么一段代码：

        populateTransientMap(entry,               //一个流程实例

                      transientVars,

                      wf.getRegisters(),

                      new Integer(initialAction), //用来初始化流程的action编号

                      Collections.EMPTY_LIST);  

这段代码在一个实例运行的时候起到了非常重要的作用，在一个流程实例状态和数据发生改变的时候，这段代码就会被调用。我们可以在getAvailableActions，getSecurityPermissions，canInitialize，doAction，executeTriggerFunction，initialize，getAvailableAutoActions这些方法中看到它的存在。

看看这个方法体的参数：entry，这个参数是模型的实例的信息对象，这个对象记录了一个模型实例的基本信息，包括模型名称、是否初始化、目前的状态、代表这个实例的标识。JDBCWorkflowStore中调用的是SimpleWorkflowEntry，那么标识就是数据库中的唯一ID。transientVars，这个参数其实是一个容器，它存放了全部和流程实例相关的一些数据，包括用户传递的参数(如果你在代码中传递了initialize方法的第三个参数)、调用者信息、模型实例对象、持久化封装对象、模型信息对象(将模型信息的文件格式变成结构对象)、存在的actionId、所在的currentSteps等等。我们来看这段代码：

        if (inputs != null) {

            transientVars.putAll(inputs);

        }

这段代码的含义非常的明了， initialize方法中inputs参数是可选的，如果传递了，这些参数将被保存到transientVars中

2、 DefaultConfiguration分析：我们再来看看这个类在系统中的类图结构

 

 

 很显然，这个类实现了Configuration接口，这个接口定义的方法，是一些完成获取流程模型的基本方法。如下我们详细解释关键接口的用处

1、isInitalized()：这个接口很明显，它标记osworkflow配置文件是否已经初始化的接口。系统会在实例化一个流程的时候去调用它，以确认已经初始化.

2、getPersistence()、setPersistence()这两个接口是对持久化类的类路径进行设定和获取。这个类被配置在osworkflow.xml文件中的 <persistence>元素的class属性中。

3、getPersistenceArgs()这个接口是获取了持久化信息的map，从配置文件中读出来，存放到这个map中，这个map的信息是从<persistence>元素的子元素中读取的，一堆

<property key="" value=""/>元素

4、getWorkflowStore()这个接口，获取被实例化的持久化类对象。这个对象完成了流程模型实例的持久化操作。

5、load()这个方法将osworkflow.xml文件加载进来，其中将模型信息进行对象化，存放在内存。然后让一个工厂类来负责管理它们。

6、removeWorkflow()，saveWorkflow()接口，其中removeWorkflow()方法在

XMLWorkflowFactory中，这个方法是无效的，没有实现，调用它的时候会抛出异常。saveWorkflow()方法在XMLWorkflowFactory中的实现是也对一个已经存在的流程进行修改，然后保存的过程。现在我还没有发现osworkflow有实现了对新建流程的保存。

 该文档原始地址

3、 XMLWorkflowFactory分析：我们也来看看这个类在系统中的类图结构：

 

首先，在超类中实现了两个方法

    protected Properties properties = new Properties();

    /**

     * Get the configuration properties of this factory

     */

    public Properties getProperties() {

        return properties;

    }

    public final void init(Properties p) {

        this.properties = p;

    }

 

这个两个方法其实很简单，在DefaultConfiguration的load()方法中会调用其中的init()来完成持久化信息配置的properties的传递。

先看看getWorkflow(String workflowname)这个接口，这个接口在XMLWorkflowFactory中实现的是首先获取一个内部类，这个内部类中保存了一个descriptor对象，在最初的时候，已经在DefaultConfiguration调用了initDone()方法完成了这个工作(参见本文挡的1、osworkflow的初始化)。在这里，这个descriptor对象就真正的被实例化了，之所以这样设计，首先是为了提高效率，同时也为流程模型的修改热载入提供了支持。