前言
項目中需要用到工作流引擎來設計部分業務流程,架構選型最終選擇了 Camunda7,關于 Camunda以及 Activity 等其他工作流 引擎的介紹及對比不再介紹,這裡隻介紹與現有Springboot項目的內建以及具體使用及配置
概念
- 流程(PROCESS): 通過工具模組化最終生成的BPMN檔案,裡面有整個流程的定義
- 流程執行個體(Instance):流程啟動後的執行個體
- 流程變量(Variables):流程任務之間傳遞的參數
- 任務(TASK):流程中定義的每一個節點
- 流程部署:将之前流程定義的.bpmn檔案部署到工作流平台
核心元件
- Process Engine-流程引擎
- Web Applicatons- 基于web的管理頁面
API介紹
官方文檔
https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-engine-api/
下面是官網的一些文檔,有時間可以看看,下面說一些核心的東西。
ProcessEngine
為流程引擎,可以通過他擷取相關service,裡面內建了很多相關service,預設實作如下:
RepositoryService
此服務提供用于管理和操作部署和流程定義的操作,使用camunda的第一要務
RuntimeService
運作相關,啟動流程執行個體、删除、搜尋等
TaskService
所有圍繞任務相關的操作,如完成、分發、認領等
HistoryService
提供引擎搜集的曆史資料服務
IdentityService
使用者相關,實際中用不太到
Springboot內建
依賴內建
maven
https://mvnrepository.com/search?q=org.camunda.bpm.springboot
可以根據需要引用版本,我這邊用的是 7.18
需要3個maven依賴,分别是對應 流程引擎、Web管理平台、提供rest api操作接口包
<dependency>
<groupId>org.camunda.bpm.springboot</groupId>
<artifactId>camunda-bpm-spring-boot-starter</artifactId>
<version>7.18.0</version>
</dependency>
<dependency>
<groupId>org.camunda.bpm.springboot</groupId>
<artifactId>camunda-bpm-spring-boot-starter-rest</artifactId>
<version>7.18.0</version>
</dependency>
<dependency>
<groupId>org.camunda.bpm.springboot</groupId>
<artifactId>camunda-bpm-spring-boot-starter-webapp</artifactId>
<version>7.18.0</version>
</dependency>
資料庫
我這邊使用的是mysql,建了個新庫 camunda(可自定義),啟動後會自動生成所需表結構
POM檔案
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>camunda-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>camunda-demo</name>
<description>camunda-demo</description>
<properties>
<java.version>17</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.camunda.bpm.springboot</groupId>
<artifactId>camunda-bpm-spring-boot-starter</artifactId>
<version>7.18.0</version>
</dependency>
<dependency>
<groupId>org.camunda.bpm.springboot</groupId>
<artifactId>camunda-bpm-spring-boot-starter-rest</artifactId>
<version>7.18.0</version>
</dependency>
<dependency>
<groupId>org.camunda.bpm.springboot</groupId>
<artifactId>camunda-bpm-spring-boot-starter-webapp</artifactId>
<version>7.18.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.32</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
application.yml
server:
port: 8081
# camunda登入資訊配置
camunda.bpm:
admin-user:
id: admin #使用者名
password: 123456 #密碼
firstName: yu
filter:
create: All tasks
# mysql連接配接資訊
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:8101/camunda
username: root
password: 123456
type: com.mysql.cj.jdbc.MysqlDataSource
啟動效果
準備好前置工作,啟動後效果如下:
資料庫表結構
啟動後自動生成的表結構如下
大概有這麼幾個表子產品,重要的詳細介紹下:
- ACT_ID_
這部分表示使用者子產品,配置檔案裡面的使用者,資訊就在此子產品
- ACT_HI_
表示流程曆史記錄
- act_hi_actinst: 執行的活動曆史
- act_hi_taskinst:執行任務曆史
- act_hi_procinst:執行流程執行個體曆史
- act_hi_varinst:流程變量曆史表
- ACT_RE_
表示流程資源存儲
- act_re_procdef:流程定義存儲
- act_re_deployment: 自動部署,springboot每次啟動都會重新部署,生成記錄
- ACT_RU_
表示流程運作時表資料,流程結束後會删除
- act_ru_execution:運作時流程執行個體
- act_ru_task:運作時的任務
- act_ru_variable:運作時的流程變量
- ACT_GE_
流程通用資料
- act_ge_bytearray:每次部署的檔案2進制資料,是以如果檔案修改後,重新開機也沒用,因為重新生成了記錄,需要清掉資料庫,或者這個表記錄
登入界面
登入位址為 http://localhost:8081/,輸入使用者名密碼即為配置檔案裡面的 admin,123456
主要制台
登陸成功後,如下所示,具體的使用在下面介紹
具體業務內建
繪制流程圖
下載下傳
首先需要一個工具 Camunda Modeler 來畫,下載下傳位址:
https://camunda.com/download/modeler/
解壓縮後打開如下:
繪制
建立一個
我這邊稍微畫了一個,具體怎麼畫,就不在細說了,最後效果如下,模拟了個OA的流程
任務分類
隻介紹最常用的兩種
- 使用者任務 (User Task)
具體來說就是需要手動執行的任務,即需要我們這變寫完業務代碼後,調用代碼
taskService.complete(taskId, variables);
才會完成的任務
- 系統任務(Service Task)
系統會自動幫我們完成的任務
網關
分為這麼幾類,會根據我們傳入的流程變量及設定的條件走
- 排他網關(exclusive gateway)
這個網關隻會走一個,我們走到這個網關時,會從上到下找第一個符合條件的任務往下走
- 并行網關(Parallel Gateway)
這個網關不需要設定條件,會走所有的任務
- 包含網關(Inclusive Gateway)
這個網關會走一個或者多個符合條件的任務
示例
如上圖包含網關,需要在網關的連線初設定表達式 condition,參數來自于流程變量
兩個參數:
switch2d 、 switch3d
- 如果 都為true,則走任務1,3
- 如果 switch2d 為true switch3d為false,則隻走任務1
- 如果 switch3d 為true switch2d為false,則隻走任務3
- 如果都為false,則直接走網關,然後結束
引入項目
将畫好的流程圖儲存檔案為 test_1.bpmn,在剛才的springboot項目中resources建立一個bpmn檔案夾,放進去,
重新開機項目,發現web界面中已經被內建進來了
具體開發
寫幾個測試controller和service
controller
service
public void startProcess() {
ProcessInstance instance = runtimeService.startProcessInstanceByKey("key");
System.out.println(instance.toString());
}
public List<ProcessDefinition> findProcesses() {
return repositoryService.createProcessDefinitionQuery().list();
}
public List<Task> findTasks() {
return taskService.createTaskQuery().list();
}
啟動流程成功,說明問題不大,接下來詳細業務改進。
下一篇介紹詳細的業務內建及各種API(變量傳遞、自動任務)的使用
API使用
流程相關API
建立流程:
會同時建立第一個任務
ProcessInstance instance = runtimeService.startProcessInstanceByKey(processKey, params);
暫停流程
流程暫停後,再執行相關任務會報錯,需要先重新激活任務
runtimeService.suspendProcessInstanceById(instance.getId());
重新激活流程
runtimeService.activateProcessInstanceById(instance.getId());
删除流程
會同時删除任務
runtimeService.deleteProcessInstance(instance.getId(), "手動删除");
以上都可以在流程曆史表 act_hi_procinst 裡查詢
任務相關API
基于service的查詢類,都可先建構一個 query,然後在附上查詢條件,執行個體幾個
List<ProcessDefinition> list = repositoryService.createProcessDefinitionQuery().list();
List<Task> list = taskService.createTaskQuery().taskAssignee("zhangsan").list();
List<ProcessInstance> instances = runtimeService.createProcessInstanceQuery().listPage(1, 10);
查詢曆史任務
List<HistoricProcessInstance> list = historyService.createHistoricProcessInstanceQuery().list();
查詢目前任務/分頁
List<Task> list = taskService.createTaskQuery().orderByTaskCreateTime().desc().list();
任務回退
大體思路是拿到目前的任務,及目前任務的上一個曆史任務,然後重新開機
代碼示例
Task activeTask = taskService.createTaskQuery()
.taskId(taskId)
.active()
.singleResult();
List<HistoricTaskInstance> historicTaskInstance = historyService.createHistoricTaskInstanceQuery()
.processInstanceId(instanceId)
.orderByHistoricActivityInstanceStartTime()
.desc()
.list();
List<HistoricTaskInstance> historicTaskInstances = historicTaskInstance.stream().filter(v -> !v.getTaskDefinitionKey().equals(activeTask.getTaskDefinitionKey())).toList();
Assert.notEmpty(historicTaskInstances, "目前已是初始任務!");
HistoricTaskInstance curr = historicTaskInstances.get(0);
runtimeService.createProcessInstanceModification(instanceId)
.cancelAllForActivity(activeTask.getTaskDefinitionKey())
.setAnnotation("重新執行")
.startBeforeActivity(curr.getTaskDefinitionKey())
.execute();
流程變量
包括流程中産生的變量資訊,包括控制流程流轉的變量,網關、業務表單中填寫的流程需要用到的變量等。很多地方都要用到
流程變量變量傳遞
變量最終會存在 act_ru_variable 這個表裡面
在繪制流程圖的時候,如果是使用者任務(userService) 可以設定變量,比如執行人,
寫法有這麼幾種方式
- 寫死,就比如 zhangsan
- 表達式,比如上面寫的 ${user},這種需要傳入參數,其實就是啟動參數的時候傳入,傳入參數,可選值為一個Map<String, Object>,之後的流程可檢視次參數,上面寫的是 user, 是以map裡面的key需要帶着user,不然會報錯。
關于擴充變量,可在流程圖繪制這麼設定,傳遞方式還是一樣,流程圖裡面在下面寫:
代碼:
ProcessInstance instance = runtimeService.startProcessInstanceByKey(key, new HashMap<>());
變量設定
runtimeService.setVariable(instance.getId(), Constants.PATIENT_ID, relatedId);
變量查詢
Object variable = runtimeService.getVariable(instance.getId(), Constants.GENERAL_ID);
曆史變量查詢
HistoricVariableInstance variableInstance = historyService.createHistoricVariableInstanceQuery().processInstanceId(bo.getId().toString()).
variableName(Constants.PATIENT_ID).singleResult();
//變量值
variableInstance.getValue();
//變量名稱
variableInstance.getName();
針對後端來說任務類型主要有兩種。
使用者任務-userTask
即需要使用者參與的任務,因為工作流執行過程中需要涉及到審批、過審之類的需要使用者參與的任務,這個時候需要使用者參與,然後調用接口完成任務。
服務任務-serviceTask
即自動執行的任務,比如使用者送出後,系統自動存儲、修改狀态等自動完成的任務。
Type
任務類型是關鍵,可根據配型配置實作調用 java的方法,spring 的bean方法,等等有這麼幾種類型
推薦使用 -- Delegate Expression !!!
在系統任務中,因為是自動執行,是以實際應用中需要嵌入各種業務邏輯,可以在流程圖設計中,按照下面方式調用java代碼執行,在spring中配置同名的bean
配置表達式,可以實作JavaDelegate接口使用類名配置,快捷寫法如下,比較推薦下面這種,此種可靈活配置bean和spring結合使用,注入service等業務方法
@Bean("t17")
JavaDelegate t17() {
return execution -> {
Map<String, Object> variables = execution.getVariables();
Task task = taskService.createTaskQuery().processInstanceId(execution.getProcessInstanceId()).singleResult();
//業務邏輯
task.setOwner(String.valueOf(dentistId));
};
}
Java Class :
配置java類名,需要實作JavaDelegate接口,注意是全路徑名,不可以使用Spring的bean配置!!!
@Component
public class T17Delegate implements JavaDelegate {
@Override
public void execute(DelegateExecution execution) throws Exception {
String taskId = execution.getId();
String instanceId = execution.getProcessInstanceId();
Map<String, Object> variables = execution.getVariables();
}
}
下面兩種可使用spring的配置
Expression:
EL表達式,調用java類的方法 ,規範:
expression=“#{monitorExecution.execution(execution)}”
@Component("monitorExecution")
public class MonitorExecution {
public void execution(DelegateExecution execution){
String processInstanceId = execution.getProcessInstanceId();
}
}
任務監聽器 - Task Listener
任務監聽器用于在某個與任務相關的事件發生時執行自定義Java邏輯或表達式。它隻能作為使用者任務的子元素添加到流程定義中。
請注意,這也必須作為BPMN 2.0擴充元素的子級和Camunda命名空間中發生,因為任務偵聽器是專門為Camunda引擎建構的。
适用場景:
@Bean
TaskListener t21() {
return delegateTask -> {
String taskId = delegateTask.getId();
String instanceId = delegateTask.getProcessInstanceId();
Map<String, Object> variables = delegateTask.getVariables();
// TODO: 20log/3/22
delegateTask.setVariable("", "");
};
}
執行監聽器 - Execution Listener
執行偵聽器在流程執行過程中發生某些事件時執行外部Java代碼或計算表達式。可以用在任何任務中,可以捕獲的事件有:
- 流程執行個體的開始和結束。
- 進行過渡。
- 活動的開始和結束。
- 網關的開始和結束。
- 中間事件的開始和結束。
- 結束開始事件或開始結束事件
适用場景:每個任務結束時設定任務進度
public class ExampleExecutionListenerOne implements ExecutionListener {
public void notify(DelegateExecution execution) throws Exception {
execution.setVariable("variableSetInExecutionListener", "firstValue");
execution.setVariable("eventReceived", execution.getEventName());
}
}
擴充屬性- Extension properties
擴充屬性适用于很多自定義的業務屬性,比如設定業務流程進度
流程權限及建立人設定
IdentityService為鑒權相關服務,但是我們實際開發中,一般會用到我們自己的鑒權系統,是以可以使用camunda提供的api來設定,具體可以看IdentityServiceImpl這個類,其中也是使用了ThreadLocal來儲存鑒權資訊 ,代碼在下面
private ThreadLocal<Authentication> currentAuthentication = new ThreadLocal<Authentication>();
使用者資訊設定:
// Userutil是我們自己封裝的使用者工具類
identityService.setAuthenticatedUserId(UserUtil.getUserId().toString());
//擷取
Authentication authentication = identityService.getCurrentAuthentication();
他内置很多比如開啟流程時候,會預設找目前登入的人,這個類DefaultHistoryEventProducer
// set super process instance id
ExecutionEntity superExecution = executionEntity.getSuperExecution();
if (superExecution != null) {
evt.setSuperProcessInstanceId(superExecution.getProcessInstanceId());
}
//state
evt.setState(HistoricProcessInstance.STATE_ACTIVE);
// set start user Id
evt.setStartUserId(Context.getCommandContext().getAuthenticatedUserId());
任務執行人及發起人設定
//根據任務id設定執行人
taskService.setAssignee(task.getId(), UserUtil.getUserId().toString());
來源:blog.csdn.net/yu619251940/article/details/129670382