Springboot項目的集成以及具體使用及配置

概念

核心組件

API介紹

Springboot集成

具體業務集成

API使用

前言

項目中需要用到工作流引擎來設計部分業務流程，框架選型最終選擇了 Camunda7，關于 Camunda以及 Activity 等其他工作流 引擎的介紹及對比不再介紹，這里只介紹與現有Springboot項目的集成以及具體使用及配置

基于 Spring Boot + MyBatis Plus + Vue & Element 實現的后臺管理系統 + 用戶小程序，支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能

項目地址：https://github.com/YunaiV/ruoyi-vue-pro

視頻教程：https://doc.iocoder.cn/video/

概念

流程（PROCESS） : 通過工具建模最終生成的BPMN文件，里面有整個流程的定義

流程實例（Instance） ：流程啟動后的實例

流程變量（Variables） ：流程任務之間傳遞的參數

任務（TASK） ：流程中定義的每一個節點

流程部署 ：將之前流程定義的.bpmn文件部署到工作流平臺

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實現的后臺管理系統 + 用戶小程序，支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能

項目地址：https://github.com/YunaiV/yudao-cloud

視頻教程：https://doc.iocoder.cn/video/

核心組件

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操作接口包

org.camunda.bpm.springboot
camunda-bpm-spring-boot-starter
7.18.0


org.camunda.bpm.springboot
camunda-bpm-spring-boot-starter-rest
7.18.0


org.camunda.bpm.springboot
camunda-bpm-spring-boot-starter-webapp
7.18.0

數據庫

我這邊使用的是mysql，建了個新庫 camunda（可自定義），啟動后會自動生成所需表結構

POM文件

4.0.0

org.springframework.boot
spring-boot-starter-parent
2.7.3
 

com.example
camunda-demo
0.0.1-SNAPSHOT
camunda-demo
camunda-demo


17




org.springframework.boot
spring-boot-starter


org.camunda.bpm.springboot
camunda-bpm-spring-boot-starter
7.18.0


org.camunda.bpm.springboot
camunda-bpm-spring-boot-starter-rest
7.18.0


org.camunda.bpm.springboot
camunda-bpm-spring-boot-starter-webapp
7.18.0


mysql
mysql-connector-java
8.0.32


org.springframework.boot
spring-boot-starter-test
test







org.springframework.boot
spring-boot-maven-plugin

application.yml

server:
port:8081


#camunda登錄信息配置
camunda.bpm:
admin-user:
id:admin#用戶名
password:123456#密碼
firstName:yu
filter:
create:Alltasks

#mysql連接信息
spring:
datasource:
driver-class-name:com.mysql.cj.jdbc.Driver
url:jdbc//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

publicvoidstartProcess(){
ProcessInstanceinstance=runtimeService.startProcessInstanceByKey("key");
System.out.println(instance.toString());
}

publicListfindProcesses(){
returnrepositoryService.createProcessDefinitionQuery().list();
}

publicListfindTasks(){
returntaskService.createTaskQuery().list();
}

啟動流程成功，說明問題不大，接下來詳細業務改進。

下一篇介紹詳細的業務集成及各種API（變量傳遞、自動任務）的使用

API使用

流程相關API

創建流程：

會同時創建第一個任務

ProcessInstanceinstance=runtimeService.startProcessInstanceByKey(processKey,params);

暫停流程

流程暫停后，再執行相關任務會報錯，需要先重新激活任務

runtimeService.suspendProcessInstanceById(instance.getId());

重新激活流程

runtimeService.activateProcessInstanceById(instance.getId());

刪除流程

會同時刪除任務

runtimeService.deleteProcessInstance(instance.getId(),"手動刪除");

以上都可以在流程歷史表 act_hi_procinst 里查詢

任務相關API

基于service的查詢類，都可先構建一個 query，然后在附上查詢條件，實例幾個

Listlist=repositoryService.createProcessDefinitionQuery().list();
Listlist=taskService.createTaskQuery().taskAssignee("zhangsan").list();
Listinstances=runtimeService.createProcessInstanceQuery().listPage(1,10);

查詢歷史任務

Listlist=historyService.createHistoricProcessInstanceQuery().list();

查詢當前任務/分頁

Listlist=taskService.createTaskQuery().orderByTaskCreateTime().desc().list();

任務回退

大體思路是拿到當前的任務，及當前任務的上一個歷史任務，然后重啟

代碼示例

TaskactiveTask=taskService.createTaskQuery()
.taskId(taskId)
.active()
.singleResult();
ListhistoricTaskInstance=historyService.createHistoricTaskInstanceQuery()
.processInstanceId(instanceId)
.orderByHistoricActivityInstanceStartTime()
.desc()
.list();

ListhistoricTaskInstances=historicTaskInstance.stream().filter(v->!v.getTaskDefinitionKey().equals(activeTask.getTaskDefinitionKey())).toList();

Assert.notEmpty(historicTaskInstances,"當前已是初始任務！");
HistoricTaskInstancecurr=historicTaskInstances.get(0);

