【Camunda】SpringBoot優雅集成Camunda 7工作流引擎，保姆級教程！

From: https://mp.weixin.qq.com/s/lZmIucZYzqqwjBCtDAL9WA

前言

項目中需要用到工作流引擎來設計部分業務流程，框架選型最終選擇了 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（可自定義），啓動後會自動生成所需表結構

推薦程序員摸魚地址：

https://www.yoodb.com/slack-off/home.html

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());