开发指南
工作流手册

审批接入（业务表单）

# 1. 业务接入（业务表单）

根据业务需要，业务通过建立独立的数据库表（业务表）记录申请信息，而流程引擎只负责推动流程的前进或者结束。两者需要进行双向的关联：

每一条业务表记录，通过它的流程实例的编号( process_instance_id )指向对应的流程实例
每一个流程实例，通过它的业务键( BUSINESS_KEY_ ) 指向对应的业务表记录

以项目中提供的 OALeave (opens new window) 请假举例子，它的业务表 bpm_oa_leave 和流程引擎的流程实例的关系如下图：

请假单数据库表

也因为业务建立了独立的业务表，所以必须开发业务表对应的列表、表单、详情页面。不过，审核相关的功能是无需重新开发的，原因是业务表已经关联对应的流程实例，流程引擎审批流程实例即可。

下面，我们以项目中的 OALeave (opens new window) 为例子，详细讲解下业务表单的开发与使用的过程。

# 1.0 第零步：业务开发

# 1.0.1 新建业务表

新建业务表 bpm_oa_leave，建表语句如下：

CREATE TABLE `bpm_oa_leave` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT '请假表单主键',
  `user_id` bigint NOT NULL COMMENT '申请人的用户编号',
  `type` tinyint NOT NULL COMMENT '请假类型',
  `reason` varchar(200) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '请假原因',
  `start_time` datetime NOT NULL COMMENT '开始时间',
  `end_time` datetime NOT NULL COMMENT '结束时间',
  `day` tinyint NOT NULL COMMENT '请假天数',
  `status` tinyint NOT NULL COMMENT '请假结果',
  `process_instance_id` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '流程实例的编号',
  `creator` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '创建者',
  `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `updater` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '更新者',
  `update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  `deleted` bit(1) NOT NULL DEFAULT b'0' COMMENT '是否删除',
  `tenant_id` bigint NOT NULL DEFAULT '0' COMMENT '租户编号',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=26 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='OA 请假申请表';

重点是两个字段：

process_instance_id 字段，关联流程引擎的流程实例对应的 ACT_HI_PROCINST 表的 PROC_INST_ID_ 字段
status 字段，请假结果，需要通过 Listener 监听回调结果，稍后来看看

# 1.0.2 【后端】实现业务逻辑

实现业务表的【后端】业务逻辑，具体代码可以看看如下两个类：

重点是看流程发起的逻辑，它定义了 /bpm/oa/leave/create 给业务的表单界面调用，UML 时序图如下：

后续时序图

具体的实现代码比较简单，如下图所示：

BpmOALeaveServiceImpl 创建流程的逻辑

PROCESS_KEY 静态变量：是业务对应的流程模型的编号，稍后会进行创建编号为 oa_leave 的流程模型。
BpmProcessInstanceApi (opens new window) 定义了 #createProcessInstance(...) 方法，用于创建流程实例，业务无需关心底层是 Flowable 引擎，还是 Activiti、Camunda 引擎。

# 1.0.3 【前端】实现业务逻辑

实现业务表的【前端】业务逻辑，具体代码可以看看如下三个页面：

请假发起界面：leave/create.vue (opens new window)
请假详情界面：leave/detail.vue (opens new window)
请假列表界面：leave/index.vue (opens new window)

另外，在 router/modules/remaining.ts (opens new window) 中定义 create.vue 和 detail.vue 的路由，配置如下：

{
    path: '/bpm',
    component: Layout,
    name: 'bpm',
    meta: {
      hidden: true
    },
    children: [
      {
        path: 'oa/leave/create',
        component: () => import('@/views/bpm/oa/leave/create.vue'),
        name: 'OALeaveCreate',
        meta: {
          noCache: true,
          hidden: true,
          canTo: true,
          title: '发起 OA 请假',
          activeMenu: '/bpm/oa/leave'
        }
      },
      {
        path: 'oa/leave/detail',
        component: () => import('@/views/bpm/oa/leave/detail.vue'),
        name: 'OALeaveDetail',
        meta: {
          noCache: true,
          hidden: true,
          canTo: true,
          title: '查看 OA 请假',
          activeMenu: '/bpm/oa/leave'
        }
      }
    ]
}

为什么要做独立的 `create.vue` 和 `index.vue` 页面？

创建流程时，需要跳转到 create.vue 页面，填写业务表的信息，才能提交流程。
审批流程时，需要跳转到 detail.vue 页面，查看业务表的信息。

# 1.0.4 【实现】实现审批结果的监听

审批结束时（例如说流程实例最终被审批通过、不通过、取消），后端需要监听审批结果，然后更新业务表的状态。

具体可见 BpmOALeaveStatusListener (opens new window) 监听器，它实现流程引擎定义的 BpmProcessInstanceStatusEventListener (opens new window) 抽象类，在流程实例结束时，回调通知它最终的结果是通过还是不通过。代码如下图：

图片纠错：最新版本将 yudao-module-bpm-biz 子模块，重命名为 yudao-module-bpm-server 子模块，更好表达它是一个服务

BpmOALeaveStatusListener 监听结果