1、核心类
Flowable 引擎通过 ProcessEngine
作为总入口点,提供了多个核心服务接口,每个服务都负责特定的功能领域:
服务名称 (Service Name) | 主要功能 (Main Functionality) | 关键操作 (Key Operations) |
---|---|---|
RepositoryService | 管理流程定义和部署(存储和检索流程定义资源) | 部署流程定义、查询流程定义、暂停/激活流程定义 |
RuntimeService | 管理流程实例和执行(启动流程实例、管理流程变量、触发继续操作) | 启动流程实例、设置/获取流程变量、查询流程实例和执行 |
TaskService | 管理用户任务(查询、认领、完成、删除任务) | 查询任务、认领任务、完成任务、设置任务变量 |
HistoryService | 访问历史数据(查询已完成的流程实例、任务、活动实例等) | 查询历史流程实例、历史任务、历史活动细节 |
IdentityService | 管理用户和组(创建、查询、删除用户和组信息) | 创建用户/组、查询用户/组、建立用户与组的关系 |
ManagementService | 提供引擎管理和维护功能(查询数据库表、管理作业) | 查询数据库表信息、管理作业(如定时器) |
FormService | 管理表单数据(可选服务,处理开始表单和任务表单数据) | 获取开始表单数据、提交任务表单数据 |
DynamicBpmnService | 动态修改流程定义(无需重新部署即可更新流程元素属性) | 修改用户任务办理人、修改服务任务类名、更新顺序流条件 |
2、常用Api
1、流程定义
ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery().processDefinitionKey("leave_approval").latestVersion().singleResult();
2、流程实例
ProcessInstance processInstance = runtimeService.startProcessInstanceById(processDefinition.getId());
3、部署单元
Deployment deployment = repositoryService.createDeployment().addClasspathResource("process/performance.bpmn20.xml").name("绩效流程").category("HR").deploy();
4、启动流程实例
Map<String, Object> variables = new HashMap<>();
variables.put("employee", "张三");
variables.put("nrOfHolidays", 5);
variables.put("description", "年假申请");ProcessInstance processInstance = runtimeService.startProcessInstanceByKey(processDefinitionKey, variables);processInstance.getId();
5、查询用户任务
// 查询任务
taskService.createTaskQuery().taskAssignee(assignee).orderByTaskCreateTime().desc().list();// 完成任务
taskService.complete(taskId);
6、历史数据查询
List<HistoricProcessInstance> historicProcessInstances = historyService.createHistoricProcessInstanceQuery().finished().orderByProcessInstanceEndTime().desc().list();
7、JavaDelegate 实现服务任务
/*** 请假审批服务任务*/
public class LeaveApprovalServiceTask implements JavaDelegate {@Overridepublic void execute(DelegateExecution execution) {// 从流程变量中获取数据String employee = (String) execution.getVariable("employee");Integer nrOfHolidays = (Integer) execution.getVariable("nrOfHolidays");String description = (String) execution.getVariable("description");// 执行业务逻辑,例如发送邮件、调用外部系统等boolean approved = approveLeaveRequest(employee, nrOfHolidays, description);// 设置审批结果流程变量execution.setVariable("approved", approved);System.out.println("请假申请审批完成: " + approved);}private boolean approveLeaveRequest(String employee, int nrOfHolidays, String reason) {// 这里实现具体的审批逻辑// 示例简单规则:请假天数小于7天自动批准return nrOfHolidays <= 7;}
}
8、TaskListener
事件类型 (Event Type) | 触发时机说明 | 典型应用场景 |
---|---|---|
create | 当任务已经创建,并且所有任务参数都已经设置完成后触发。 | 动态设置任务的办理人、候选人或候选组。 |
assignment | 当任务已经指派给某个办理人后触发。注意:此事件在 create 事件之前被触发。 | 记录任务分配信息,或向被指派者发送通知。 |
complete | 当任务已经完成(审批通过或拒绝),但尚未从运行时数据中删除时触发。 | 根据任务结果更新业务状态,执行后续业务操作。 |
delete | 在任务被删除之前触发。 | 清理与任务相关的资源或状态。 |
xml配置
<userTask id="user_approval_task" name="用户审批任务" flowable:formKey="approval_form"><extensionElements><!-- 使用 delegateExpression 来引用Spring容器中的Bean --><flowable:taskListener event="create" delegateExpression="${dynamicAssigneeListener}"/></extensionElements>
</userTask
/*** 动态设置任务办理人的监听器示例* 使用 @Component 注解,并指定 Bean 名称(与流程定义中的 delegateExpression 对应)*/
@Component("dynamicAssigneeListener") // 这个值需要与流程XML中的delegateExpression一致
public class DynamicAssigneeListener implements TaskListener {@Overridepublic void notify(DelegateTask delegateTask) {// 1. 获取当前任务的事件类型String eventName = delegateTask.getEventName();System.out.println("任务监听器被触发,事件类型: " + eventName);// 2. 通常我们只在 create 事件中设置办理人if (TaskListener.EVENTNAME_CREATE.equals(eventName)) {// 3. 这里是你的业务逻辑:根据流程变量、组织架构等动态决定办理人// 例如,从流程变量中获取预先设置的办理人String assignee = (String) delegateTask.getVariable("assignee"); // 来自流程变量的办理人// 4. 如果变量中存在办理人,则设置;否则可以设置一个默认值或根据其他逻辑获取if (assignee != null && !assignee.isEmpty()) {delegateTask.setAssignee(assignee);} else {// 示例:默认指派给特定用户(实际项目中请替换为你的逻辑)String defaultAssignee = "*****"; // 默认办理人delegateTask.setAssignee(defaultAssignee);}}}
}
9、网关
- 排他网关ExclusiveGateway
有多个条件入口,最终只能有一个条件出口,每个条件之间是竞争关系,只要有一个条件成立就会流转到下一个节点。
- 并行网关ParallelGateway
必须网关中的每个任务都完成,才会进入下一个节点。
- 包容网关InclusiveGateway
排他网关和并行网关的结合体
- 事件网关 EventGateway
根据事件(如消息事件、信号事件等)来决定流程的走向。它不会计算条件,而是等待事件的发生。每个出口都是中间捕获事件
3、核心表
通用数据表(2个)
历史表(8个,HistoryService接口操作的表)
用户相关表(4个,IdentityService接口操作的表)
流程定义、流程模板相关表(3个,RepositoryService接口操作的表)
流程运行时表(6个,RuntimeService接口操作的表)
1、Flowable的所有数据库表都以ACT_开头
2、ACT_RE_: 'RE’代表repository。带有这个前缀的表包含“静态”信息,例如流程定义与流程资源(图片、规则等)。
3、ACT_RU_: 'RU’代表runtime。这些表存储运行时信息,例如流程实例(process instance)、用户任务(user task)、变量(variable)、作业(job)等。Flowable只在流程实例运行中保存运行时数据,并在流程实例结束时删除记录。这样保证运行时表小和快。
4、ACT_HI_: 'HI’代表history。这些表存储历史数据,例如已完成的流程实例、变量、任务等。
5、ACT_GE_: 通用数据。在多处使用。act_ge_bytearray:二进制数据表,如流程定义、流程模板、流程图的字节流文件;
act_ge_property:属性数据表# HistoryService
act_hi_actinst:历史节点表,存放流程实例运转的各个节点信息(包含开始、结束等非任务节点);
act_hi_attachment:历史附件表,存放历史节点上传的附件信息(不常用);
act_hi_comment:历史意见表;
act_hi_detail:历史详情表,存储节点运转的一些信息(不常用);
act_hi_identitylink:历史流程人员表,存储流程各节点候选、办理人员信息,常用于查询某人或部门的已办任务;
act_hi_procinst:历史流程实例表,存储流程实例历史数据(包含正在运行的流程实例);
act_hi_taskinst:历史流程任务表,存储历史任务节点;
act_hi_varinst:流程历史变量表,存储流程历史节点的变量信息;# IdentityService
act_id_group:用户组信息表,对应节点选定候选组信息;
act_id_info:用户扩展信息表,存储用户扩展信息;
act_id_membership:用户与用户组关系表;
act_id_user:用户信息表,对应节点选定办理人或候选人信息;# RepositoryService
act_re_deployment:部属信息表,存储流程定义、模板部署信息;
act_re_procdef:流程定义信息表,存储流程定义相关描述信息,但其真正内容存储在act_ge_bytearray表中,以字节形式存储;
act_re_model:流程模板信息表,存储流程模板相关描述信息,但其真正内容存储在act_ge_bytearray表中,以字节形式存储;# RuntimeService
act_ru_task:运行时流程任务节点表,存储运行中流程的任务节点信息,重要,常用于查询人员或部门的待办任务时使用;
act_ru_event_subscr:监听信息表,不常用;
act_ru_execution:运行时流程执行实例表,记录运行中流程运行的各个分支信息(当没有子流程时,其数据与act_ru_task表数据是一一对应的);
act_ru_identitylink:运行时流程人员表,重要,常用于查询人员或部门的待办任务时使用;
act_ru_job:运行时定时任务数据表,存储流程的定时任务信息;
act_ru_variable:运行时流程变量数据表,存储运行中的流程各节点的变量信息;