工作流模块提交

pqs-bpm/bpm-api/src/main/java/com/njcn/bpm/enums/BpmConstants.java

@@ -0,0 +1,40 @@
+package com.njcn.bpm.enums;
+
+import org.flowable.engine.runtime.ProcessInstance;
+
+/**
+ * BPM 通用常量
+ *
+ * @author 芋道源码
+ */
+public class BpmConstants {
+
+    /**
+     * 流程实例的变量 - 状态
+     *
+     * @see ProcessInstance#getProcessVariables()
+     */
+    public static final String PROCESS_INSTANCE_VARIABLE_STATUS = "PROCESS_STATUS";
+    /**
+     * 流程实例的变量 - 发起用户选择的审批人 Map
+     *
+     * @see ProcessInstance#getProcessVariables()
+     */
+    public static final String PROCESS_INSTANCE_VARIABLE_START_USER_SELECT_ASSIGNEES = "PROCESS_START_USER_SELECT_ASSIGNEES";
+
+    /**
+     * 任务的变量 - 状态
+     *
+     * @see org.flowable.task.api.Task#getTaskLocalVariables()
+     */
+    public static final String TASK_VARIABLE_STATUS = "TASK_STATUS";
+    /**
+     * 任务的变量 - 理由
+     *
+     * 例如说：审批通过、不通过的理由
+     *
+     * @see org.flowable.task.api.Task#getTaskLocalVariables()
+     */
+    public static final String TASK_VARIABLE_REASON = "TASK_REASON";
+
+}

pqs-bpm/bpm-api/src/main/java/com/njcn/bpm/enums/BpmModelFormTypeEnum.java

@@ -0,0 +1,31 @@
+package com.njcn.bpm.enums;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+import java.util.Arrays;
+
+/**
+ * BPM 模型的表单类型的枚举
+ *
+ * @author 芋道源码
+ */
+@Getter
+@AllArgsConstructor
+public enum BpmModelFormTypeEnum implements IntArrayValuable {
+
+    NORMAL(10, "流程表单"), // 对应 BpmFormDO
+    CUSTOM(20, "业务表单") // 业务自己定义的表单，自己进行数据的存储
+    ;
+
+    public static final int[] ARRAYS = Arrays.stream(values()).mapToInt(BpmModelFormTypeEnum::getType).toArray();
+
+    private final Integer type;
+    private final String name;
+
+    @Override
+    public int[] array() {
+        return ARRAYS;
+    }
+
+}

pqs-bpm/bpm-api/src/main/java/com/njcn/bpm/enums/BpmResponseEnum.java

@@ -0,0 +1,50 @@
+package com.njcn.bpm.enums;
+
+import lombok.Getter;
+
+/**
+ * 异常处理类
+ * @author qijian
+ * @version 1.0.0
+ * @date 2022年11月11日 09:56
+ */
+@Getter
+public enum BpmResponseEnum {
+
+    /**
+     * 过程监督异常响应码的范围：
+     * A00550 ~ A00649
+     */
+    BPM_COMMON_ERROR("A00568","工作流模块异常"),
+
+    BPM_XML_ERROR("A00568","流程标识格式不正确，需要以字母或下划线开头，后接任意字母、数字、中划线、下划线、句点！"),
+
+    BPM_MODEL_REPEAT("A00568","流程标识已存在"),
+
+    BPM_MODEL_NOT_EXIST("A00568","流程模型不存在"),
+
+    PROCESS_DEFINITION_NOT_EXISTS("A00568","流程定义不存在"),
+
+    FORM_NOT_EXISTS("A00568","动态表单不存在"),
+
+    MODEL_DEPLOY_FAIL_FORM_NOT_CONFIG("A00568","部署流程失败，原因：流程表单未配置，请点击【修改流程】按钮进行配置"),
+
+    BPM_START_EVENT_NOT_EXIST("A00568","起始事件不存在"),
+
+    MODEL_DEPLOY_FAIL_BPMN_USER_TASK_NAME_NOT_EXISTS("A00568","部署流程失败，原因：BPMN 流程图中，用户任务的名字不存在"),
+
+    REPEAT_NAME_FORM("A00568","流程表单名称重复"),
+
+    REPEAT_CATEGORY_NAME_FORM("A00568","流程类型名称重复"),
+
+    ;
+
+    private final String code;
+
+    private final String message;
+
+    BpmResponseEnum(String code, String message) {
+        this.code = code;
+        this.message = message;
+    }
+}

pqs-bpm/bpm-api/src/main/java/com/njcn/bpm/enums/BpmTaskCandidateStrategyEnum.java

