refactor(aftersales): 故障赔付/服务补偿单审核改为审批配置状态机

liu

昨天 d58f6629879c457cd49fdb8d3cc7318c497c5dc3

 yudao-module-aftersales/src/main/java/cn/iocoder/yudao/module/aftersales/service/compensation/AfterSaleCompensationServiceImpl.java

@@ -1,43 +1,31 @@
package cn.iocoder.yudao.module.aftersales.service.compensation;

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.util.ObjUtil;
import cn.hutool.core.util.RandomUtil;
import cn.hutool.core.util.StrUtil;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
import cn.iocoder.yudao.module.aftersales.controller.admin.compensation.vo.AfterSaleCompensationAuditReqVO;
import cn.iocoder.yudao.module.aftersales.controller.admin.compensation.vo.AfterSaleCompensationPageReqVO;
import cn.iocoder.yudao.module.aftersales.controller.admin.compensation.vo.AfterSaleCompensationSaveReqVO;
import cn.iocoder.yudao.module.aftersales.dal.dataobject.compensation.AfterSaleCompensationDO;
import cn.iocoder.yudao.module.aftersales.dal.mysql.compensation.AfterSaleCompensationMapper;
import cn.iocoder.yudao.module.aftersales.enums.AfterSaleCompensationAuditStatusEnum;
import cn.iocoder.yudao.module.aftersales.enums.ErrorCodeConstants;
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.dal.dataobject.definition.BpmProcessDefinitionInfoDO;
import cn.iocoder.yudao.module.bpm.service.definition.BpmCategoryService;
import cn.iocoder.yudao.module.bpm.service.definition.BpmProcessDefinitionService;
import cn.iocoder.yudao.module.system.api.approval.ApprovalConfigApi;
import cn.iocoder.yudao.module.system.api.user.AdminUserApi;
import cn.iocoder.yudao.module.system.api.user.dto.AdminUserRespDTO;
import jakarta.annotation.Resource;
import lombok.extern.slf4j.Slf4j;
import org.flowable.engine.repository.ProcessDefinition;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.validation.annotation.Validated;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
import static cn.iocoder.yudao.module.aftersales.util.AfterSaleCompensationStatusUtils.convertBpmResultToAuditStatus;

/**
 * 售后赔付/服务补偿单 Service 实现类
@@ -47,22 +35,19 @@
@Slf4j
public class AfterSaleCompensationServiceImpl implements AfterSaleCompensationService {

    private static final Integer AUDIT_DRAFT = 0;
    private static final Integer AUDIT_PASS = 20;

    /**
     * BPM 赔付审批分类编码
     * 赔付单审批的业务类型编码
     *
     * 与 system_approval_config.biz_type 对应，审批人在「系统管理 - 审批配置」中维护。
     */
    private static final String COMPENSATION_APPROVE_CATEGORY_CODE = "compensation_approve";
    private static final String COMPENSATION_APPROVE_BIZ_TYPE = "compensation_approve";

    @Resource
    private AfterSaleCompensationMapper compensationMapper;
    @Resource
    private BpmProcessInstanceApi bpmProcessInstanceApi;
    private ApprovalConfigApi approvalConfigApi;
    @Resource
    private BpmCategoryService bpmCategoryService;
    @Resource
    private BpmProcessDefinitionService bpmProcessDefinitionService;
    private AdminUserApi adminUserApi;

    @Override
    @Transactional(rollbackFor = Exception.class)
@@ -73,7 +58,7 @@
        }
        AfterSaleCompensationDO entity = BeanUtils.toBean(createReqVO, AfterSaleCompensationDO.class, req -> req
                .setCompensationNo(compensationNo)
                .setAuditStatus(AUDIT_DRAFT));
                .setAuditStatus(AfterSaleCompensationAuditStatusEnum.DRAFT.getStatus()));
        compensationMapper.insert(entity);
        return entity.getId();
    }
