feat(bpm): 待办任务站内信实时推送

gaoluyang

6 天以前 c55aca77e84607238c3354168a8642176c575ca1

 yudao-module-bpm/src/main/java/cn/iocoder/yudao/module/bpm/service/message/BpmMessageServiceImpl.java

@@ -1,23 +1,25 @@
package cn.iocoder.yudao.module.bpm.service.message;

import cn.iocoder.yudao.framework.web.config.WebProperties;
import cn.iocoder.yudao.module.bpm.convert.message.BpmMessageConvert;
import cn.iocoder.yudao.module.bpm.enums.message.BpmMessageEnum;
import cn.hutool.core.util.StrUtil;
import cn.iocoder.yudao.module.bpm.service.message.dto.BpmMessageSendWhenProcessInstanceApproveReqDTO;
import cn.iocoder.yudao.module.bpm.service.message.dto.BpmMessageSendWhenProcessInstanceRejectReqDTO;
import cn.iocoder.yudao.module.bpm.service.message.dto.BpmMessageSendWhenTaskCreatedReqDTO;
import cn.iocoder.yudao.module.bpm.service.message.dto.BpmMessageSendWhenTaskTimeoutReqDTO;
import cn.iocoder.yudao.module.system.api.sms.SmsSendApi;
import cn.iocoder.yudao.module.system.service.notify.NotifySendService;
import jakarta.annotation.Resource;
import lombok.extern.slf4j.Slf4j;
import org.flowable.engine.TaskService;
import org.springframework.stereotype.Service;
import org.springframework.validation.annotation.Validated;

import jakarta.annotation.Resource;
import java.util.HashMap;
import java.util.Map;

/**
 * BPM 消息 Service 实现类
 *
 * 当前只保留【待办任务】的站内信通知：任务分配到具体审批人时，给审批人发一条站内信（系统右上角小铃铛可见）。
 * 短信通知已整体关闭，其余方法仅记录日志。
 *
 * @author 超级管理员
 */
@@ -26,54 +28,68 @@
@Slf4j
public class BpmMessageServiceImpl implements BpmMessageService {

    @Resource
    private SmsSendApi smsSendApi;
    /**
     * 待办任务站内信模板编码，对应 system_notify_template.code
     */
    private static final String TEMPLATE_CODE_TASK_ASSIGNED = "bpm_task_assigned";

    /**
     * 站内信参数值的最大长度。
     * 说明：system_notify_message.template_params 只有 varchar(255)，参数值过长会导致插入失败，
     * 这里统一截断，保证一条待办必定能发出去。
     */
    private static final int PARAM_VALUE_MAX_LENGTH = 60;

    @Resource
    private WebProperties webProperties;
    private NotifySendService notifySendService;

    @Resource
    private TaskService flowTaskService;

    @Override
    public void sendMessageWhenProcessInstanceApprove(BpmMessageSendWhenProcessInstanceApproveReqDTO reqDTO) {
        Map<String, Object> templateParams = new HashMap<>();
        templateParams.put("processInstanceName", reqDTO.getProcessInstanceName());
        templateParams.put("detailUrl", getProcessInstanceDetailUrl(reqDTO.getProcessInstanceId()));
        smsSendApi.sendSingleSmsToAdmin(BpmMessageConvert.INSTANCE.convert(reqDTO.getStartUserId(),
                BpmMessageEnum.PROCESS_INSTANCE_APPROVE.getSmsTemplateCode(), templateParams));
        log.info("[sendMessageWhenProcessInstanceApprove][已关闭短信通知，跳过发送][processInstanceId: {}]", reqDTO.getProcessInstanceId());
    }

    @Override
    public void sendMessageWhenProcessInstanceReject(BpmMessageSendWhenProcessInstanceRejectReqDTO reqDTO) {
        Map<String, Object> templateParams = new HashMap<>();
        templateParams.put("processInstanceName", reqDTO.getProcessInstanceName());
        templateParams.put("reason", reqDTO.getReason());
        templateParams.put("detailUrl", getProcessInstanceDetailUrl(reqDTO.getProcessInstanceId()));
        smsSendApi.sendSingleSmsToAdmin(BpmMessageConvert.INSTANCE.convert(reqDTO.getStartUserId(),
                BpmMessageEnum.PROCESS_INSTANCE_REJECT.getSmsTemplateCode(), templateParams));
        log.info("[sendMessageWhenProcessInstanceReject][已关闭短信通知，跳过发送][processInstanceId: {}]", reqDTO.getProcessInstanceId());
    }

