Fixflow引擎解析(四)(模型) - 通過EMF擴展BPMN2.0元素

Fixflow引擎解析(四)(模型) - 通過EMF擴展BPMN2.0元素

Fixflow引擎解析(三)(模型) - 創建EMF模型來讀寫XML文件

Fixflow引擎解析(二)(模型) - BPMN2.0讀寫

Fixflow引擎解析(一)(介紹) - Fixflow開源流程引擎介紹

我們在第一章中介紹了怎么通過EMF讀寫BPMN2.0官方元素，

第三章中介紹了怎么建立一個簡單的EMF模型來讀寫XML，

在這章里邊我們介紹下怎么給BPMN2.0模型注入擴展元素。

 

1.為什么需要擴展

由於BPMN2.0官方提供的標准不能滿足一個引擎需要運行起來的所需的一些元素,所有各個基於BPMN2.0標准的廠商都對BPMN2.0標准進行了自己的擴展。

例如:

activiti引擎的擴展都是以"activiti:"開頭的

<serviceTask id="javaService" 
    name="Java service invocation" 
    activiti:class="org.activiti.examples.bpmn.servicetask.ToUpperCaseFieldInjected">
    <extensionElements>
      <activiti:field name="text" stringValue="Hello World" />
  </extensionElements>           
</serviceTask>   

fixflow引擎的擴展都是以"fixflow:"開頭的

 <bpmn2:userTask id="UserTask_1" fixflow:taskType="FIXFLOWTASK" name="人工任務">
      <bpmn2:extensionElements>
        <fixflow:assignPolicyType id="potentialOwner"/>
        <fixflow:skipStrategy/>
        <fixflow:taskCommand id="HandleCommand_3" name="提交" commandType="submit"/>
        <fixflow:expectedExecutionTime/>
        <fixflow:formUri>
          <fixflow:expression xsi:type="fixflow:Expression" id="Expression_3">DemoServlet?action=startOneTask</fixflow:expression>
        </fixflow:formUri>
      </bpmn2:extensionElements>
      <bpmn2:incoming>SequenceFlow_1</bpmn2:incoming>
      <bpmn2:outgoing>SequenceFlow_3</bpmn2:outgoing>
      <bpmn2:potentialOwner id="PotentialOwner_1" fixflow:resourceType="user" fixflow:includeExclusion="INCLUDE"name="所有人">
        <bpmn2:resourceAssignmentExpression id="ResourceAssignmentExpression_1">
          <bpmn2:formalExpression id="所有人">&quot;fixflow_allusers&quot;</bpmn2:formalExpression>
        </bpmn2:resourceAssignmentExpression>
      </bpmn2:potentialOwner>
 </bpmn2:userTask>

 每個引擎的廠商都會對BPMN2.0官方元素做出擴展,這就導致了流程定義雖然可以在不同的流程產品相互顯示,但是想運行起來是不可能的。

 

2.BPMN2.0官方關於擴展元素的支持

可以看到BPMN2.0官方已經提供了擴展元素的存放位置:

  <bpmn2:userTask id="UserTask_1" fixflow:taskType="FIXFLOWTASK" name="人工任務">
      <bpmn2:extensionElements>
        <fixflow:assignPolicyType id="potentialOwner"/>
        <fixflow:skipStrategy/>
      </bpmn2:extensionElements>
  </bpmn2:userTask>

"extensionElements" 元素內就用來存放各個廠商自己擴展的元素,"fixflow:"開頭的 attribute 就是官網元素本身的屬性擴展,

官方也是清楚的,他們給的那點肯定是不夠用的,所以就有了上面的擴展,3.0出來了肯定會提供更多支持。

 

3.擴展 BPMN2.0 EMF模型的思路

Fixflow在讀寫BPMN2.0模型的時候使用了Eclipse官方提供的EMF模型，擴展元素的最好的方式就是不修改原始Eclipse提供的模型，

采用外部注入的方式修改給EMF模型添加新的元素。我們需要重新建立一個EMF模型來放置Fixflow引擎自己擴展的元素定義，

通過EMF提供的注入方法添加到元素的模型保存中去，下面我們一步步來完成這個過程。

 

4.創建一個EMF模型

這里我們不再詳細介紹創建模型文件的過程，不清楚的請參考第三章創建模型。

下面的截圖是 fixflow 的擴展元素模型:

 

這個擴展模型有些需要注意的地方，模型 整體的 Ns Prefix 和 Ns URI  這個兩個屬性決定了你擴展元素的名稱和命名空間。

 

 

Attributes 的設置需要注意的事項。

 

 

 

EReference 引用設置需要主要的地方。

 

 

 

創建完畢生成三個模型文件，並生成對應java代碼。

 

5.讀寫擴展元素

下面的代碼就是在web環境下讀寫BPMN2.0模型擴展元素的代碼：

模型文件下載地址:  SampleProcess.bpmn.7z

import java.util.List;

import org.eclipse.bpmn2.BaseElement;
import org.eclipse.bpmn2.Bpmn2Factory;
import org.eclipse.bpmn2.Bpmn2Package;
import org.eclipse.bpmn2.Definitions;
import org.eclipse.bpmn2.ExtensionAttributeValue;
import org.eclipse.bpmn2.RootElement;
import org.eclipse.bpmn2.di.BpmnDiPackage;
import org.eclipse.bpmn2.util.Bpmn2ResourceFactoryImpl;
import org.eclipse.dd.dc.DcPackage;
import org.eclipse.dd.di.DiPackage;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.impl.EStructuralFeatureImpl.SimpleFeatureMapEntry;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
import org.eclipse.emf.ecore.util.FeatureMap;

