activiti學習4:流程文件的部署
用bpmn規范定義好一個流程得到流程定義文件后,需要把該文件部署到activiti的數據庫后,這個流程才可以使用。
activiti中和流程定義相關的操作都需要使用RepositoryService
這個服務組件來進行。
activiti中所有的服務組件都需要通過流程引擎對象來獲取
一、RepositoryService服務組件
這個組件中提供了一系列管理流程定義和流程部署的api,我們可以使用這個組件中的api來部署流程
1.1 RepositoryService實例對象的獲取
使用流程引擎對象的實例方法processEngine.getRepositoryService();
來獲取RepositoryService
@Test
public void test1() {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
RepositoryService repositoryService = processEngine.getRepositoryService();
System.out.println(repositoryService);
}
二、流程部署信息的描述,Deployment對象
在講解如何部署流程前,我們先了解下activiti如何描述流程的部署信息。activiti用Deployment
這個接口來描述流程的部署信息,並自己提供了實現類。對應activiti數據庫中的一張表ACT_RE_DEPLOYMENT
三、流程的部署
activiti使用DeploymentBuilder這個類的對象來部署流程,從這個類的名字就可以看出它的功能,部署一個流程並返回描述這次部署信息的對象。
使用RepositoryService服務組件的對象來獲取DeploymentBuilder對象
DeploymentBuilder deploymentBuilder = repositoryService.createDeployment();
然后給這個deploymentBuilder添加要部署的流程文件的位置
deploymentBuilder.addClasspathResource("process/process.bpmn");
我這里是在resources目錄下創建了process/process.bpmn流程定義文件,所以添加了這個路徑
還可以為本次部署添加名稱和分類
deploymentBuilder.name("vacation-test").category("test");
最后執行部署
Deployment deploy = deploymentBuilder.deploy();
觀察數據庫ACT_RE_DEPLOYMENT表,會發現多了一條部署記錄。
完整的代碼為
@Test
public void test1() {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
RepositoryService repositoryService = processEngine.getRepositoryService();
DeploymentBuilder deploymentBuilder = repositoryService.createDeployment();
deploymentBuilder.addClasspathResource("process/process.bpmn");
deploymentBuilder.name("vacation-test").category("test");
Deployment deploy = deploymentBuilder.deploy();
System.out.println(deploy);
}
注意,默認情況下多次部署同一流程圖在表中會產生多條記錄,用部署時間字段用來做區分
3.1 過濾重復部署的問題
為了防止資源沒有發生變化而再次執行部署方法產生的重復部署,可以調用DeploymentBuilder的enableDuplicateFiltering()方法,這里的過濾方式是先查詢部署表,得到表中已有的部署對象集合,如果發現有一條部署記錄與將要部署的對象相同,就不會重復部署。所以部署時設置的name,category,資源名稱和內容,只要有一個不一樣就不會被過濾掉
deploymentBuilder.enableDuplicateFiltering();//設置過濾重復部署
四、部署信息的管理
activiti在DeploymentQuery
這個接口中封裝了管理部署信息的api,並自己提供了實現類,通過repositoryService服務組件來獲取其實現類對象。
DeploymentQuery deploymentQuery = repositoryService.createDeploymentQuery();
4.1 查詢部署信息
@Test
public void test2() {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
RepositoryService repositoryService = processEngine.getRepositoryService();
DeploymentQuery deploymentQuery = repositoryService.createDeploymentQuery();
//根據deploymentId查詢
String deploymentId="4201";
Deployment singleResult = deploymentQuery.deploymentId(deploymentId)
.deploymentName("vacation-test").singleResult();
System.out.println(singleResult);
}
查詢時,先給deploymentQuery對象拼接查詢條件,這里支持鏈式編程,先一個個的拼接查詢條件,最后這個
singleResult()
方法執行查詢,返回一個結果;如果根據設定的條件返回多個結果,調用singleResult()
就會拋出異常,這時需要調用返回多個結果的查詢方法list()
4.2 刪除部署信息
因為部署信息表與其他表有外鍵關聯,所以直接刪除部署表中的數據是刪不掉的,需要調用RepositoryService中的刪除方法來刪除
@Test
public void test3() {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
RepositoryService repositoryService = processEngine.getRepositoryService();
String deploymentId="4201";
boolean cascade=true;
repositoryService.deleteDeployment(deploymentId, cascade);
}
其中第2個參數cascade表示是否級聯刪除其他表的數據,直接給true就可以
五、流程定義及其管理
5.1 流程定義信息的描述
一個流程文件部署成功后,不僅會在部署表中記錄部署信息,同時也會在流程定義表act_re_procdef中添加一條流程定義信息,描述被部署的流程文件所定義的流程。
注意其中的這個KEY_字段對應的就是流程定義文件中的process節點的id,activiti開啟流程時要使用這個字段。
<process id="process" isExecutable="true">
<startEvent id="sid-26F630F1-0761-4247-8383-F63F913A310E"></startEvent>
<userTask id="usertask1" name="apply vecation" activiti:assignee="kermit"></userTask>
<sequenceFlow id="sid-85398367-B674-473A-B7AC-268635F0DF5D" sourceRef="sid-26F630F1-0761-4247-8383-F63F913A310E" targetRef="usertask1"></sequenceFlow>
<userTask id="usertask2" name="manager agree" activiti:assignee="kermit"></userTask>
<sequenceFlow id="sid-5372C6B1-7359-40AB-B0A4-3FF06F20790E" sourceRef="usertask1" targetRef="usertask2"></sequenceFlow>
<endEvent id="sid-F621C8EF-13A5-4A49-BD5B-708BFB066576"></endEvent>
<sequenceFlow id="sid-BCF9087D-36F4-4EDE-BD88-013AC74AB93A" sourceRef="usertask2" targetRef="sid-F621C8EF-13A5-4A49-BD5B-708BFB066576"></sequenceFlow>
</process>
和部署信息一樣,activiti也有一個接口來描述這張表的信息,ProcessDefinition
,並自己提供了實現類
5.2 流程定義信息的管理
activiti提供了ProcessDefinitionQuery
這個接口,在其中封裝了流程定義信息查詢相關的api。查詢對象的獲取和使用與DeploymentQuery類似。
@Test
public void test1() {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
RepositoryService repositoryService = processEngine.getRepositoryService();
ProcessDefinitionQuery processDefinitionQuery = repositoryService.createProcessDefinitionQuery();
String processDefinitionKey="process";
List<ProcessDefinition> list = processDefinitionQuery.processDefinitionKey(processDefinitionKey).list();
for (ProcessDefinition processDefinition : list) {
System.out.println(processDefinition);
}
}
六、總結
本文介紹了如何部署流程定義文件,以及對部署后生成的部署信息和流程定義信息的管理。