资源描述
数据库备份项目设计文档一 需求描述 为了方便数据库数据备份，开发一个独立的可视化配置的系统。管理员通过配置数据源和定时任务来定时备份该数据库，并生成操作记录。当备份失败系统异常时，邮件通知开发人员，及时查看原因。二 流程图 三 实体关系图1 功能设计1.1 基本实体类BaseEntity字段名称字段类型是否必填备注idString是主键createDateDate是创建时间modifyDateDate否修改时间1.2 返回对象Message字段名称字段类型是否必填备注type枚举 是/* 成功 */success,/* 错误 */errormsgString否返回信息statusIntegre是状态码200 为成功500 失败dataObject否返回的数据对象1.3 用户管理功能1.3.1 功能概述管理员对用户的操作管理1.3.2 用例描述1.3.3 重要的业务处理流程 1.3.4 类设计1.3.4.1 Entity实体类设计User extends BaseEntity字段名称字段类型是否必填备注userNameString是用户名passWordString是密码（md5加密）disableBoolean是是否禁用 默认false 1.3.4.2 Controller接口类设计1.3.4.3 重要方法、算法以及难点解决方案描述1.1.4 角色管理功能1.4.1 功能概述管理员对用户的角色操作管理1.4.2 用例描述1.4.3 重要的业务处理流程 1.4.4 类设计1.4.4.1 Entity实体类设计Role extends BaseEntity字段名称字段类型是否必填备注roleNameString是角色名valueString是角色标识管理员为 1其他为2 1.4.4.2 Controller接口类设计1.4.4.3 重要方法、算法以及难点解决方案描述1.5 权限管理功能1.5.1 功能概述管理员对权限的操作管理1.5.2 用例描述1.5.3 重要的业务处理流程 1.5.4 类设计1.5.4.1 Entity实体类设计Resources extends BaseEntity字段名称字段类型是否必填备注nameString是权限资源名 1.5.4.2 Controller接口类设计1.5.4.3 重要方法、算法以及难点解决方案描述1.6 任务管理功能1.6.1 功能概述管理员配置数据源和定时任务的操作管理1.6.2 用例描述1.6.3 重要的业务处理流程 管理员：用户：1.6.4 类设计1.6.4.1 Entity实体类设计Task extends BaseEntity字段名称字段类型是否必填备注nameString是数据库名称hostString是链接地址userNameString是数据库用户名passWordString是数据库密码portString是数据库端口号timeString是时间表达式规则（每天定时） 1.6.4.2 Controller接口类设计TaskController /添加 完成后 把该任务放到任务调度中，并添加操作记录 Public Message save(Task task); /编辑完成后 把该任务更新到任务调度中，并添加操作记录 Public Message update(Task task);/删除完成后 把该任务从任务调度中删除 并添加操作记录Public Message deletes(Long ids); TaskeUtil 任务调度工具类 （大数据平台 案例） DbUtil 导入导出数据备份工具类1.6.4.3 重要方法、算法以及难点解决方案描述1.7 操作记录管理功能1.7.1 功能概述为了记录操作人员的操作行为1.7.2 用例描述1.7.3 类设计1.7.3.1 Entity实体类设计Logs extends BaseEntity字段名称字段类型是否必填备注contentString是操作内容nameString是操作人taskIdString是任务id 1.7.3.2 Controller接口类设计 LogsController /* * 查询 分页 * takeId任务id 为了查询一个库下的操作记录 * startTime endTime按时间查询 userId按用户查询 */ Public Message getDate(String takeId,String startTime,String endTime,Sting userId,Integer pagSize,Integer page)；1.7.3.3 重要方法、算法以及难点解决方案描述1.8 系统管理功能1.8.1 功能概述统一配置管理系统信息1.8.2 用例描述 1.8.3 类设计1.8.3.1 Entity实体类设计System extends BaseEntity字段名称字段类型是否必填备注urlString是导出文件存放路径fromEmailString是发邮件邮箱toEmailString是收件人邮箱 1.8.3.2 Controller接口类设计 SystemController /修改更新 Public Message updateSystem(System system);1.8.3.3 重要方法、算法以及难点解决方案描述
展开阅读全文