engine-api.md

引擎 API

JeeflowEngine

工作流引擎的核心接口，所有流程操作都通过它完成。

配置

JeeflowEngine engine = new JeeflowEngineImpl();
engine.configure(new Configuration());

方法

startProcessInstanceById

启动一个流程实例。

ProcessInstance startProcessInstanceById(
    Long defineId,           // 流程定义 ID
    String operator,          // 发起人
    FlowData args             // 启动参数（业务编号、表单数据等）
);

// 子流程版本
ProcessInstance startProcessInstanceById(
    Long defineId,
    String operator,
    FlowData args,
    Long parentId,            // 父流程实例 ID
    String parentNodeName     // 父流程节点名称
);

示例：

FlowData args = FlowData.create()
    .set(FlowConst.BUSINESS_NO, "BIZ-001")
    .set("amount", 5000)           // 表单字段
    .set(FlowConst.CC_ACTORS_START, "user5,user6");  // 启动时抄送

ProcessInstance pi = engine.startProcessInstanceById(1L, "user1", args);
System.out.println("实例 ID: " + pi.getInstanceId());

executeProcessTask

执行（审批）一个待办任务。

List<ProcessTask> executeProcessTask(
    Long processTaskId,      // 任务 ID
    String operator,          // 操作人
    FlowData args             // 提交参数
);

示例：

FlowData args = FlowData.create()
    .set(FlowConst.SUBMIT_TYPE, ProcessSubmitTypeEnum.AGREE.getCode())  // 1=同意
    .set(FlowConst.APPROVAL_COMMENT, "同意报销");

List<ProcessTask> next = engine.executeProcessTask(taskId, "leader", args);

executeAndJumpTask

执行任务并跳转到指定节点。

List<ProcessTask> executeAndJumpTask(
    Long processTaskId,
    String operator,
    FlowData args,
    String nodeName           // 目标节点名称；null=退回上一步（语义见规范「引擎操作 04 · 退回上一步」：血缘版取 task_parent_id 行、参与者＝该行办结人；本栈已于 issues/121 P2 对齐，无血缘报 20010007、canRejected 守卫不过报 20010008）
);

executeAndJumpToEnd

执行任务并跳转到结束节点（拒绝）。

List<ProcessTask> executeAndJumpToEnd(
    Long processTaskId,
    String operator,
    FlowData args
);

executeAndJumpToFirstTaskNode

执行任务并跳转到第一个任务节点（退回发起人）。

List<ProcessTask> executeAndJumpToFirstTaskNode(
    Long processTaskId,
    String operator,
    FlowData args
);

FlowData

流程数据载体，替代 Hutool Dict。

FlowData args = FlowData.create()
    .set("name", "张三")
    .set("age", 30)
    .set("active", true);

String name = args.getStr("name");       // "张三"
Integer age = args.getInt("age");        // 30
Boolean active = args.getBool("active"); // true

FlowData copy = args.copy();  // 深拷贝

FlowConst

常用常量。

常量	值	说明
BUSINESS_NO	"BUSINESS_NO"	业务编号
SUBMIT_TYPE	"submitType"	提交类型
APPROVAL_COMMENT	"tf_approvalComment"	审批意见
TRANSFER_TO	"tf_transferTo"	转办目标人（processTask/transfer 留痕）
TRANSFER_REASON	"tf_transferReason"	转办原因（processTask/transfer 留痕）
TRANSFER_HISTORY	"tf_transferHistory"	转办跨跳账本：list，每跳 append 一条 {submitType,fromActor,toActor,reason,time,operator}，只追加不覆盖；time 为 yyyy-MM-dd HH:mm:ss 字符串（跨栈同形，不用 ISO 方言）
NEXT_NODE_OPERATOR	"tf_nextNodeOperator"	下一节点执行人
FORM_DATA_PREFIX	"f_"	表单数据前缀
PROCESS_DEFINE_ID_KEY	"processDefineId"	流程定义 ID
PROCESS_TASK_ID_KEY	"processTaskId"	流程任务 ID

ProcessSubmitTypeEnum

枚举	值	说明
APPLY	0	发起申请
AGREE	1	同意
REJECT	2	拒绝
ROLLBACK	3	退回上一步
JUMP	4	跳转
ROLLBACK_TO_OPERATOR	6	退回发起人
TRANSFER	7	转办（processTask/transfer 留痕用，不走 executeProcessTask）
COUNTERSIGN_DISAGREE	20	会签拒绝（spec 07 定名；此前与 2 同为「拒绝申请」，同字典两项同名前端下拉不可区分）