Activiti 7.x 实战：用 TaskListener 实现审批流程的自动抄送与通知（Spring Boot 集成）

Activiti 7.x 实战用 TaskListener 实现审批流程的自动抄送与通知Spring Boot 集成在企业的日常运营中审批流程无处不在。从简单的请假申请到复杂的项目立项每个环节都需要高效、准确的审批机制。传统的审批流程往往依赖于人工操作不仅效率低下还容易出现遗漏和错误。而 Activiti 作为一款强大的工作流引擎为我们提供了自动化处理这些流程的能力。本文将重点介绍如何利用 Activiti 7.x 的 TaskListener 功能实现审批流程中的自动抄送与通知机制特别是在 Spring Boot 环境下的集成实践。想象这样一个场景员工提交请假申请后系统需要自动通知部门经理审批同时抄送给HR备案审批通过后系统需要自动通知申请人结果并更新相关考勤记录。这些看似简单的需求如果完全依赖人工操作不仅耗时耗力还容易出错。而通过 Activiti 的 TaskListener我们可以将这些操作自动化大大提高工作效率和准确性。1. TaskListener 基础与核心事件TaskListener 是 Activiti 提供的一个强大接口允许我们在任务生命周期的关键节点插入自定义逻辑。理解这些事件触发的时机和顺序是正确使用 TaskListener 的前提。1.1 四大核心事件解析Activiti 的 TaskListener 主要监听四种事件类型每种事件对应任务生命周期中的不同阶段create任务创建完成且所有参数设置完毕后触发。这是最常用的事件之一适合执行初始化操作。assignment任务被分配给具体人员时触发。值得注意的是assignment 事件会在 create 事件之前触发。complete任务完成但尚未从运行时数据中删除前触发。这是另一个常用事件适合执行后处理逻辑。delete任务即将被删除前触发。即使是正常完成任务completeTask也会触发此事件。重要提示assignment 事件在 create 之前触发这一设计看似违反直觉但实际上是为了确保在 create 事件触发时所有任务参数包括办理人都已经设置完成。1.2 DelegateTask 关键API在 TaskListener 的实现中我们可以通过 DelegateTask 对象访问和操作任务的各种属性。以下是一些最常用的方法// 获取任务基本信息 String taskId delegateTask.getId(); String taskName delegateTask.getName(); String assignee delegateTask.getAssignee(); // 操作任务属性 delegateTask.setPriority(80); // 设置任务优先级 delegateTask.setDueDate(new Date()); // 设置截止日期 // 管理候选人 delegateTask.addCandidateUser(user1); delegateTask.addCandidateGroup(group1);理解这些 API 的用法是构建复杂审批逻辑的基础。在实际开发中我们通常会结合流程变量Process Variables来实现更动态的控制。2. Spring Boot 集成实践将 Activiti 与 Spring Boot 集成可以充分利用 Spring 的依赖注入和事务管理能力。下面我们来看具体的集成步骤和最佳实践。2.1 基础环境配置首先在 Spring Boot 项目中添加 Activiti 依赖dependency groupIdorg.activiti/groupId artifactIdactiviti-spring-boot-starter/artifactId version7.1.0.M6/version /dependency然后配置基本的数据库和 Activiti 属性spring: datasource: url: jdbc:mysql://localhost:3306/activiti_db username: root password: password driver-class-name: com.mysql.cj.jdbc.Driver activiti: database-schema-update: true history-level: full async-executor-activate: true2.2 监听器的三种实现方式Activiti 提供了三种方式来实现 TaskListener各有适用场景类方式实现 TaskListener 接口Component public class ApprovalNotificationListener implements TaskListener { Override public void notify(DelegateTask delegateTask) { // 通知逻辑实现 } }表达式方式使用 EL 表达式activiti:taskListener eventcreate expression${notificationService.sendCreateNotification(task)}/委托表达式结合 Spring 容器activiti:taskListener eventcomplete delegateExpression${approvalCompleteListener}/对于 Spring Boot 项目推荐使用委托表达式方式因为它可以充分利用 Spring 的依赖注入功能使代码更加清晰和可测试。3. 审批流程自动抄送实现自动抄送是审批流程中常见的需求下面我们以实现请假审批流程为例详细介绍实现方法。3.1 动态确定抄送人抄送人的确定通常基于业务规则可能包括申请人的直属领导部门HR相关项目负责人流程中指定的其他相关人员我们可以通过流程变量和业务规则相结合的方式动态确定抄送人public void notify(DelegateTask delegateTask) { // 获取流程变量 String applicant (String) delegateTask.getVariable(applicant); String department (String) delegateTask.getVariable(department); // 业务规则确定抄送人 ListString ccUsers new ArrayList(); ccUsers.add(getDepartmentManager(department)); ccUsers.add(getHRForDepartment(department)); // 添加额外的抄送人如果有 if (delegateTask.hasVariable(extraCCUsers)) { ccUsers.addAll((ListString) delegateTask.getVariable(extraCCUsers)); } // 设置抄送人 delegateTask.setVariable(ccUsers, ccUsers); }3.2 多通道通知集成现代企业通常使用多种通知渠道我们需要根据接收者的偏好选择合适的通知方式。以下是一个集成邮件和企业微信通知的示例Service public class NotificationServiceImpl implements NotificationService { Autowired private JavaMailSender mailSender; Autowired private WeChatService weChatService; public void sendNotification(String userId, String message, NotificationType type) { UserPreference preference getUserPreference(userId); switch (preference.getPreferredChannel()) { case EMAIL: sendEmail(preference.getEmail(), message); break; case WECHAT: weChatService.sendMessage(preference.getWeChatId(), message); break; case BOTH: sendEmail(preference.getEmail(), message); weChatService.sendMessage(preference.getWeChatId(), message); break; } } private void sendEmail(String to, String content) { SimpleMailMessage message new SimpleMailMessage(); message.setTo(to); message.setSubject(审批流程通知); message.setText(content); mailSender.send(message); } }4. 性能优化与工程实践在实际生产环境中使用 TaskListener 时需要注意一些性能和安全方面的最佳实践。4.1 避免常见陷阱耗时操作异步化不要在监听器中直接执行耗时操作如调用外部API、复杂计算等应该使用 Activiti 的异步执行器或消息队列。// 不推荐 - 同步调用外部服务 externalService.callSlowAPI(); // 推荐 - 异步处理 Async public void handleTaskCompletion(String taskId) { // 耗时操作 }事务边界管理监听器中的操作通常在同一事务中执行失败会导致整个操作回滚。需要仔细考虑事务边界。异常处理完善的异常处理机制可以防止单个监听器失败影响整个流程。try { // 业务逻辑 } catch (BusinessException e) { // 记录业务异常不影响流程继续 log.error(Business error in listener, e); } catch (Exception e) { // 系统异常可能需要终止流程 throw new ActivitiException(Listener failed, e); }4.2 性能优化技巧批量处理当需要处理大量任务时考虑批量操作而非单个处理。// 批量添加抄送人 delegateTask.addCandidateUsers(batchUsers);缓存利用频繁访问的外部数据应该缓存。Cacheable(managers) public String getDepartmentManager(String departmentId) { // 查询数据库或外部服务 }懒加载对于可能不需要的数据采用懒加载策略。5. 实战请假审批全流程实现让我们通过一个完整的请假审批流程示例将前面介绍的概念和技术串联起来。5.1 流程定义首先定义一个简单的请假审批流程BPMNprocess idleaveApproval name请假审批流程 startEvent idstart/ userTask idapplyLeave name申请请假 extensionElements activiti:taskListener eventcreate delegateExpression${leaveApplyListener}/ /extensionElements /userTask userTask idmanagerApproval name经理审批 extensionElements activiti:taskListener eventcomplete delegateExpression${managerApprovalListener}/ /extensionElements /userTask endEvent idend/ sequenceFlow sourceRefstart targetRefapplyLeave/ sequenceFlow sourceRefapplyLeave targetRefmanagerApproval/ sequenceFlow sourceRefmanagerApproval targetRefend/ /process5.2 监听器实现实现申请和审批两个关键监听器Component(leaveApplyListener) public class LeaveApplyListener implements TaskListener { Autowired private NotificationService notificationService; Override public void notify(DelegateTask delegateTask) { // 设置默认审批人直属经理 String applicant (String) delegateTask.getVariable(applicant); String manager getManager(applicant); delegateTask.setAssignee(manager); // 设置抄送人HR ListString ccUsers Collections.singletonList(getDepartmentHR(applicant)); delegateTask.setVariable(ccUsers, ccUsers); // 发送通知 notificationService.notifyManager(manager, applicant); } } Component(managerApprovalListener) public class ManagerApprovalListener implements TaskListener { Override public void notify(DelegateTask delegateTask) { boolean approved (boolean) delegateTask.getVariable(approved); String applicant (String) delegateTask.getVariable(applicant); if (approved) { // 审批通过更新考勤系统 updateAttendanceSystem(applicant, delegateTask.getVariable(leaveDays)); } // 无论是否通过都通知申请人 notifyApplicant(applicant, approved); } }5.3 流程测试与调试编写测试用例验证流程SpringBootTest public class LeaveApprovalTest { Autowired private RuntimeService runtimeService; Test public void testLeaveApprovalProcess() { MapString, Object variables new HashMap(); variables.put(applicant, employee1); variables.put(leaveDays, 3); ProcessInstance instance runtimeService .startProcessInstanceByKey(leaveApproval, variables); // 模拟经理审批 Task task taskService.createTaskQuery() .processInstanceId(instance.getId()) .singleResult(); MapString, Object approvalVars new HashMap(); approvalVars.put(approved, true); taskService.complete(task.getId(), approvalVars); // 验证流程结束 assertThat(runtimeService.createProcessInstanceQuery() .processInstanceId(instance.getId()) .count()).isEqualTo(0); } }在实际项目中除了单元测试外还应该考虑集成测试和端到端测试确保整个流程在各种场景下都能正常工作。