✨ CRM：完善合同的审批逻辑

YunaiV
1 parent d604e76d
Showing 13 changed files with 35 additions and 143 deletions
yudao-module-bpm/yudao-module-bpm-api/src/main/java/cn/iocoder/yudao/module/bpm/api/listener/BpmResultListenerApi.java
yudao-module-bpm/yudao-module-bpm-api/src/main/java/cn/iocoder/yudao/module/bpm/api/listener/dto/BpmResultListenerRespDTO.java
yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/convert/task/BpmProcessInstanceConvert.java
yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/framework/bpm/core/event/BpmProcessInstanceResultEventPublisher.java
yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/framework/bpm/listener/BpmServiceResultListener.java
yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/service/oa/listener/BpmOALeaveResultListener.java
yudao-module-crm/yudao-module-crm-api/src/main/java/cn/iocoder/yudao/module/crm/enums/ErrorCodeConstants.java
yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contract/vo/CrmContractRespVO.java
yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/service/contract/CrmContractService.java
yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/service/contract/CrmContractServiceImpl.java
yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/service/contract/listener/CrmContractResultListener.java
-package cn.iocoder.yudao.module.bpm.api.listener;
-
-import cn.iocoder.yudao.module.bpm.api.listener.dto.BpmResultListenerRespDTO;
-
-// TODO @芋艿：后续改成支持 RPC
-/**
- * 业务流程实例的结果发生变化的监听器 Api
- *
- * @author HUIHUI
- */
-public interface BpmResultListenerApi {
-
-    /**
-     * 监听的流程定义 Key
-     *
-     * @return 返回监听的流程定义 Key
-     */
-    String getProcessDefinitionKey();
-
-    /**
-     * 处理事件
-     *
-     * @param event 事件
-     */
-    void onEvent(BpmResultListenerRespDTO event);
-
-}
-package cn.iocoder.yudao.module.bpm.api.listener.dto;
-
-import lombok.Data;
-
-// TODO @芋艿：后续改成支持 RPC
-/**
- * 业务流程实例的结果 Response DTO
- *
- * @author HUIHUI
- */
-@Data
-public class BpmResultListenerRespDTO {
-
-    /**
-     * 流程实例的编号
-     */
-    private String id;
-    /**
-     * 流程实例的 key
-     */
-    private String processDefinitionKey;
-    /**
-     * 流程实例的结果
-     */
-    private Integer result;
-    /**
-     * 流程实例对应的业务标识
-     * 例如说，请假
-     */
-    private String businessKey;
-
-}
-package cn.iocoder.yudao.module.bpm.framework.bpm.core.event;
+package cn.iocoder.yudao.module.bpm.event;
-import cn.iocoder.yudao.module.bpm.dal.dataobject.task.BpmProcessInstanceExtDO;
+import jakarta.validation.constraints.NotNull;
 import lombok.Data;
 import org.springframework.context.ApplicationEvent;
