feat(bpm): 添加 OA 项目申请功能

- 新增 OA项目申请相关的数据结构和接口- 实现 OA 项目申请的创建、查询和结果更新功能- 添加 OA 项目申请的结果监听器
- 优化错误码命名,提高可读性
This commit is contained in:
furongxin 2024-11-23 13:46:35 +08:00
parent b8da3af92d
commit 357fa8aa13
11 changed files with 542 additions and 9 deletions

View File

@ -57,7 +57,8 @@ public interface ErrorCodeConstants {
ErrorCode OA_EVECTION_IS_EXISTS = new ErrorCode(1_009_001_120, "该时间段您正在出差!请重新选择正确出差时间。"); ErrorCode OA_EVECTION_IS_EXISTS = new ErrorCode(1_009_001_120, "该时间段您正在出差!请重新选择正确出差时间。");
ErrorCode OA_INVOICE_NOT_EXISTS = new ErrorCode(1_009_001_121, "开票申请不存在"); ErrorCode OA_INVOICE_NOT_EXISTS = new ErrorCode(1_009_001_121, "开票申请不存在");
ErrorCode OA_REPLACEMENT_CARD_NOT_EXISTS = new ErrorCode(1_009_001_122, "补卡申请不存在"); ErrorCode OA_REPLACEMENT_CARD_NOT_EXISTS = new ErrorCode(1_009_001_122, "补卡申请不存在");
ErrorCode OA_REFUND_CARD_NOT_EXISTS = new ErrorCode(1_009_001_123, "退款申请不存在"); ErrorCode OA_REFUND_NOT_EXISTS = new ErrorCode(1_009_001_123, "退款申请不存在");
ErrorCode OA_PROJECT_NOT_EXISTS = new ErrorCode(1_009_001_124, "项目申请不存在");
// ========== 流程模型 1-009-002-000 ========== // ========== 流程模型 1-009-002-000 ==========

View File

@ -0,0 +1,61 @@
package cn.iocoder.yudao.module.bpm.controller.admin.oa;
import cn.iocoder.yudao.framework.common.pojo.CommonResult;
import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
import cn.iocoder.yudao.module.bpm.controller.admin.oa.vo.project.BpmOAProjectCreateReqVO;
import cn.iocoder.yudao.module.bpm.controller.admin.oa.vo.project.BpmOAProjectRespVO;
import cn.iocoder.yudao.module.bpm.dal.dataobject.oa.BpmOAProjectDO;
import cn.iocoder.yudao.module.bpm.service.oa.BpmOAProjectService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.validation.Valid;
import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
/**
* OA 项目申请 Controller
*
* @author 符溶馨
*/
@Tag(name = "管理后台 - OA 项目申请")
@RestController
@RequestMapping("/bpm/oa/project")
@Validated
public class BpmOAProjectController {
@Resource
private BpmOAProjectService projectService;
@PostMapping("/create")
@Operation(summary = "创建请求申请")
public CommonResult<Long> createProject(@Valid @RequestBody BpmOAProjectCreateReqVO createReqVO) {
return success(projectService.createProject(getLoginUserId(), createReqVO));
}
@GetMapping("/get")
@Operation(summary = "获得项目申请")
@Parameter(name = "id", description = "编号", required = true, example = "1024")
public CommonResult<BpmOAProjectRespVO> getProject(@RequestParam("id") Long id) {
BpmOAProjectDO project = projectService.getProject(id);
return success(BeanUtils.toBean(project, BpmOAProjectRespVO.class));
}
@GetMapping("/getByProcessInstanceId")
@Operation(summary = "获得项目申请")
@Parameter(name = "processInstanceId", description = "流程实例编号", required = true, example = "1024")
public CommonResult<BpmOAProjectRespVO> getByProcessInstanceId(@RequestParam("processInstanceId") String processInstanceId) {
BpmOAProjectDO project = projectService.getByProcessInstanceId(processInstanceId);
return success(BeanUtils.toBean(project, BpmOAProjectRespVO.class));
}
}

View File

@ -0,0 +1,81 @@
package cn.iocoder.yudao.module.bpm.controller.admin.oa.vo.project;
import cn.iocoder.yudao.framework.common.pojo.UploadUserFile;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import org.springframework.format.annotation.DateTimeFormat;
import javax.validation.constraints.NotNull;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;
import java.util.Set;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY;
/**
* 项目申请 创建 Request VO
*
* @author 符溶馨
*/
@Schema(description = "管理后台 - 项目申请创建 Request VO")
@Data
@EqualsAndHashCode()
@ToString(callSuper = true)
public class BpmOAProjectCreateReqVO {
@Schema(description = "项目类型", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目类型不能为空")
private Integer type;
@Schema(description = "项目名称", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目名称不能为空")
private String name;
@Schema(description = "责任部门", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "责任部门不能为空")
private Long responsibleDept;
@Schema(description = "参与部门集合")
private Set<Long> participationDept;
@Schema(description = "责任人", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "责任人不能为空")
private Long directorUserId;
@Schema(description = "项目开始日期", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目开始日期不能为空")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY)
private LocalDate startDate;
@Schema(description = "项目结束日期", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目结束日期不能为空")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY)
private LocalDate endDate;
@Schema(description = "是否长期项目", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
private Integer isLongTerm;
@Schema(description = "项目预算", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目预算不能为空")
private BigDecimal projectBudget;
@Schema(description = "项目内容", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目内容不能为空")
private String content;
@Schema(description = "项目额外属性", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
private Map<String, Object> dynamicAttribute;
@Schema(description = "流程实例编号")
private String processInstanceId;
@Schema(description = "状态-参见 bpm_process_instance_result 枚举", requiredMode = Schema.RequiredMode.REQUIRED, example = "1")
private Integer result;
@Schema(description = "上传文件", requiredMode = Schema.RequiredMode.REQUIRED)
private List<UploadUserFile> fileItems;
}

View File

@ -0,0 +1,75 @@
package cn.iocoder.yudao.module.bpm.controller.admin.oa.vo.project;
import cn.iocoder.yudao.framework.common.pojo.UploadUserFile;
import cn.iocoder.yudao.module.bpm.controller.admin.oa.vo.BpmOABaseRespVO;
import cn.iocoder.yudao.module.bpm.controller.admin.oa.vo.refund.BpmOARefundItems;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import org.springframework.format.annotation.DateTimeFormat;
import javax.validation.constraints.NotNull;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;
import java.util.Set;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY;
/**
* @author 符溶馨
*/
@Schema(description = "管理后台 - 项目申请 请求Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class BpmOAProjectRespVO extends BpmOABaseRespVO {
@Schema(description = "项目类型", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目类型不能为空")
private Integer type;
@Schema(description = "项目名称", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目名称不能为空")
private String name;
@Schema(description = "责任部门", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "责任部门不能为空")
private Long responsibleDept;
@Schema(description = "参与部门集合")
private Set<Long> participationDept;
@Schema(description = "责任人", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "责任人不能为空")
private Long directorUserId;
@Schema(description = "项目开始日期", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目开始日期不能为空")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY)
private LocalDate startDate;
@Schema(description = "项目结束日期", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目结束日期不能为空")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY)
private LocalDate endDate;
@Schema(description = "是否长期项目", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
private Integer isLongTerm;
@Schema(description = "项目预算", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目预算不能为空")
private BigDecimal projectBudget;
@Schema(description = "项目内容", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "项目内容不能为空")
private String content;
@Schema(description = "项目额外属性", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
private Map<String, Object> dynamicAttribute;
@Schema(description = "上传文件", requiredMode = Schema.RequiredMode.REQUIRED)
private List<UploadUserFile> fileItems;
}

View File

@ -0,0 +1,117 @@
package cn.iocoder.yudao.module.bpm.dal.dataobject.oa;
import cn.iocoder.yudao.framework.common.pojo.UploadUserFile;
import cn.iocoder.yudao.framework.mybatis.core.dataobject.BaseDO;
import cn.iocoder.yudao.module.bpm.enums.task.BpmProcessInstanceResultEnum;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler;
import lombok.*;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* OA 项目申请 DO
*
* @author 符溶馨
*/
@TableName(value ="bpm_oa_refund", autoResultMap = true)
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class BpmOAProjectDO extends BaseDO {
/**
* 出差表单主键
*/
@TableId
private Long id;
/**
* 申请人的用户编号
* 关联 AdminUserDO id 属性
*/
private Long userId;
/**
* 项目类型
*/
private Integer type;
/**
* 项目名称
*/
private String name;
/**
* 责任部门
*/
private Long responsibleDept;
/**
* 参与部门
*/
private Set<Long> participationDept;
/**
* 责任人
*/
private Long directorUserId;
/**
* 项目开始日期
*/
private LocalDate startDate;
/**
* 项目结束日期
*/
private LocalDate endDate;
/**
* 是否为长期项目 | 0否 1是
*/
private Integer isLongTerm;
/**
* 项目预算
*/
private BigDecimal projectBudget;
/**
* 项目内容
*/
private String content;
/**
* 项目额外属性
*/
private Map<String, Object> dynamicAttribute;
/**
* 结果
* 枚举 {@link BpmProcessInstanceResultEnum}
* 考虑到简单所以直接复用了 BpmProcessInstanceResultEnum 枚举也可以自己定义一个枚举哈
*/
private Integer result;
/**
* 对应的流程编号
* 关联 ProcessInstance id 属性
*/
private String processInstanceId;
/**
* 附件基本信息
*/
@TableField(typeHandler = JacksonTypeHandler.class)
private List<UploadUserFile> fileItems;
}

View File

@ -15,11 +15,9 @@ import java.time.LocalDate;
import java.util.List; import java.util.List;
/** /**
* OA 转正申请 DO * OA 退款申请 DO
*
* *
* @author 符溶馨 * @author 符溶馨
*/ */
@TableName(value ="bpm_oa_refund", autoResultMap = true) @TableName(value ="bpm_oa_refund", autoResultMap = true)
@Data @Data

View File

@ -0,0 +1,9 @@
package cn.iocoder.yudao.module.bpm.dal.mysql.oa;
import cn.iocoder.yudao.framework.mybatis.core.mapper.BaseMapperX;
import cn.iocoder.yudao.module.bpm.dal.dataobject.oa.BpmOAProjectDO;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface BpmOAProjectMapper extends BaseMapperX<BpmOAProjectDO> {
}

View File

@ -0,0 +1,41 @@
package cn.iocoder.yudao.module.bpm.service.oa;
import cn.iocoder.yudao.module.bpm.controller.admin.oa.vo.project.BpmOAProjectCreateReqVO;
import cn.iocoder.yudao.module.bpm.dal.dataobject.oa.BpmOAProjectDO;
import javax.validation.Valid;
public interface BpmOAProjectService {
/**
* 创建转正申请
*
* @param userId 用户编号
* @param createReqVO 创建信息
* @return 编号
*/
Long createProject(Long userId, @Valid BpmOAProjectCreateReqVO createReqVO);
/**
* 更新转正申请的状态
*
* @param id 编号
* @param result 结果
*/
void updateProjectResult(String processInstanceId, Long id, Integer result);
/**
* 获得转正申请
*
* @param id 编号
* @return 转正申请
*/
BpmOAProjectDO getProject(Long id);
/**
* 获得指定的转正申请
* @param processInstanceId 流程实例编号
* @return 转正申请
*/
BpmOAProjectDO getByProcessInstanceId(String processInstanceId);
}

View File

@ -0,0 +1,118 @@
package cn.iocoder.yudao.module.bpm.service.oa;
import cn.iocoder.yudao.framework.common.pojo.UploadUserFile;
import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
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.controller.admin.oa.vo.project.BpmOAProjectCreateReqVO;
import cn.iocoder.yudao.module.bpm.dal.dataobject.oa.BpmOAProjectDO;
import cn.iocoder.yudao.module.bpm.dal.mysql.oa.BpmOAProjectMapper;
import cn.iocoder.yudao.module.bpm.enums.task.BpmProcessInstanceResultEnum;
import cn.iocoder.yudao.module.bpm.service.task.BpmHistoryProcessInstanceService;
import cn.iocoder.yudao.module.bpm.service.task.BpmProcessInstanceService;
import org.flowable.engine.runtime.ProcessInstance;
import org.springframework.stereotype.Service;
import org.springframework.validation.annotation.Validated;
import javax.annotation.Resource;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
import static cn.iocoder.yudao.module.bpm.enums.ErrorCodeConstants.OA_PROJECT_NOT_EXISTS;
/**
* OA 项目申请 Service 实现类
*
* @author 符溶馨
*/
@Service
@Validated
public class BpmOAProjectServiceImpl extends BpmOABaseService implements BpmOAProjectService{
/**
* OA 项目申请对应的流程定义 KEY
*/
public static final String PROCESS_KEY = "oa_project_2";
@Resource
private BpmOAProjectMapper projectMapper;
@Resource
private BpmProcessInstanceApi processInstanceApi;
@Resource
private BpmHistoryProcessInstanceService historyProcessInstanceService;
@Resource
private BpmProcessInstanceService bpmProcessInstanceService;
@Override
public Long createProject(Long userId, BpmOAProjectCreateReqVO createReqVO) {
//插入OA 项目申请
BpmOAProjectDO project = BeanUtils.toBean(createReqVO, BpmOAProjectDO.class)
.setUserId(userId)
.setResult(BpmProcessInstanceResultEnum.PROCESS.getResult());
projectMapper.insert(project) ;
// 发起 BPM 流程
Map<String, Object> processInstanceVariables = new HashMap<>();
String processInstanceId = processInstanceApi.createProcessInstance(userId,
new BpmProcessInstanceCreateReqDTO().setProcessDefinitionKey(PROCESS_KEY)
.setVariables(processInstanceVariables).setBusinessKey(String.valueOf(project.getId()))).getCheckedData();
// 将工作流的编号更新到 OA 项目申请单中
projectMapper.updateById(new BpmOAProjectDO().setId(project.getId()).setProcessInstanceId(processInstanceId));
// 判断是否为重新发起的流程
if (createReqVO.getProcessInstanceId() != null && createReqVO.getResult() == 3) {
historyProcessInstanceService.createHistoryProcessInstance(processInstanceId, createReqVO.getProcessInstanceId());
}
List<UploadUserFile> fileItems = createReqVO.getFileItems() ;
//这里的逻辑如果fileItems不为空且有数据那么说明是上传了附件的则需要更工作流文件表对应的实例Id
if (fileItems != null && !fileItems.isEmpty()) {
uploadBpmFileProcessInstanceId(processInstanceId,fileItems) ;
}
return project.getId();
}
@Override
public void updateProjectResult(String processInstanceId, Long id, Integer result) {
validateLeaveExists(id);
//审核通过 最后节点
if (BpmProcessInstanceResultEnum.APPROVE.getResult().equals(result)) {
ProcessInstance instance = bpmProcessInstanceService.getProcessInstance(processInstanceId);
if (instance.isEnded()) {
}
}
projectMapper.updateById(new BpmOAProjectDO().setId(id).setResult(result));
}
private void validateLeaveExists(Long id) {
if (projectMapper.selectById(id) == null) {
throw exception(OA_PROJECT_NOT_EXISTS);
}
}
@Override
public BpmOAProjectDO getProject(Long id) {
return projectMapper.selectById(id);
}
@Override
public BpmOAProjectDO getByProcessInstanceId(String processInstanceId) {
return projectMapper.selectOne(BpmOAProjectDO::getProcessInstanceId, processInstanceId);
}
}

View File

@ -20,10 +20,10 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception; import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
import static cn.iocoder.yudao.module.bpm.enums.ErrorCodeConstants.OA_REFUND_CARD_NOT_EXISTS; import static cn.iocoder.yudao.module.bpm.enums.ErrorCodeConstants.OA_REFUND_NOT_EXISTS;
/** /**
* OA 转正申请 Service 实现类 * OA 退款申请 Service 实现类
* *
* @author 符溶馨 * @author 符溶馨
@ -33,7 +33,7 @@ import static cn.iocoder.yudao.module.bpm.enums.ErrorCodeConstants.OA_REFUND_CAR
public class BpmOARefundServiceImpl extends BpmOABaseService implements BpmOARefundService{ public class BpmOARefundServiceImpl extends BpmOABaseService implements BpmOARefundService{
/** /**
* OA 转正对应的流程定义 KEY * OA 退款对应的流程定义 KEY
*/ */
public static final String PROCESS_KEY = "oa_refund_2"; public static final String PROCESS_KEY = "oa_refund_2";
@ -52,7 +52,7 @@ public class BpmOARefundServiceImpl extends BpmOABaseService implements BpmOARef
@Override @Override
public Long createRefund(Long userId, BpmOARefundCreateReqVO createReqVO) { public Long createRefund(Long userId, BpmOARefundCreateReqVO createReqVO) {
//插入OA 转正申请 //插入OA 退款申请
BpmOARefundDO refund = BeanUtils.toBean(createReqVO, BpmOARefundDO.class) BpmOARefundDO refund = BeanUtils.toBean(createReqVO, BpmOARefundDO.class)
.setUserId(userId) .setUserId(userId)
.setResult(BpmProcessInstanceResultEnum.PROCESS.getResult()); .setResult(BpmProcessInstanceResultEnum.PROCESS.getResult());
@ -100,7 +100,7 @@ public class BpmOARefundServiceImpl extends BpmOABaseService implements BpmOARef
private void validateLeaveExists(Long id) { private void validateLeaveExists(Long id) {
if (refundMapper.selectById(id) == null) { if (refundMapper.selectById(id) == null) {
throw exception(OA_REFUND_CARD_NOT_EXISTS); throw exception(OA_REFUND_NOT_EXISTS);
} }
} }

View File

@ -0,0 +1,32 @@
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.service.oa.BpmOAProjectService;
import cn.iocoder.yudao.module.bpm.service.oa.BpmOAProjectServiceImpl;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
/**
* OA 项目申请单的结果的监听器实现类
*
* @author 符溶馨
*/
@Component
public class BpmOAProjectResultListener extends BpmProcessInstanceResultEventListener {
@Resource
private BpmOAProjectService projectService;
@Override
protected String getProcessDefinitionKey() {
return BpmOAProjectServiceImpl.PROCESS_KEY;
}
@Override
protected void onEvent(BpmProcessInstanceResultEvent event) {
projectService.updateProjectResult(event.getId(), Long.parseLong(event.getBusinessKey()), event.getResult());
}
}