runtimeService.createProcessInstanceModification(instanceId)
.cancelAllForActivity(activeTask.getTaskDefinitionKey())
.setAnnotation("重新執行")
.startBeforeActivity(curr.getTaskDefinitionKey())
.execute();

流程變量

包括流程中產生的變量信息，包括控制流程流轉的變量，網關、業務表單中填寫的流程需要用到的變量等。很多地方都要用到

流程變量變量傳遞

變量最終會存在 act_ru_variable 這個表里面

在繪制流程圖的時候，如果是用戶任務（userService） 可以設置變量，比如執行人，

寫法有這么幾種方式

寫死，就比如 zhangsan

表達式，比如上面寫的 ${user}，這種需要傳入參數，其實就是啟動參數的時候傳入，傳入參數，可選值為一個Map，之后的流程可查看次參數，上面寫的是 user， 所以map里面的key需要帶著user，不然會報錯。

關于擴展變量，可在流程圖繪制這么設定，傳遞方式還是一樣，流程圖里面在下面寫：

代碼：

ProcessInstanceinstance=runtimeService.startProcessInstanceByKey(key,newHashMap<>());

變量設置

runtimeService.setVariable(instance.getId(),Constants.PATIENT_ID,relatedId);

變量查詢

Objectvariable=runtimeService.getVariable(instance.getId(),Constants.GENERAL_ID);

歷史變量查詢

HistoricVariableInstancevariableInstance=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")
JavaDelegatet17(){
returnexecution->{
Mapvariables=execution.getVariables();
Tasktask=taskService.createTaskQuery().processInstanceId(execution.getProcessInstanceId()).singleResult();
//業務邏輯
task.setOwner(String.valueOf(dentistId));
};
}

Java Class ：

配置java類名，需要實現JavaDelegate接口，注意是全路徑名，不可以使用Spring的bean配置?。?！

@Component
publicclassT17DelegateimplementsJavaDelegate{

@Override
publicvoidexecute(DelegateExecutionexecution)throwsException{
StringtaskId=execution.getId();
StringinstanceId=execution.getProcessInstanceId();
Mapvariables=execution.getVariables();
}
}

下面兩種可使用spring的配置

Expression：

EL表達式，調用java類的方法 ，規范：

expression=“#{monitorExecution.execution(execution)}”
@Component("monitorExecution")
publicclassMonitorExecution{
publicvoidexecution(DelegateExecutionexecution){
StringprocessInstanceId=execution.getProcessInstanceId();
}
}

任務監聽器 - Task Listener

任務監聽器用于在某個與任務相關的事件發生時執行自定義Java邏輯或表達式。它只能作為用戶任務的子元素添加到流程定義中。

請注意，這也必須作為BPMN 2.0擴展元素的子級和Camunda命名空間中發生，因為任務偵聽器是專門為Camunda引擎構建的。

適用場景：

@Bean
TaskListenert21(){
returndelegateTask->{

StringtaskId=delegateTask.getId();
StringinstanceId=delegateTask.getProcessInstanceId();

Mapvariables=delegateTask.getVariables();
//TODO:20log/3/22
delegateTask.setVariable("","");
};
}

執行監聽器 - Execution Listener

執行偵聽器在流程執行過程中發生某些事件時執行外部Java代碼或計算表達式?？梢杂迷谌魏稳蝿罩?，可以捕獲的事件有：

流程實例的開始和結束。

進行過渡。

活動的開始和結束。

網關的開始和結束。

中間事件的開始和結束。

結束開始事件或開始結束事件

適用場景：每個任務結束時設置任務進度

publicclassExampleExecutionListenerOneimplementsExecutionListener{

publicvoidnotify(DelegateExecutionexecution)throwsException{
execution.setVariable("variableSetInExecutionListener","firstValue");
execution.setVariable("eventReceived",execution.getEventName());
}
}

擴展屬性- Extension properties

擴展屬性適用于很多自定義的業務屬性，比如設置業務流程進度

流程權限及創建人設置

IdentityService為鑒權相關服務，但是我們實際開發中，一般會用到我們自己的鑒權系統，所以可以使用camunda提供的api來設置，具體可以看IdentityServiceImpl這個類，其中也是使用了ThreadLocal來保存鑒權信息 ，代碼在下面

privateThreadLocalcurrentAuthentication=newThreadLocal();

用戶信息設置：

//Userutil是我們自己封裝的用戶工具類
identityService.setAuthenticatedUserId(UserUtil.getUserId().toString());

//獲取
Authenticationauthentication=identityService.getCurrentAuthentication();

他內置很多比如開啟流程時候，會默認找當前登錄的人，這個類DefaultHistoryEventProducer

//setsuperprocessinstanceid
ExecutionEntitysuperExecution=executionEntity.getSuperExecution();
if(superExecution!=null){
evt.setSuperProcessInstanceId(superExecution.getProcessInstanceId());
}

//state
evt.setState(HistoricProcessInstance.STATE_ACTIVE);

//setstartuserId
evt.setStartUserId(Context.getCommandContext().getAuthenticatedUserId());

任務執行人及發起人設置

//根據任務id設置執行人
taskService.setAssignee(task.getId(),UserUtil.getUserId().toString());