-import jakarta.validation.constraints.NotNull;
-
 /**
  * 流程实例的结果发生变化的 Event
  * 定位：由于额外增加了 {@link BpmProcessInstanceExtDO#getResult()} 结果，所以增加该事件
-package cn.iocoder.yudao.module.bpm.framework.bpm.core.event;
+package cn.iocoder.yudao.module.bpm.event;
 import cn.hutool.core.util.StrUtil;
 import org.springframework.context.ApplicationListener;
@@ -7,7 +7,7 @@ import cn.iocoder.yudao.module.bpm.controller.admin.task.vo.instance.BpmProcessI
 import cn.iocoder.yudao.module.bpm.controller.admin.task.vo.instance.BpmProcessInstanceRespVO;
 import cn.iocoder.yudao.module.bpm.dal.dataobject.definition.BpmProcessDefinitionExtDO;
 import cn.iocoder.yudao.module.bpm.dal.dataobject.task.BpmProcessInstanceExtDO;
-import cn.iocoder.yudao.module.bpm.framework.bpm.core.event.BpmProcessInstanceResultEvent;
+import cn.iocoder.yudao.module.bpm.event.BpmProcessInstanceResultEvent;
 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.system.api.dept.dto.DeptRespDTO;
 package cn.iocoder.yudao.module.bpm.framework.bpm.core.event;
+import cn.iocoder.yudao.module.bpm.event.BpmProcessInstanceResultEvent;
 import lombok.AllArgsConstructor;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.validation.annotation.Validated;
-package cn.iocoder.yudao.module.bpm.framework.bpm.listener;
-
-import cn.hutool.core.util.StrUtil;
-import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
-import cn.iocoder.yudao.module.bpm.api.listener.BpmResultListenerApi;
-import cn.iocoder.yudao.module.bpm.api.listener.dto.BpmResultListenerRespDTO;
-import cn.iocoder.yudao.module.bpm.framework.bpm.core.event.BpmProcessInstanceResultEvent;
-import jakarta.annotation.Resource;
-import org.springframework.context.ApplicationListener;
-import org.springframework.stereotype.Component;
-
-import java.util.List;
-
-// TODO @芋艿：后续改成支持 RPC
-/**
- * 业务流程结果监听器实现类
- *
- * @author HUIHUI
- */
-@Component
-public class BpmServiceResultListener implements ApplicationListener<BpmProcessInstanceResultEvent> {
-
-    @Resource
-    private List<BpmResultListenerApi> bpmResultListenerApis;
-
-    @Override
-    public final void onApplicationEvent(BpmProcessInstanceResultEvent event) {
-        bpmResultListenerApis.forEach(bpmResultListenerApi -> {
-            if (!StrUtil.equals(event.getProcessDefinitionKey(), bpmResultListenerApi.getProcessDefinitionKey())) {
-                return;
-            }
-            bpmResultListenerApi.onEvent(BeanUtils.toBean(event, BpmResultListenerRespDTO.class));
-        });
-    }
-
-}
 package cn.iocoder.yudao.module.bpm.service.oa.listener;
-import cn.iocoder.yudao.module.bpm.framework.bpm.core.event.BpmProcessInstanceResultEvent;
-import cn.iocoder.yudao.module.bpm.framework.bpm.core.event.BpmProcessInstanceResultEventListener;
+import cn.iocoder.yudao.module.bpm.event.BpmProcessInstanceResultEvent;
+import cn.iocoder.yudao.module.bpm.event.BpmProcessInstanceResultEventListener;
 import cn.iocoder.yudao.module.bpm.service.oa.BpmOALeaveService;
 import cn.iocoder.yudao.module.bpm.service.oa.BpmOALeaveServiceImpl;
 import org.springframework.stereotype.Component;
