企业官网建设流程全解析

网络宣传网站建设制作,wordpress qq登录微信登录,合肥网站建设套餐,手机wap端若依工作流模型管理模块 - 需求分析设计文档接口文档 一、需求分析 1. 核心业务背景 该模块是若依#xff08;RuoYi-Vue-Plus#xff09;框架集成Activiti工作流引擎的核心模块#xff0c;聚焦流程模型全生命周期管理#xff0c;解决从模型创建、编辑、部署到导出、转换…若依工作流模型管理模块 - 需求分析设计文档接口文档一、需求分析1. 核心业务背景该模块是若依RuoYi-Vue-Plus框架集成Activiti工作流引擎的核心模块聚焦流程模型全生命周期管理解决从模型创建、编辑、部署到导出、转换的全流程管理需求适配企业级流程设计与执行的业务场景。2. 核心业务需求需求分类具体需求点业务价值模型基础管理1. 新建流程模型含参数校验2. 查询模型列表分页3. 删除模型批量实现流程模型的增删查基础操作支撑模型库管理模型编辑与存储1. 保存模型XML配置2. 查询模型XML编辑内容适配流程设计器如bpmn-js的在线编辑场景持久化设计结果模型部署通过模型ID部署流程定义将设计好的模型转换为可执行的流程定义落地业务流程模型导出导出模型为ZIP压缩包支持模型备份、离线传输或跨环境迁移模型转换将已部署的流程定义反向转换为模型支持对已上线流程的二次编辑无需重新设计3. 非功能需求参数校验所有入参如模型ID、流程定义ID需做非空/格式校验避免无效请求防重复提交新增、修改、删除操作需防重复提交避免数据异常事务控制批量删除模型需保证事务一致性失败则回滚日志记录核心操作新增、修改、部署、删除需记录业务日志便于审计异常处理所有操作需返回统一格式结果成功/失败前端可友好展示兼容性适配Activiti引擎的模型/流程定义数据结构保证数据互通。4. 边界约束仅管理Activiti的Model模型对象不直接操作流程实例/任务模型部署后生成ProcessDefinition流程定义需关联模型ID便于追溯仅支持单模型导出ZIP暂不支持批量导出反向转换仅支持“流程定义→模型”不支持模型→流程实例的直接转换。二、设计文档1. 架构设计1.1 分层设计遵循若依框架的分层架构模块内部分层如下Controller层ModelControllerService层IModelServiceServiceImpl层ModelServiceImplActiviti核心APIRepositoryService数据库Activiti核心表若依扩展表Controller层接收前端请求做参数校验、请求分发返回统一响应Service层封装核心业务逻辑如模型部署、转换、导出Activiti API层调用Activiti的RepositoryService操作模型/流程定义数据层基于Activiti原生表act_re_model/act_re_procdef存储核心数据。1.2 核心类设计类名作用核心依赖ModelController模型管理接口入口IModelService、RepositoryServiceIModelService模型业务逻辑接口-ModelServiceImpl模型业务逻辑实现RepositoryService、ObjectMapper、HttpServletResponseModelBo模型请求参数BO封装前端入参模型名称、key、分类、版本等1.3 数据模型设计核心关联表表名作用核心字段act_re_model存储流程模型基础信息ID_模型ID、NAME_名称、KEY_标识、CATEGORY_分类、DEPLOYMENT_ID_关联部署IDact_re_procdef存储部署后的流程定义ID_流程定义ID、KEY_模型标识、DEPLOYMENT_ID_部署ID、VERSION_版本act_ge_bytearray存储模型XML/流程图二进制内容ID_、NAME_资源名称、BYTES_二进制内容、DEPLOYMENT_ID_2. 核心流程设计2.1 新建模型流程前端提交模型参数名称/key/分类Controller参数校验AddGroupService创建空Model对象设置模型元信息名称/key/分类/版本校验模型key唯一性保存模型到act_re_model初始化模型XML配置并存储到act_ge_bytearray返回模型信息给前端2.2 模型部署流程前端传入模型IDController参数校验非空Service查询模型基础信息读取模型XML配置并转换为BpmnModel调用Activiti API创建部署更新模型的DEPLOYMENT_ID_字段返回部署结果给前端3. 关键设计要点参数校验通过Validated分组AddGroup/EditGroup实现新增/编辑场景的差异化校验防重复提交通过RepeatSubmit注解拦截重复请求避免重复创建/修改模型事务控制批量删除模型添加Transactional保证删除操作的原子性统一响应通过R若依统一响应类返回结果前端可统一解析日志审计通过Log注解记录操作日志包含操作类型、标题支撑审计需求。三、接口文档1. 接口基础信息项名内容接口前缀/workflow/model请求方式GET/PUT/POST/DELETE响应格式JSON统一响应体R统一响应体结构json{“code”: 200, // 状态码200成功500失败“msg”: “操作成功”, // 提示信息“data”: {} // 业务数据可选}### 2. 接口详情 #### 2.1 新建模型 - **接口地址**POST /workflow/model - **接口名称**新建流程模型 - **接口描述**创建空的流程模型初始化基础元信息并存储 - **请求参数**RequestBody | 参数名 | 类型 | 是否必填 | 说明 | |--------|------|----------|------| | name | String | 是 | 模型名称 | | key | String | 是 | 模型标识唯一 | | category | String | 否 | 模型分类 | | version | Integer | 否 | 模型版本 | | description | String | 否 | 模型描述 | - **请求示例** json { name: 采购审批流程, key: purchase_approval, category: 采购管理, version: 1, description: 企业采购审批全流程 }响应示例{code:200,msg:操作成功,data:{id:150001,name:采购审批流程,key:purchase_approval,category:采购管理,version:1,deploymentId:null}}2.2 查询模型列表接口地址GET /workflow/model/list接口名称分页查询模型列表接口描述根据条件分页查询流程模型列表请求参数RequestParam| 参数名 | 类型 | 是否必填 | 说明 ||--------|------|----------|------|| name | String | 否 | 模型名称模糊查询 || key | String | 否 | 模型标识精确查询 || category | String | 否 | 模型分类精确查询 || pageNum | Integer | 是 | 页码默认1 || pageSize | Integer | 是 | 页大小默认10 |响应示例{code:200,msg:操作成功,data:{total:50,rows:[{id:150001,name:采购审批流程,key:purchase_approval,category:采购管理,version:1,deploymentId:160001}]}}2.3 保存模型XML接口地址PUT /workflow/model接口名称保存模型XML配置接口描述保存流程设计器编辑后的模型XML内容请求参数RequestBody| 参数名 | 类型 | 是否必填 | 说明 ||--------|------|----------|------|| modelId | String | 是 | 模型ID || xmlContent | String | 是 | 模型XML配置内容BPMN 2.0格式 |请求示例{modelId:150001,xmlContent:definitions xmlns\http://www.omg.org/spec/BPMN/20100524/MODEL\.../definitions}响应示例{code:200,msg:操作成功,data:null}2.4 查询模型XML内容接口地址GET /workflow/model/getInfo/{modelId}/xml接口名称查询模型XML编辑内容接口描述获取指定模型的XML配置供流程设计器加载路径参数| 参数名 | 类型 | 是否必填 | 说明 ||--------|------|----------|------|| modelId | String | 是 | 模型ID |响应示例{code:200,msg:操作成功,data:{xmlContent:definitions xmlns\http://www.omg.org/spec/BPMN/20100524/MODEL\.../definitions,modelInfo:{name:采购审批流程,key:purchase_approval}}}2.5 模型部署接口地址POST /workflow/model/deploy/{id}接口名称部署流程模型接口描述将模型转换为可执行的流程定义路径参数| 参数名 | 类型 | 是否必填 | 说明 ||--------|------|----------|------|| id | String | 是 | 模型ID |响应示例{code:200,msg:部署成功,data:null}2.6 批量删除模型接口地址DELETE /workflow/model/{ids}接口名称批量删除模型接口描述删除指定ID的流程模型支持批量路径参数| 参数名 | 类型 | 是否必填 | 说明 ||--------|------|----------|------|| ids | String[] | 是 | 模型ID数组多个用逗号分隔如150001,150002 |响应示例{code:200,msg:删除成功,data:null}2.7 导出模型ZIP接口地址GET /workflow/model/export/zip/{modelId}接口名称导出模型为ZIP包接口描述将模型XML和基础信息导出为ZIP压缩包支持下载路径参数| 参数名 | 类型 | 是否必填 | 说明 ||--------|------|----------|------|| modelId | String | 是 | 模型ID |响应说明直接返回ZIP文件流前端触发下载2.8 流程定义转模型接口地址PUT /workflow/model/convertToModel/{processDefinitionId}接口名称流程定义转模型接口描述将已部署的流程定义反向转换为可编辑的模型路径参数| 参数名 | 类型 | 是否必填 | 说明 ||--------|------|----------|------|| processDefinitionId | String | 是 | 流程定义ID |响应示例{code:200,msg:转换成功,data:null}3. 异常响应示例{code:500,msg:模型标识已存在,data:null}四、总结1. 核心亮点覆盖流程模型全生命周期管理适配企业级流程设计场景遵循若依框架规范统一参数校验、响应格式、日志审计深度集成Activiti引擎保证模型与流程定义的互通接口设计RESTful风格语义清晰便于前后端对接。2. 扩展建议新增模型版本管理接口支持模型版本回溯新增模型复制接口减少重复设计成本新增模型权限控制限制不同角色对模型的操作权限补充接口入参的格式校验如模型key的正则校验。