@@ -84,7 +69,7 @@
        if (exists == null) {
            throw exception(ErrorCodeConstants.COMPENSATION_NOT_EXISTS);
        }
        if (ObjUtil.notEqual(exists.getAuditStatus(), AUDIT_DRAFT)) {
        if (ObjUtil.notEqual(exists.getAuditStatus(), AfterSaleCompensationAuditStatusEnum.DRAFT.getStatus())) {
            throw exception(ErrorCodeConstants.COMPENSATION_DELETE_FAIL_NOT_DRAFT);
        }
        AfterSaleCompensationDO entity = BeanUtils.toBean(updateReqVO, AfterSaleCompensationDO.class, req -> req
@@ -100,7 +85,7 @@
        if (exists == null) {
            throw exception(ErrorCodeConstants.COMPENSATION_NOT_EXISTS);
        }
        if (ObjUtil.notEqual(exists.getAuditStatus(), AUDIT_DRAFT)) {
        if (ObjUtil.notEqual(exists.getAuditStatus(), AfterSaleCompensationAuditStatusEnum.DRAFT.getStatus())) {
            throw exception(ErrorCodeConstants.COMPENSATION_DELETE_FAIL_NOT_DRAFT);
        }
        compensationMapper.deleteById(id);
@@ -117,130 +102,75 @@
    }

    @Override
    public void submitCompensation(Long id, String processDefinitionKey, Long userId) {
        // 1. 校验赔付单是否在草稿状态
        AfterSaleCompensationDO compensation = compensationMapper.selectById(id);
        if (compensation == null) {
            throw exception(ErrorCodeConstants.COMPENSATION_NOT_EXISTS);
        }
        if (ObjUtil.notEqual(compensation.getAuditStatus(), AfterSaleCompensationAuditStatusEnum.DRAFT.getStatus())) {
            throw exception(ErrorCodeConstants.COMPENSATION_SUBMIT_FAIL_NOT_DRAFT);
    @Transactional(rollbackFor = Exception.class)
    public void submitCompensation(Long id) {
        // 1. 校验存在 + 可提交状态（未提交 / 审核不通过）
        AfterSaleCompensationDO compensation = validateCompensationExists(id);
        if (ObjUtil.notEqual(compensation.getAuditStatus(), AfterSaleCompensationAuditStatusEnum.DRAFT.getStatus())
                && ObjUtil.notEqual(compensation.getAuditStatus(), AfterSaleCompensationAuditStatusEnum.REJECT.getStatus())) {
            throw exception(ErrorCodeConstants.COMPENSATION_SUBMIT_FAIL_NOT_EDITABLE);
        }

        // 2. 校验赔付审批分类和流程定义是否存在，且传入的流程定义处于激活状态
        validateCompensationApproveCategoryAndProcessDefinition();
        ProcessDefinition processDefinition = bpmProcessDefinitionService.getActiveProcessDefinition(processDefinitionKey);
        if (processDefinition == null) {
            throw exception(ErrorCodeConstants.COMPENSATION_BPM_PROCESS_DEFINITION_NOT_EXISTS);
        }
        // 2. 校验审批配置已启用且配置了有效审批人（未配置时抛出带明确提示的业务异常）
        approvalConfigApi.validateApprovalEnabledAndGetApprovers(COMPENSATION_APPROVE_BIZ_TYPE);

        // 3. 创建赔付审批流程实例
        String processInstanceId = bpmProcessInstanceApi.createProcessInstance(userId,
                new BpmProcessInstanceCreateReqDTO().setProcessDefinitionKey(processDefinitionKey)
                        .setBusinessKey(String.valueOf(id)));

        // 4. 更新赔付单流程编号与审批状态
        compensationMapper.updateById(new AfterSaleCompensationDO().setId(id).setProcessInstanceId(processInstanceId)
                .setAuditStatus(AfterSaleCompensationAuditStatusEnum.PROCESS.getStatus()));
        // 3. 状态置为审批中，并清空上一轮审核结果，避免残留「审核不通过」的原因
        compensationMapper.submitAndResetAuditInfo(id, AfterSaleCompensationAuditStatusEnum.PROCESS.getStatus());
    }

    @Override
    public void auditCompensation(AfterSaleCompensationAuditReqVO auditReqVO) {
        AfterSaleCompensationDO exists = compensationMapper.selectById(auditReqVO.getId());
        if (exists == null) {
            throw exception(ErrorCodeConstants.COMPENSATION_NOT_EXISTS);
        }
        AfterSaleCompensationDO update = new AfterSaleCompensationDO();
        update.setId(exists.getId());
        update.setAuditStatus(auditReqVO.getAuditStatus());
        update.setAuditUserId(getLoginUserId());
        update.setAuditTime(LocalDateTime.now());
        if (StrUtil.isNotBlank(auditReqVO.getRemark())) {
            update.setAuditRemark(auditReqVO.getRemark());
        }
        compensationMapper.updateById(update);
    public Set<Long> getCompensationApproverUserIds() {
        return approvalConfigApi.getApproverUserIds(COMPENSATION_APPROVE_BIZ_TYPE);
    }

    @Override
    public void updateCompensationAuditStatus(Long id, Integer bpmResult) {
        // 1.1 校验赔付单是否存在
        AfterSaleCompensationDO compensation = compensationMapper.selectById(id);
        if (compensation == null) {
            throw exception(ErrorCodeConstants.COMPENSATION_NOT_EXISTS);
        }
        // 1.2 只有审批中，可以更新审批结果
    @Transactional(rollbackFor = Exception.class)
    public void auditCompensation(Long id, Boolean pass, String reviewRemark) {
        // 1. 校验存在
        AfterSaleCompensationDO compensation = validateCompensationExists(id);
        // 2. 校验处于审批中状态
        if (ObjUtil.notEqual(compensation.getAuditStatus(), AfterSaleCompensationAuditStatusEnum.PROCESS.getStatus())) {
            log.error("[updateCompensationAuditStatus][compensation({}) 不处于审批中，无法更新审批结果({})]", compensation.getId(), bpmResult);
            throw exception(ErrorCodeConstants.COMPENSATION_UPDATE_AUDIT_STATUS_FAIL_NOT_PROCESS);
            throw exception(ErrorCodeConstants.COMPENSATION_AUDIT_FAIL_NOT_PROCESS);
        }
        // 3. 校验当前登录用户是该业务类型的审批人（或签：任一人均可审核）
        Long userId = getLoginUserId();
        approvalConfigApi.validateApprover(COMPENSATION_APPROVE_BIZ_TYPE, userId);
        // 4. 审核不通过：必须填写原因，状态置为审核不通过，退回提交人修改后可重新提交
        if (!Boolean.TRUE.equals(pass)) {
            if (StrUtil.isBlank(reviewRemark)) {
                throw exception(ErrorCodeConstants.COMPENSATION_AUDIT_REJECT_REASON_REQUIRED);
            }
            compensationMapper.auditCompensation(id, AfterSaleCompensationAuditStatusEnum.REJECT.getStatus(),
                    userId, getUserNickname(userId), reviewRemark);
            return;
        }
        // 5. 审核通过：记录审核人与审核意见，状态置为审核通过
        compensationMapper.auditCompensation(id, AfterSaleCompensationAuditStatusEnum.APPROVE.getStatus(),
                userId, getUserNickname(userId), reviewRemark);
        // 6. 审核通过后的后置业务逻辑：当前赔付单审批通过后无自动生成下游单据的动作，
        //    支付状态（payStatus）待后续接入财务模块时再联动。
        }

        // 2. 更新赔付单审批结果
        Integer auditStatus = convertBpmResultToAuditStatus(bpmResult);
        compensationMapper.updateById(new AfterSaleCompensationDO().setId(id).setAuditStatus(auditStatus));
    private AfterSaleCompensationDO validateCompensationExists(Long id) {
        AfterSaleCompensationDO compensation = compensationMapper.selectById(id);
        if (compensation == null) {
            throw exception(ErrorCodeConstants.COMPENSATION_NOT_EXISTS);
    }

    @Override
    public List<Map<String, Object>> getCompensationApproveProcessDefinitionList() {
        // 1. 校验赔付审批分类和流程定义是否存在
        validateCompensationApproveCategoryAndProcessDefinition();

        // 2. 获取分类下的流程定义信息
        List<BpmProcessDefinitionInfoDO> definitionInfoList = bpmProcessDefinitionService
                .getProcessDefinitionInfoListByCategory(COMPENSATION_APPROVE_CATEGORY_CODE);

        // 3. 获取流程定义详情
        Set<String> processDefinitionIds = convertSet(definitionInfoList, BpmProcessDefinitionInfoDO::getProcessDefinitionId);
        List<ProcessDefinition> processDefinitions = bpmProcessDefinitionService.getProcessDefinitionList(processDefinitionIds);

        // 4. 过滤：只保留激活状态，且相同 key 只保留最新版本
        Map<String, ProcessDefinition> latestVersionMap = new HashMap<>();
        for (ProcessDefinition pd : processDefinitions) {
            if (pd.isSuspended()) {
                continue;
            }
            ProcessDefinition existing = latestVersionMap.get(pd.getKey());
            if (existing == null || pd.getVersion() > existing.getVersion()) {
                latestVersionMap.put(pd.getKey(), pd);
            }
        }

        // 5. 返回流程定义列表
        List<Map<String, Object>> result = new ArrayList<>();
        for (ProcessDefinition pd : latestVersionMap.values()) {
            Map<String, Object> item = new HashMap<>();
            item.put("id", pd.getId());
            item.put("key", pd.getKey());
            item.put("name", pd.getName());
            item.put("version", pd.getVersion());
            result.add(item);
        }
        return result;
        return compensation;
    }

    /**
     * 校验 BPM 赔付审批分类和流程定义是否存在
     * 获取用户昵称
     *
     * @param userId 用户编号
     * @return 昵称，用户不存在时返回 null
     */
    private void validateCompensationApproveCategoryAndProcessDefinition() {
        // 1. 校验分类是否存在
        Map<String, ?> categoryMap = bpmCategoryService.getCategoryMap(Collections.singletonList(COMPENSATION_APPROVE_CATEGORY_CODE));
        if (!categoryMap.containsKey(COMPENSATION_APPROVE_CATEGORY_CODE)) {
            throw exception(ErrorCodeConstants.COMPENSATION_BPM_PROCESS_DEFINITION_NOT_EXISTS);
    private String getUserNickname(Long userId) {
        if (userId == null) {
            return null;
        }

        // 2. 校验分类下是否有可用的流程定义
        List<BpmProcessDefinitionInfoDO> definitionInfoList = bpmProcessDefinitionService
                .getProcessDefinitionInfoListByCategory(COMPENSATION_APPROVE_CATEGORY_CODE);
        if (CollUtil.isEmpty(definitionInfoList)) {
            throw exception(ErrorCodeConstants.COMPENSATION_BPM_PROCESS_DEFINITION_NOT_EXISTS);
        }

        // 3. 校验是否有激活状态的流程定义
        Set<String> processDefinitionIds = convertSet(definitionInfoList, BpmProcessDefinitionInfoDO::getProcessDefinitionId);
        List<ProcessDefinition> processDefinitions = bpmProcessDefinitionService.getProcessDefinitionList(processDefinitionIds);
        boolean hasActiveDefinition = processDefinitions.stream().anyMatch(pd -> !pd.isSuspended());
        if (!hasActiveDefinition) {
            throw exception(ErrorCodeConstants.COMPENSATION_BPM_PROCESS_DEFINITION_NOT_EXISTS);
        }
        AdminUserRespDTO user = adminUserApi.getUser(userId);
        return user == null ? null : user.getNickname();
    }

    private String generateCompensationNo() {