@@ -11,8 +11,9 @@ public interface ErrorCodeConstants {
     // ========== 合同管理 1-020-000-000 ==========
     ErrorCode CONTRACT_NOT_EXISTS = new ErrorCode(1_020_000_000, "合同不存在");
-    ErrorCode CONTRACT_UPDATE_FAIL_EDITING_PROHIBITED = new ErrorCode(1_020_000_001, "更新合同失败，原因：禁止编辑");
+    ErrorCode CONTRACT_UPDATE_FAIL_NOT_DRAFT = new ErrorCode(1_020_000_001, "合同更新失败，原因：合同不是草稿状态");
     ErrorCode CONTRACT_SUBMIT_FAIL_NOT_DRAFT = new ErrorCode(1_020_000_002, "合同提交审核失败，原因：合同没处在未提交状态");
+    ErrorCode CONTRACT_UPDATE_AUDIT_STATUS_FAIL_NOT_PROCESS = new ErrorCode(1_020_000_003, "更新合同审核状态失败，原因：合同不是处理中状态");
     // ========== 线索管理 1-020-001-000 ==========
     ErrorCode CLUE_NOT_EXISTS = new ErrorCode(1_020_001_000, "线索不存在");
@@ -58,7 +58,7 @@ public class CrmContractRespVO {
     @Schema(description = "工作流编号", example = "1043")
     @ExcelProperty("工作流编号")
-    private Long processInstanceId;
+    private String processInstanceId;
     @Schema(description = "审批状态", requiredMode = Schema.RequiredMode.REQUIRED, example = "0")
     @ExcelProperty("审批状态")
 package cn.iocoder.yudao.module.crm.service.contract;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
-import cn.iocoder.yudao.module.bpm.api.listener.dto.BpmResultListenerRespDTO;
 import cn.iocoder.yudao.module.crm.controller.admin.contract.vo.CrmContractPageReqVO;
 import cn.iocoder.yudao.module.crm.controller.admin.contract.vo.CrmContractSaveReqVO;
 import cn.iocoder.yudao.module.crm.controller.admin.contract.vo.CrmContractTransferReqVO;
@@ -72,9 +71,10 @@ public interface CrmContractService {
     /**
      * 更新合同流程审批结果
      *
-     * @param event 审批结果
+     * @param id 合同编号
+     * @param bpmResult BPM 审批结果
      */
-    void updateContractAuditStatus(BpmResultListenerRespDTO event);
+    void updateContractAuditStatus(Long id, Integer bpmResult);
     /**
      * 获得合同
@@ -8,7 +8,6 @@ import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.framework.common.util.number.MoneyUtils;
 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
 import cn.iocoder.yudao.framework.common.util.object.ObjectUtils;
-import cn.iocoder.yudao.module.bpm.api.listener.dto.BpmResultListenerRespDTO;
 import cn.iocoder.yudao.module.bpm.api.task.BpmProcessInstanceApi;
 import cn.iocoder.yudao.module.bpm.api.task.dto.BpmProcessInstanceCreateReqDTO;
 import cn.iocoder.yudao.module.bpm.enums.task.BpmProcessInstanceResultEnum;
@@ -35,6 +34,7 @@ import com.mzt.logapi.context.LogRecordContext;
 import com.mzt.logapi.service.impl.DiffParseFunction;
 import com.mzt.logapi.starter.annotation.LogRecord;
 import jakarta.annotation.Resource;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.validation.annotation.Validated;
@@ -56,6 +56,7 @@ import static cn.iocoder.yudao.module.crm.enums.LogRecordConstants.*;
  */
 @Service
 @Validated
+@Slf4j
 public class CrmContractServiceImpl implements CrmContractService {
     /**
@@ -129,7 +130,7 @@ public class CrmContractServiceImpl implements CrmContractService {
         // 1.2 只有草稿、审批中，可以编辑；
         if (!ObjectUtils.equalsAny(contract.getAuditStatus(), CrmAuditStatusEnum.DRAFT.getStatus(),
                 CrmAuditStatusEnum.PROCESS.getStatus())) {
-            throw exception(CONTRACT_UPDATE_FAIL_EDITING_PROHIBITED);
+            throw exception(CONTRACT_UPDATE_FAIL_NOT_DRAFT);
         }
         // 1.3 校验产品项的有效性
         List<CrmContractProductDO> contractProducts = validateContractProducts(updateReqVO.getProducts());
@@ -291,35 +292,22 @@ public class CrmContractServiceImpl implements CrmContractService {
     }
     @Override
-    public void updateContractAuditStatus(BpmResultListenerRespDTO event) {
-        // 判断下状态是否符合预期
-        if (!isEndResult(event.getResult())) {
-            return;
-        }
-        // 状态转换
-        if (ObjUtil.equal(event.getResult(), BpmProcessInstanceResultEnum.APPROVE.getResult())) {
-            event.setResult(CrmAuditStatusEnum.APPROVE.getStatus());
-        }
-        if (ObjUtil.equal(event.getResult(), BpmProcessInstanceResultEnum.REJECT.getResult())) {
-            event.setResult(CrmAuditStatusEnum.REJECT.getStatus());
-        }
-        if (ObjUtil.equal(event.getResult(), BpmProcessInstanceResultEnum.CANCEL.getResult())) {
-            event.setResult(CrmAuditStatusEnum.CANCEL.getStatus());
+    public void updateContractAuditStatus(Long id, Integer bpmResult) {
+        // 1.1 校验合同是否存在
+        CrmContractDO contract = validateContractExists(id);
+        // 1.2 只有审批中，可以更新审批结果
+        if (ObjUtil.notEqual(contract.getAuditStatus(), CrmAuditStatusEnum.PROCESS.getStatus())) {
+            log.error("[updateContractAuditStatus][contract({}) 不处于审批中，无法更新审批结果({})]",
+                    contract.getId(), bpmResult);
+            throw exception(CONTRACT_UPDATE_AUDIT_STATUS_FAIL_NOT_PROCESS);
         }
-        // 更新合同状态
-        contractMapper.updateById(new CrmContractDO().setId(Long.parseLong(event.getBusinessKey()))
-                .setAuditStatus(event.getResult()));
-    }
-    /**
-     * 判断该结果是否处于 End 最终结果
-     *
-     * @param result 结果
-     * @return 是否
-     */
-    public static boolean isEndResult(Integer result) {
-        return ObjectUtils.equalsAny(result, BpmProcessInstanceResultEnum.APPROVE.getResult(),
-                BpmProcessInstanceResultEnum.REJECT.getResult(), BpmProcessInstanceResultEnum.CANCEL.getResult());
+        // 2. 更新合同审批结果
+        Integer auditStatus = BpmProcessInstanceResultEnum.APPROVE.getResult().equals(bpmResult) ? CrmAuditStatusEnum.APPROVE.getStatus()
+                : BpmProcessInstanceResultEnum.REJECT.getResult().equals(bpmResult) ? CrmAuditStatusEnum.REJECT.getStatus()
+                : BpmProcessInstanceResultEnum.CANCEL.getResult();
+        Assert.notNull(auditStatus, "BPM 审批结果({}) 转换失败", bpmResult);
+        contractMapper.updateById(new CrmContractDO().setId(id).setAuditStatus(auditStatus));
     }
     //======================= 查询相关 =======================
 package cn.iocoder.yudao.module.crm.service.contract.listener;
-import cn.iocoder.yudao.module.bpm.api.listener.BpmResultListenerApi;
-import cn.iocoder.yudao.module.bpm.api.listener.dto.BpmResultListenerRespDTO;
+import cn.iocoder.yudao.module.bpm.event.BpmProcessInstanceResultEvent;
+import cn.iocoder.yudao.module.bpm.event.BpmProcessInstanceResultEventListener;
 import cn.iocoder.yudao.module.crm.service.contract.CrmContractService;
 import cn.iocoder.yudao.module.crm.service.contract.CrmContractServiceImpl;
 import jakarta.annotation.Resource;
 import org.springframework.stereotype.Component;
-// TODO @芋艿：后续改成支持 RPC
 /**
  * 合同审批的结果的监听器实现类
  *
  * @author HUIHUI
  */
 @Component
-public class CrmContractResultListener implements BpmResultListenerApi {
+public class CrmContractResultListener extends BpmProcessInstanceResultEventListener {
     @Resource
     private CrmContractService contractService;
@@ -25,8 +24,8 @@ public class CrmContractResultListener implements BpmResultListenerApi {
     }
     @Override
-    public void onEvent(BpmResultListenerRespDTO event) {
-        contractService.updateContractAuditStatus(event);
+    protected void onEvent(BpmProcessInstanceResultEvent event) {
+        contractService.updateContractAuditStatus(Long.parseLong(event.getBusinessKey()), event.getResult());
     }
 }