import com.founder.fix.bpmn2extensions.fixflow.ConnectorInstance;
import com.founder.fix.bpmn2extensions.fixflow.FixFlowFactory;
import com.founder.fix.bpmn2extensions.fixflow.FixFlowPackage;


public class test {

    public static void main(String[] args) {
        //創建資源集
        ResourceSet resourceSet = getResourceSet();
        //創建資源
        Resource resource = resourceSet.createResource(URI.createURI("SampleProcess.bpmn"));
        
        
        try {
            //加載資源
            resource.load(null);
        } catch (Exception e) {
            e.printStackTrace();
        }
        //獲取根元素
        Definitions definitions = (Definitions) resource.getContents().get(0).eContents().get(0);
        //獲取process對象
        org.eclipse.bpmn2.Process process=null;
        for (RootElement rootElement : definitions.getRootElements()) {
            if (rootElement instanceof org.eclipse.bpmn2.Process) {
                process = (org.eclipse.bpmn2.Process) rootElement;                
            }
        }
        
        if(process==null){
            return;
        }
        
        //設置擴展 EAttribute fixflow:dbid
        process.eSet(FixFlowPackage.Literals.DOCUMENT_ROOT__DBID, "SampleProcess_1");
        //讀取擴展 EAttribute fixflow:dbid
        process.eGet(FixFlowPackage.Literals.DOCUMENT_ROOT__DBID);
        
        
        ConnectorInstance connectorInstance=FixFlowFactory.eINSTANCE.createConnectorInstance();
        //添加擴展元素
        addExtensionElement(process,FixFlowPackage.Literals.DOCUMENT_ROOT__CONNECTOR_INSTANCE,connectorInstance);
        //讀取擴展元素
        getExtensionElementList(ConnectorInstance.class,process,FixFlowPackage.Literals.DOCUMENT_ROOT__CONNECTOR_INSTANCE);
        

    }
    
    /**
     * 創建資源集
     * @return
     */
    private static ResourceSet getResourceSet() {
        
        //以下的方式是脫離Eclipse環境在web下使用EMF的時候使用的方式,Eclipse里使用要簡單的多。
        
        ResourceSet resourceSet = new ResourceSetImpl();
        (EPackage.Registry.INSTANCE).put("http://www.omg.org/spec/BPMN/20100524/MODEL", Bpmn2Package.eINSTANCE);
        //注意這里的注冊沒有這個注冊是沒有辦法通過直接獲取擴展元素的
        (EPackage.Registry.INSTANCE).put("http://www.founderfix.com/fixflow", FixFlowPackage.eINSTANCE);
        (EPackage.Registry.INSTANCE).put("http://www.omg.org/spec/DD/20100524/DI", DiPackage.eINSTANCE);
        (EPackage.Registry.INSTANCE).put("http://www.omg.org/spec/DD/20100524/DC", DcPackage.eINSTANCE);
        (EPackage.Registry.INSTANCE).put("http://www.omg.org/spec/BPMN/20100524/DI", BpmnDiPackage.eINSTANCE);
        FixFlowPackage.eINSTANCE.eClass();
        FixFlowPackage xxxPackage = FixFlowPackage.eINSTANCE;
        EPackage.Registry.INSTANCE.put(xxxPackage.getNsURI(), xxxPackage);
        Bpmn2ResourceFactoryImpl ddd = new Bpmn2ResourceFactoryImpl();
        //注意這里的注冊沒有這個注冊是沒有辦法通過直接獲取擴展元素的
        Resource.Factory.Registry.INSTANCE.getExtensionToFactoryMap().put("fixflow", ddd);
        resourceSet.getResourceFactoryRegistry().getExtensionToFactoryMap().put("bpmn", ddd);
        resourceSet.getPackageRegistry().put(xxxPackage.getNsURI(), xxxPackage);
        Resource.Factory.Registry.INSTANCE.getExtensionToFactoryMap().put("bpmn", ddd);
        return resourceSet;
    }
    
    /**
     * 讀取擴展元素 Element
     * @param t 擴展元素的java類型
     * @param baseElement 主元素
     * @param eReference 引用
     * @return
     */
    @SuppressWarnings("unchecked")
    public static <T> List<T> getExtensionElementList( Class<T> t ,BaseElement baseElement,EReference eReference){
        
        //BPMN2.0官方定義每個BaseElement元素都含有擴展元素ExtensionValues
        if (baseElement.getExtensionValues().size() > 0) {
            for (ExtensionAttributeValue extensionAttributeValue : baseElement.getExtensionValues()) {
                FeatureMap extensionElements = extensionAttributeValue.getValue();
                Object objectElement = extensionElements.get(eReference, true);
                if (objectElement != null) {

                    List<T> tObjList = (List<T>) objectElement;
                    return tObjList;
                

                }
            }
        }
        
        
        return (List<T>)null;
    }
    
    /**
     * 添加擴展元素
     * @param baseElement 主元素
     * @param eReference 引用
     * @param o 擴展元素對象
     * @return
     */
    public static boolean addExtensionElement(BaseElement baseElement,EReference eReference,Object o){
        final FeatureMap.Entry extensionElementEntry = new SimpleFeatureMapEntry((org.eclipse.emf.ecore.EStructuralFeature.Internal) eReference, o);
            if(baseElement.getExtensionValues().size() > 0){
                baseElement.getExtensionValues().get(0).getValue().add(extensionElementEntry);
            }else{
                ExtensionAttributeValue extensionElement = Bpmn2Factory.eINSTANCE.createExtensionAttributeValue();
                extensionElement.getValue().add(extensionElementEntry);
                baseElement.getExtensionValues().add(extensionElement);
            } 
        return false;
    }

}