@@ -0,0 +1,41 @@
+package com.njcn.bpm.enums;
+
+import cn.hutool.core.util.ArrayUtil;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+/**
+ * BPM 任务的候选人策略枚举
+ *
+ * 例如说：分配给指定人审批
+ *
+ * @author 芋道源码
+ */
+@Getter
+@AllArgsConstructor
+public enum BpmTaskCandidateStrategyEnum {
+
+    ROLE(10, "角色"),
+    DEPT_MEMBER(20, "部门的成员"), // 包括负责人
+    DEPT_LEADER(21, "部门的负责人"),
+    POST(22, "岗位"),
+    USER(30, "用户"),
+    START_USER_SELECT(35, "发起人自选"), // 申请人自己，可在提交申请时选择此节点的审批人
+    USER_GROUP(40, "用户组"),
+    EXPRESSION(60, "流程表达式"), // 表达式 ExpressionManager
+    ;
+
+    /**
+     * 类型
+     */
+    private final Integer strategy;
+    /**
+     * 描述
+     */
+    private final String description;
+
+    public static BpmTaskCandidateStrategyEnum valueOf(Integer strategy) {
+        return ArrayUtil.firstMatch(o -> o.getStrategy().equals(strategy), values());
+    }
+
+}

pqs-bpm/bpm-api/src/main/java/com/njcn/bpm/enums/BpmnModelConstants.java

@@ -0,0 +1,26 @@
+package com.njcn.bpm.enums;
+
+/**
+ * BPMN XML 常量信息
+ *
+ * @author 芋道源码
+ */
+public interface BpmnModelConstants {
+
+    String BPMN_FILE_SUFFIX = ".bpmn";
+
+    /**
+     * BPMN 中的命名空间
+     */
+    String NAMESPACE = "http://flowable.org/bpmn";
+
+    /**
+     * BPMN UserTask 的扩展属性，用于标记候选人策略
+     */
+    String USER_TASK_CANDIDATE_STRATEGY = "candidateStrategy";
+    /**
+     * BPMN UserTask 的扩展属性，用于标记候选人参数
+     */
+    String USER_TASK_CANDIDATE_PARAM = "candidateParam";
+
+}

pqs-bpm/bpm-api/src/main/java/com/njcn/bpm/enums/ErrorCode.java

@@ -0,0 +1,29 @@
+package com.njcn.bpm.enums;
+
+import lombok.Data;
+
+/**
+ * 错误码对象
+ *
+ * 全局错误码，占用 [0, 999], 参见 {@link GlobalErrorCodeConstants}
+ *
+ * TODO 错误码设计成对象的原因，为未来的 i18 国际化做准备
+ */
+@Data
+public class ErrorCode {
+
+    /**
+     * 错误码
+     */
+    private final Integer code;
+    /**
+     * 错误提示
+     */
+    private final String msg;
+
+    public ErrorCode(Integer code, String message) {
+        this.code = code;
+        this.msg = message;
+    }
+
+}

pqs-bpm/bpm-api/src/main/java/com/njcn/bpm/enums/GlobalErrorCodeConstants.java

@@ -0,0 +1,40 @@
+package com.njcn.bpm.enums;
+
+
+/**
+ * 全局错误码枚举
+ * 0-999 系统异常编码保留
+ *
+ * 一般情况下，使用 HTTP 响应状态码 https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Status
+ * 虽然说，HTTP 响应状态码作为业务使用表达能力偏弱，但是使用在系统层面还是非常不错的
+ * 比较特殊的是，因为之前一直使用 0 作为成功，就不使用 200 啦。
+ *
+ * @author 芋道源码
+ */
+public interface GlobalErrorCodeConstants {
+
+    ErrorCode SUCCESS = new ErrorCode(0, "成功");
+
+    // ========== 客户端错误段 ==========
+
+    ErrorCode BAD_REQUEST = new ErrorCode(400, "请求参数不正确");
+    ErrorCode UNAUTHORIZED = new ErrorCode(401, "账号未登录");
+    ErrorCode FORBIDDEN = new ErrorCode(403, "没有该操作权限");
+    ErrorCode NOT_FOUND = new ErrorCode(404, "请求未找到");
+    ErrorCode METHOD_NOT_ALLOWED = new ErrorCode(405, "请求方法不正确");
+    ErrorCode LOCKED = new ErrorCode(423, "请求失败，请稍后重试"); // 并发请求，不允许
+    ErrorCode TOO_MANY_REQUESTS = new ErrorCode(429, "请求过于频繁，请稍后重试");
+
+    // ========== 服务端错误段 ==========
+
+    ErrorCode INTERNAL_SERVER_ERROR = new ErrorCode(500, "系统异常");
+    ErrorCode NOT_IMPLEMENTED = new ErrorCode(501, "功能未实现/未开启");
+    ErrorCode ERROR_CONFIGURATION = new ErrorCode(502, "错误的配置项");
+
+    // ========== 自定义错误段 ==========
+    ErrorCode REPEATED_REQUESTS = new ErrorCode(900, "重复请求，请稍后重试"); // 重复请求
+    ErrorCode DEMO_DENY = new ErrorCode(901, "演示模式，禁止写操作");
+
+    ErrorCode UNKNOWN = new ErrorCode(999, "未知错误");
+
+}

pqs-bpm/bpm-api/src/main/java/com/njcn/bpm/enums/IntArrayValuable.java

@@ -0,0 +1,15 @@
+package com.njcn.bpm.enums;
+
+/**
+ * 可生成 Int 数组的接口
+ *
+ * @author 芋道源码
+ */
+public interface IntArrayValuable {
+
+    /**
+     * @return int 数组
+     */
+    int[] array();
+
+}