wangli/workflow-engine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update(REQ-2516) - 完善业务需实现的接口的注释

Browse Source
This commit is contained in:
wangli 2024-06-03 20:51:44 +08:00
parent c7c6db4765
commit dde7e35d45
2 changed files with 28 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
workflow-engine-spring-boot-starter/src/main/java/cn/axzo/workflow/starter/listener/ProcessInstanceListener.java
View File

@ -1,5 +1,7 @@
package cn.axzo.workflow.starter.listener;
import cn.axzo.workflow.client.feign.bpmn.ProcessInstanceApi;
import cn.axzo.workflow.common.model.request.bpmn.process.BpmnProcessInstanceAbortDTO;
import cn.axzo.workflow.common.model.response.mq.ProcessInstanceDTO;
import org.springframework.core.Ordered;
@ -16,42 +18,48 @@ public interface ProcessInstanceListener extends Ordered {
*
* @param processInstanceDTO
*/
void onCreated(ProcessInstanceDTO processInstanceDTO);
void onCreated(ProcessInstanceDTO instanceDTO);
/**
* 流程实例开始运行后回调
*
* @param processInstanceDTO
*/
void onStarted(ProcessInstanceDTO processInstanceDTO);
void onStarted(ProcessInstanceDTO instanceDTO);
/**
* 流程实例被撤回后回调
* 流程实例运行完成(通过)后回调
* <p>
* 注意: 该接口表明流程已经走完正向逻辑，正向逻辑比如：通过、同意等
*
* @param processInstanceDTO
* @param instanceDTO
*/
void onCancelled(ProcessInstanceDTO processInstanceDTO);
void onCompleted(ProcessInstanceDTO instanceDTO);
/**
* 流程实例被驳回后回调
* 流程实例被“撤回”后回调
* <p>
* 撤回只有发起人能触发
*
* @param processInstanceDTO
* @param instanceDTO
*/
void onRejected(ProcessInstanceDTO processInstanceDTO);
void onCancelled(ProcessInstanceDTO instanceDTO);
/**
* 流程实例被“驳回”后回调
* <p>
* 审批过程中，有一个审批人或者有节点配置的是“自动驳回”，都能触发该事件。
*
* @param instanceDTO
*/
void onRejected(ProcessInstanceDTO instanceDTO);
/**
* 流程实例被中止后回调
*
* @param event
*/
void onAborted(ProcessInstanceDTO event);
/**
* 流程实例运行完成后回调
* <p>
* 注意: 完成只是说明流程实例已停止运行
* 一般由接入方主动触发，比如调用了 {@link ProcessInstanceApi#abortProcessInstance(BpmnProcessInstanceAbortDTO)} 方法等
*
* @param event
* @param instanceDTO
*/
void onCompleted(ProcessInstanceDTO event);
void onAborted(ProcessInstanceDTO instanceDTO);
}

7
workflow-engine-spring-boot-starter/src/main/java/cn/axzo/workflow/starter/mq/broadcast/consumer/AbstractWorkflowListener.java
View File

@ -5,7 +5,7 @@ import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.Ordered;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.stream.Collectors;
@ -20,10 +20,7 @@ public abstract class AbstractWorkflowListener<T extends Ordered> implements Wor
protected List<T> getCustomListeners() {
List<T> list = instanceListenersProvider.getIfAvailable();
if (list == null) {
list = new ArrayList<T>();
}
List<T> list = instanceListenersProvider.getIfAvailable(Collections::emptyList);
return list.stream().sorted(Comparator.comparingInt(Ordered::getOrder)).collect(Collectors.toList());
}