    /**
     * 任务分配到审批人时，发送站内信通知。
     *
     * 说明：所有流程节点的待办任务都会走 BpmTaskServiceImpl#processTaskAssigned 的本次调用（加签、转办同样会触发），
     * 因此这里实现一次即可覆盖全部流程的待办通知。
     */
    @Override
    public void sendMessageWhenTaskAssigned(BpmMessageSendWhenTaskCreatedReqDTO reqDTO) {
        Map<String, Object> templateParams = new HashMap<>();
        templateParams.put("processInstanceName", reqDTO.getProcessInstanceName());
        templateParams.put("taskName", reqDTO.getTaskName());
        templateParams.put("startUserNickname", reqDTO.getStartUserNickname());
        templateParams.put("detailUrl", getProcessInstanceDetailUrl(reqDTO.getProcessInstanceId()));
        smsSendApi.sendSingleSmsToAdmin(BpmMessageConvert.INSTANCE.convert(reqDTO.getAssigneeUserId(),
                BpmMessageEnum.TASK_ASSIGNED.getSmsTemplateCode(), templateParams));
        if (reqDTO.getAssigneeUserId() == null) {
            return;
        }
        // 任务可能在同一事务里已被自动通过、自动拒绝或取消（免审批开关、或签被抢占等），此时发待办通知只会误导审批人
        if (flowTaskService.createTaskQuery().taskId(reqDTO.getTaskId()).count() == 0) {
            log.info("[sendMessageWhenTaskAssigned][taskId({}) 已不在待办中，跳过待办通知]", reqDTO.getTaskId());
            return;
        }
        Map<String, Object> templateParams = new HashMap<>(4);
        templateParams.put("processName", StrUtil.maxLength(reqDTO.getProcessInstanceName(), PARAM_VALUE_MAX_LENGTH));
        templateParams.put("taskName", StrUtil.maxLength(reqDTO.getTaskName(), PARAM_VALUE_MAX_LENGTH));
        templateParams.put("startUserName", StrUtil.maxLength(reqDTO.getStartUserNickname(), PARAM_VALUE_MAX_LENGTH));
        try {
            notifySendService.sendSingleNotifyToAdmin(reqDTO.getAssigneeUserId(), TEMPLATE_CODE_TASK_ASSIGNED, templateParams);
            log.info("[sendMessageWhenTaskAssigned][已向用户({})发送待办站内信][taskId({}) taskName({})]",
                    reqDTO.getAssigneeUserId(), reqDTO.getTaskId(), reqDTO.getTaskName());
        } catch (Exception ex) {
            // 站内信发送失败不能影响审批任务本身的创建，否则整个流程提交事务会被回滚
            log.error("[sendMessageWhenTaskAssigned][向用户({})发送待办站内信失败][taskId({})]",
                    reqDTO.getAssigneeUserId(), reqDTO.getTaskId(), ex);
        }
    }

    @Override
    public void sendMessageWhenTaskTimeout(BpmMessageSendWhenTaskTimeoutReqDTO reqDTO) {
        Map<String, Object> templateParams = new HashMap<>();
        templateParams.put("processInstanceName", reqDTO.getProcessInstanceName());
        templateParams.put("taskName", reqDTO.getTaskName());
        templateParams.put("detailUrl", getProcessInstanceDetailUrl(reqDTO.getProcessInstanceId()));
        smsSendApi.sendSingleSmsToAdmin(BpmMessageConvert.INSTANCE.convert(reqDTO.getAssigneeUserId(),
                BpmMessageEnum.TASK_TIMEOUT.getSmsTemplateCode(), templateParams));
    }

    private String getProcessInstanceDetailUrl(String taskId) {
        return webProperties.getAdminUi().getUrl() + "/bpm/process-instance/detail?id=" + taskId;
        log.info("[sendMessageWhenTaskTimeout][已关闭短信通知，跳过发送][processInstanceId: {}]", reqDTO.getProcessInstanceId());
    }

}