feat(REQ-4418) - 调整 Starter 里面的配置说明

workflow-engine-api/src/main/java/cn/axzo/workflow/client/feign/bpmn/ProcessInstanceApi.java

@@ -142,6 +142,7 @@ public interface ProcessInstanceApi {
     @Operation(summary = "抄送流程实例")
     @PostMapping("/api/process/instance/carbon-copy")
     @Deprecated
+    @Manageable
     CommonResponse<Boolean> carbonCopyProcessInstance(@Validated @RequestBody BpmnProcessInstanceCarbonCopyDTO dto);
 
     /**

workflow-engine-spring-boot-starter/src/main/java/cn/axzo/workflow/starter/api/WorkflowCoreService.java

@@ -110,6 +110,7 @@ public interface WorkflowCoreService {
      * @return
      */
     @PostMapping("/api/process/activity/trigger")
+    @InvokeMode(SYNC)
     Boolean trigger(@Validated @RequestBody BpmnActivityTriggerDTO dto);
 
     /**
@@ -124,8 +125,29 @@ public interface WorkflowCoreService {
      */
     @PostMapping("/api/process/activity/assignee/set")
     @Operation(summary = "业务节点设置审批人，不支持重复调用设置审批人，需一次性传入所有审批人")
+    @InvokeMode(SYNC)
     Boolean setAssignee(@Validated @RequestBody BpmnActivitySetAssigneeDTO dto);
 
+    /**
+     * 该功能应该利用引擎的 TimerBoundaryEvent 来实现，但为了简便，先利用引擎的任务调度来实现
+     *
+     * @return
+     */
+    @PostMapping("/api/process/activity/timeout/trigger")
+    @Operation(summary = "设置指定业务节点定时继续往下执行")
+    @InvokeMode(SYNC)
+    Boolean setTimeoutTrigger(@Validated @RequestBody BpmnActivityTimeoutTriggerDTO dto);
+
+    /**
+     * 为指定业务节点设置定时回调
+     *
+     * @return
+     */
+    @PostMapping("/api/process/activity/timeout/callback")
+    @Operation(summary = "设置指定业务节点定时回调")
+    @InvokeMode(SYNC)
+    Boolean setTimeoutCallback(@Validated @RequestBody BpmnActivityTimeoutCallbackDTO dto);
+
     /**
      * 获取指定审批业务的流程表单设置，
      * @param dto
@@ -189,6 +211,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "发起人主动撤回审核,MQ 触发规则:1. 当前流程实例中现存的任务会依次触发 process-task-deleted 事件,2. 当前流程实例会触发 process-instance-cancelled 事件")
     @DeleteMapping("/api/process/instance/cancel")
+    @InvokeMode(ASYNC)
     Boolean cancelProcessInstance(@Validated @RequestBody BpmnProcessInstanceCancelDTO dto);
 
     /**
@@ -199,6 +222,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "中止流程实例")
     @DeleteMapping("/api/process/instance/abort")
+    @InvokeMode(ASYNC)
     Boolean abortProcessInstance(@Validated @RequestBody BpmnProcessInstanceAbortDTO dto);
 
     /**
@@ -209,19 +233,9 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "批量中止流程实例")
     @DeleteMapping("/api/process/instance/batch/abort")
+    @InvokeMode(ASYNC)
     BatchOperationResultVO batchAbortProcessInstance(@Validated @RequestBody List<BpmnProcessInstanceAbortDTO> dtos);
 
-    /**
-     * 抄送流程实例（未实现）
-     *
-     * @param dto
-     * @return
-     */
-    @Operation(summary = "抄送流程实例")
-    @PostMapping("/api/process/instance/carbon-copy")
-    @Deprecated
-    Boolean carbonCopyProcessInstance(@Validated @RequestBody BpmnProcessInstanceCarbonCopyDTO dto);
-
     /**
      * 获得流程实例
      *
@@ -245,6 +259,16 @@ public interface WorkflowCoreService {
     @InvokeMode(SYNC)
     Map<String, Object> getProcessVariables(@NotBlank(message = "流程实例 ID 不能为空") @RequestParam String processInstanceId, @Nullable @RequestParam(required = false) String tenantId);
 
+    /**
+     * 校验指定流程实例下,是否存在指定的审批人正处理待审批
+     *
+     * @return true 是在当前流程实例中,存在指定的审批人
+     */
+    @Operation(summary = "校验指定流程实例下,是否存在指定的审批人")
+    @PostMapping("/api/process/instance/check/approver")
+    @InvokeMode(SYNC)
+    Boolean checkInstanceApprover(@Validated @RequestBody BpmnProcessInstanceCheckApproverDTO dto);
+
     /**
      * 获取指定流程的日志
      *
@@ -329,6 +353,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "同意，MQ 触发规则:1. 当前审批任务会依次触发 process-task-completed 和 process-task-deleted 事件(如果有下一级审批,则会触发第 2.1 点中的事件,如果当前审核任务最后一级审批,则会触发第 2.2 点中的事件)，2.1. 下一级审批任务会依次触发 process-task-assigned 和 process-task-created 事件，2.2. 流程实例正常结束会触发 process-instance-completed 事件")
     @PostMapping("/api/process/task/approve")
+    @InvokeMode(ASYNC)
     Boolean approveTask(@Validated @RequestBody BpmnTaskAuditDTO dto);
 
     /**
@@ -339,6 +364,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "同意时并提交表单")
     @PostMapping("/api/process/task/form/approve")
+    @InvokeMode(ASYNC)
     Boolean approveTaskWithForm(@Validated @RequestBody BpmnTaskAuditWithFormDTO dto);
 
     /**
@@ -349,6 +375,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "批量同意")
     @PostMapping("/api/process/task/batch/approve")
+    @InvokeMode(ASYNC)
     BatchOperationResultVO batchApproveTask(@Validated @RequestBody List<BpmnTaskAuditDTO> dtos);
 
     /**
@@ -359,6 +386,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "获取当前节点可回退节点选项列表")
     @GetMapping("/api/process/task/back/optional/nodes")
+    @InvokeMode(SYNC)
     List<BpmnOptionalNodeDTO> getBackOptionalNodes(@RequestParam @NotBlank(message = "任务id不能为空") String taskId);
 
     /**
@@ -369,18 +397,9 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "回退")
     @PostMapping("/api/process/task/back")
+    @InvokeMode(ASYNC)
     Boolean backTask(@Validated @RequestBody BpmnTaskBackAuditDTO dto);
 
-    /**
-     * 用于系统内部操作，跳转到指定节点
-     *
-     * @param dto 请求参数
-     * @return 是否成功
-     */
-    @Operation(summary = "系统操作回退任务到指定节点")
-    @PostMapping("/api/process/task/system/back")
-    Boolean systemBackTask(@Validated @RequestBody BpmnNodeBackSystemOperateDTO dto);
-
     /**
      * 驳回
      *
@@ -392,6 +411,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "驳回，MQ 触发规则：1. 当前审批任务会触发 process-task-deleted 事件, 2. 当前流程实例会触发 process-instance-rejected 事件")
     @PostMapping("/api/process/task/reject")
+    @InvokeMode(ASYNC)
     Boolean rejectTask(@Validated @RequestBody BpmnTaskAuditDTO dto);
 
     /**
@@ -401,6 +421,7 @@ public interface WorkflowCoreService {
      * @return
      */
     @PostMapping("/api/process/task/batch/reject")
+    @InvokeMode(ASYNC)
     BatchOperationResultVO batchRejectTask(@Validated @RequestBody List<BpmnTaskAuditDTO> dtos);
 
     /**
@@ -411,6 +432,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "直接修改审批任务的审批人")
     @PostMapping("/api/process/task/transfer")
+    @InvokeMode(ASYNC)
     Boolean transferTask(@Validated @RequestBody BpmnTaskTransferDTO dto);
 
     /**
@@ -421,6 +443,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "批量修改审批任务的审批人")
     @PostMapping("/api/process/task/batch/transfer")
+    @InvokeMode(ASYNC)
     BatchOperationResultVO batchTransferTask(@Validated @RequestBody List<BpmnTaskTransferDTO> dtos);
 
     /**
@@ -431,6 +454,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "审批流程评论")
     @PostMapping("/api/process/task/comment")
+    @InvokeMode(ASYNC)
     Boolean commentTask(@Validated @RequestBody BpmnTaskCommentDTO dto);
 
     /**
@@ -441,6 +465,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "审批流程加签")
     @PostMapping("/api/process/task/countersign")
+    @InvokeMode(ASYNC)
     Boolean countersignTask(@Validated @RequestBody BpmnTaskCountersignDTO dto);
 
     /**
@@ -451,8 +476,20 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "重置节点审批人（提级审批）")
     @PostMapping("/api/process/task/approvers/reset")
+    @InvokeMode(ASYNC)
     Boolean resetTaskApprovers(@Validated @RequestBody BpmnTaskResetApproversDTO dto);
 
+    /**
+     * 催办
+     *
+     * @param dto
+     * @return
+     */
+    @Operation(summary = "审批流程催办")
+    @PostMapping("/api/process/task/remind")
+    @InvokeMode(SYNC)
+    Boolean remindTask(@Validated @RequestBody BpmnTaskRemindDTO dto);
+
     /**
      * 暂停流程任务,并创建机器人节点,等待业务推动
      *
@@ -461,6 +498,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "创建机器人节点, 暂停流程任务")
     @PostMapping("/api/process/task/robot/create")
+    @InvokeMode(ASYNC)
     String createRobotTask(@Validated @RequestBody BpmnRobotTaskCreateDTO dto);
 
     /**
@@ -471,6 +509,7 @@ public interface WorkflowCoreService {
      */
     @Operation(summary = "完成机器人节点, 继续流程任务")
     @PostMapping("/api/process/task/robot/complete")
+    @InvokeMode(ASYNC)
     Boolean completeRobotTask(@Validated @RequestBody BpmnRobotTaskCompleteDTO dto);
 
     /**

workflow-engine-spring-boot-starter/src/main/java/cn/axzo/workflow/starter/api/WorkflowManageService.java

@@ -202,26 +202,6 @@ public interface WorkflowManageService {
     @InvokeMode(SYNC)
     Integer batchDeleteProcessAdmin(@RequestBody List<Long> ids);
 
-    /**
-     * 该功能应该利用引擎的 TimerBoundaryEvent 来实现，但为了简便，先利用引擎的任务调度来实现
-     *
-     * @return
-     */
-    @PostMapping("/api/process/activity/timeout/trigger")
-    @Manageable
-    @Operation(summary = "设置指定业务节点定时继续往下执行")
-    Boolean setTimeoutTrigger(@Validated @RequestBody BpmnActivityTimeoutTriggerDTO dto);
-
-    /**
-     * 为指定业务节点设置定时回调
-     *
-     * @return
-     */
-    @Manageable
-    @PostMapping("/api/process/activity/timeout/callback")
-    @Operation(summary = "设置指定业务节点定时回调")
-    Boolean setTimeoutCallback(@Validated @RequestBody BpmnActivityTimeoutCallbackDTO dto);
-
     @PostMapping("/api/form/admin/form/page")
     @InvokeMode(SYNC)
     @Manageable
@@ -241,6 +221,18 @@ public interface WorkflowManageService {
     @Manageable
     Boolean superCancelProcessInstance(@Validated @RequestBody SuperBpmnProcessInstanceCancelDTO dto);
 
+    /**
+     * 抄送流程实例（未实现）
+     *
+     * @param dto
+     * @return
+     */
+    @Operation(summary = "抄送流程实例")
+    @PostMapping("/api/process/instance/carbon-copy")
+    @Deprecated
+    @Manageable
+    Boolean carbonCopyProcessInstance(@Validated @RequestBody BpmnProcessInstanceCarbonCopyDTO dto);
+
     /**
      * 查询所有的审批流
      *
@@ -321,17 +313,6 @@ public interface WorkflowManageService {
     @InvokeMode(SYNC)
     List<String> getTenantIds();
 
-    /**
-     * 校验指定流程实例下,是否存在指定的审批人正处理待审批
-     *
-     * @return true 是在当前流程实例中,存在指定的审批人
-     */
-    @Operation(summary = "校验指定流程实例下,是否存在指定的审批人")
-    @PostMapping("/api/process/instance/check/approver")
-    @Manageable
-    @InvokeMode(SYNC)
-    Boolean checkInstanceApprover(@Validated @RequestBody BpmnProcessInstanceCheckApproverDTO dto);
-
     /**
      * 查询 ExtAxProcessLog 表中审批人的冗余信息
      *
@@ -890,16 +871,15 @@ public interface WorkflowManageService {
     Void deleteVariables(@PathVariable("executionId") String executionId, @RequestParam String variableNames, @RequestParam(value = "scope", required = false) String scope);
 
     /**
-     * 催办
+     * 用于系统内部操作，跳转到指定节点
      *
-     * @param dto
-     * @return
+     * @param dto 请求参数
+     * @return 是否成功
      */
-    @Operation(summary = "审批流程催办")
-    @PostMapping("/api/process/task/remind")
+    @Operation(summary = "系统操作回退任务到指定节点")
+    @PostMapping("/api/process/task/system/back")
     @Manageable
-    @InvokeMode(SYNC)
-    Boolean remindTask(@Validated @RequestBody BpmnTaskRemindDTO dto);
+    Boolean systemBackTask(@Validated @RequestBody BpmnNodeBackSystemOperateDTO dto);
 
     /**
      * 添加附件

workflow-engine-spring-boot-starter/src/main/resources/META-INF/application.yml.demo

@@ -1,10 +1,8 @@
 workflow:
   engine:
     starter:
-      meta-feign: false # 是否开启原始 ProcessInstanceApi、ProcessTaskApi 等类似的 FeignClient，默认 false，优先 starter 提供的 coreService、manageServer。为 true 时，会为当前应用注册原始 xxxApi FeignClient
       invoke-mode: async # 调用 workflowCoreService 中方法的方式，可选值：sync、async
       join-container-group: false # 本地开发机启动时，是否将 MQ 消费者加入到集群中，默认不加入，并默认生成 GID_${spring.application.name}_workflow_engine_${spring.profiles.active}_debugging_consumer 的消费者组，该参数只对非容器环境生效
-      manageable: false # 是否可管理，默认 false， 开启后 Spring 容器中将多一个 WorkflowManageService 的 Bean，可调用受限访问接口
       enable-dlq-monitor: true # 是否启用 starter 中使用到的死信队列监控功能，仅是启动功能，未真实监控，需要配合 monitor-status = true 使用
       monitor-status: false # 应用启动后，如果该属性为 true，则真实启动监控，否则不启动
       dql-monitor-interval-in-ms: 4 * 60 * 60 * 1000 # 周期性获取死信队列监控信息的间隔时间