基于网页的班级民主评议系统概要设计终极版.doc

文档编号 08KY025 JS 0003 基于网页的班级民主评议系统基于网页的班级民主评议系统 项目项目 系统设计说明书 熊莉 小组 2011 年 4 月 WS 多通道同步数字记录仪升级换代 系统设计说明书 I 修改记录 版本变更原因变更内容简述 编制 修 订者 批准者 发布 日期 v1 0 1 1 Build 2011 11 30 创建XXX 2 目 录 1引言引言 3 1 1编写目的 3 1 2项目背景 4 1 3定义 4 1 4参考资料 4 2 条件与限制条件与限制 5 3需求规需求规 定定 6 4运行环境运行环境 6 4 1硬件环境 6 4 2软件环境 6 5逻辑结逻辑结构构设计设计 7 5 1用户人机界面 8 5 2管理员人机界面 9 5 3用户 7 5 4管理员 16 5 5 数据库访问 21 6数据 库 结数据 库 结构构设计设计 24 7部署设计部署设计 25 8运行设计运行设计 28 9性能设计性能设计 28 10系统出错处理设计系统出错处理设计 28 10 1出错信息 28 10 2补救措施 28 10 3系统维护设计 29 3 10 4错误处理设计 29 11开发环境开发环境 29 12尚未解决的尚未解决的问问题题 30 1 1 引言引言 1 1编写目的 本系统设计说明书用于描述基于网页的班级民主评议系统项目的整体系统 设计方案 本说明书以 用户需求说明书 和 系统需求规格说明书 作为依 据 本说明书是系统详细设计的依据 也作为系统测试需求和系统测试计划和 测试程序的重要参考 本系统概要设计说明书的阅读对象为 项目经理 开发 工程师 测试工程师 CM 工程师 QA 工程师 MA 工程师 1 2项目背景 项目委托单位无 开发单位是以熊莉 彭萍 李婉怡 罗秀娟 任思琪 熊 皎宇为小组的计科 09 级同学 主管部门 无 该系统嵌于网页使用 1 3定义 1 CSCI Compute Software Config Item 2 评议 对各参评学生给出分值 3 运行模块组合 描述对系统施加不同的外界运行控制时所引起的各种不同的 运行模块组合 说明每种运行所历经的内部模块和支持软件 4 需求规定 概要说明用户的需求和软件的需求规定 5 系统结构 着重从硬件 诸如网络 服务器 终端 打印机等 方面 用图 形和文字方法描述系统的结构 4 6 软件结构 着重从软件架构 诸如现有的系统 子系统 层等 方面 用图 形和文字方法描述系统的软件结构 7 用户人机界面 连接用户与系统 8 MdslStatus 记录单元状态 9 SysControlStatus 系统状态 10 BasicPublic 网络与公共基础支持 1 4参考资料 文档所引用的资料 基于网页的班级民主评议系统需求说明书 2条件与限制 2 1 需求约束 a 本系统应当遵循的标准或规范 数据命名的规则遵循 Java 语言编程规约 中相关的规定 b 软件 硬件环境 包括运行环境和开发环境 的约束 系统软件的软件平台是 操作系统 Windows XP Windows 7 eclipse3 5 硬件平台是 core2 显存 512M 主频 2 0khz c 接口 协议的约束 消息和通信协议数据采用 TCP IP 协议 通过界面键盘 鼠 标输入 d 用户界面的约束 使用 WINDOWS 图形化界面 屏幕格式 网页格式 报表格式 Excel 格式 输入输出时间 30 分钟以内 e 软件质量的约束 正确性 系统必须交易能够被正确处理 5 健壮性 系统应能够 7 24 小时无故障运行 效率 系统可以支持 100 个终端同时发起交易 数据录入及一般的交互使用 及一般的查询响应时间不超过 5 秒 易用性 用户界面应采用图形化操作方式 便于用户操作 安全性 对数据进行安全保护 具有方便可行的数据备份及数据恢复能力 系统中登录密码以密文的方式传输 可扩展性 应该充分考虑到将来交易的修改或增加 避免需求变更时大规模修 改程序 2 2 隐含约束 a 使用评议系统人员是学生 他们具有基本的电脑知识 对他们提供的操作界 面应 保证他们经过简单学习后无障碍的操作 b 报表应该可以在多种操作系统上浏览 打印 c 系统应提供审记追踪功能 d 应该把有可能变动的参数存放到配置文件或数据库中 保证修改参数的灵活 性 3需求规定需求规定 系统能实现学生正常登录并进行查询 评议 系统应在联网条件下正常运行 系统应该能对数据进行备份 系统应能实时监控系统的工作状态和报警状态 系统应能满足响应时间不超过 5 秒 6 系统应具备用户分级权限控制功能 详细需求参见 系统需求规格说明书 4运行环境运行环境 4 1硬件环境 服务器硬件配置 PC 服务器 处 理 器 Xeon E5504 内存 2G DDR3 REG ECC 硬盘 SATA2 500G 客户端硬件配置 主流 CPU 均可 内存 64Mb 以上 硬盘 3G 以上 4 2软件环境 服务器软件配置 操作系统 Windows Server 2003 客户端软件配置 采用 B S 结构 IE6 0 以上 7 5逻辑结构设计 CSCI 1 用用户户 人人机机界界面面 CSCI 2 系系统统 管管理理人人机机界界 面面 CSCI 3 用用户户 CSCI 4 管管理理 员员 CSCI 5 数数据据 库库访访 图 5 1 系统顶层软件结构图 如图 5 1 系统由 5 个顶层软件模块组成 1 用户人机界面 实现对用户请求的响应并显示在屏幕上 2 管理员人机界面包 实现对管理员请求的响应并显示在屏幕上 3 用户 登录进入系统并进行评议 4 管理员 登录进入系统并可查询当前评议情况 评议完成发布结果 5 数据库访问 为用户或者管理员的请求响应提供数据以显示 5 1 CSCI 列表 表表 5 1 1 全系统全系统 CSCI 列表列表 模块名称 标识功能简述 8 用户人机界面 CSCI 1 存储和提高用户信息 实现用户的登录和评议等 管理员人机界面 CSCI 2 实现对管理员登陆后的需求响应 包括显示用户信息 查看评议情况 用户 CSCI 3 实现对学生用户登录 查询以及评议 管理员 CSCI 4 实现管理员对学生评议结果信息的审核 记录 公示 数据库访问 CSCI 5 实现用户对数据库的访问 保存访问后的数据结果 实 现管理员对数据库的访问 以及日期截止后对数据库结 果的发放 5 2 CSCI 关系图 见图 5 1 5 3 CSCI 1 用户人机界面用户人机界面 5 3 1 模块名称 用户人机界面 5 3 2 功能描述 存储和提高用户信息 实现用户的登录和评议等 具体功能如下 设置权限 在登录时用户要求输入用户名和密码 用户可以在界面上选择退出或者是进入下一步评议 用户可以在评议的界面上进行评议并保存 用户可以查询自己对别人的评议结果 在所有结果出来之后 用户可以查看别人对自己的评议结果 9 本包和其他包的关系图参见图 5 1 5 3 3 接口描述 5 3 3 1 输入接口 本包调用了用户包的函数 如 在登录是要输入的用户名和密码 本包从数据库包 网络包中获得数据结构 用于提供给用户各种命令 和行为 本包通过设备管理接口 如 键盘 鼠标 从外部设备输入的数据有 命令的选择 空格的填充等 5 3 3 2 输出接口 无 5 3 4流程描述 用户在联网的情况下登录系统 先用到 用户包 的一些数据结构和函数 然 后用到 用户人机界面包 用户利用此包可以在网页上进行操作 如 评议 查询 此时用户也会用到 数据库包 的一些数据结构和函数 用户登录 由用户人机界面提供 评议 由用户人机界面 用户包 数据库提供 更改密码 用户人机界面 用户包提供 用户查询 由用户人机界面 数据库提供 退出 图 5 3 4 用户人机界面活动图 10 5 3 5补充说明 无 5 4 CSCI 2 系统管理人机界面系统管理人机界面 5 4 1 模块名称 系统管理人机界面 5 4 2 功能描述 实现对管理员登陆后的需求响应 包括显示用户信息 查看评议情况 管理员查看注册参评用户个信息人 查看当前已经参与评议的人数 查看当前评议的结果 本包和其他包的关系图 如图 5 4 2 CSCI 2 系系统统 管管理理人人机机界界 面面 CSCI 4 管管理理 员员 CSCI 5 数数据据 库库访访问问 图 5 4 2 系统人机界面与其他包关系图 5 4 35 4 3 接口描述 5 4 3 15 4 3 1 输入接口 管理员命令输入 1 输入条件 11 当管理员处于成功登录状态时 系统响应管理员的输入命令 2 传递消息定义 INFOR 需查询的信息 BYTE 存储区类型 主存储区 备份存储区 还原存储区 3 传输方式 函数调用 数据库提供管理员所查询请求的数据 1 输入条件 管理员处于成功登录状态 并向系统发出信息查询命令 2 传递消息定义 INFOR 需查询的信息 BYTE 存储区类型 主存储区 备份存储区 还原存储区 3 传递方式 函数调用 5 4 3 25 4 3 2 输出接口 无 5 2 45 2 4 补充说明 无 5 5 CSCI 3 用户用户 5 5 1模块名称 用户 5 5 2功能描述 实现对学生用户登录 查询以及评议 具体功能如下 根据学生输入的 ID 密码参数决定学生是否登录成功 记录学生的个人信息 ID 密码 姓名 记录学生的评议信息 本包和其他包的关系图 见图 5 5 2 12 CSCI 1 用用户户 人人机机界界面面 CSCI 3 用用户户 CSCI 5 数数据据 库库访访问问 图 5 5 2 CSCI 3 用户与其他包关系图 5 5 3接口描述 5 5 3 1 输入接口 接口 1 学生个人信息 接口 2 学生评议信息 接口 3 学生查询评议信息 5 5 3 1 1 接口 1 1 输入条件 学生权限 学生个人信息界面 2 传递消息定义 记录的学生权限 记录学生所在位置 3 传输方式 函数调用 13 5 5 3 1 2 接口 2 1 输入条件 学生权限 学生个人信息界面 2 传递消息定义 记录的学生权限 记录学生所在页面 3 传输方式 驱动程序系统调用 5 5 3 1 3 接口 3 1 输入条件 学生权限 学生个人信息界面 2 传递消息定义 记录的学生权限 记录学生所在页面 3 传输方式 驱动程序系统调用 5 5 3 2 输出接口 接口 1 学生个人信息 接口 2 评议信息 接口 3 评议结果 5 5 3 2 1 接口 1 1 输出条件 学生或管理员权限验证成功且发出显示个人信息界面的申请 2 传递消息定义 信息主存储区 3 传输方式 输出至用户界面 5 5 3 2 2 接口 2 1 输出条件 14 学生发出显示评议信息界面的申请 2 传递消息定义 信息主存储区 3 传输方式 输出至访问用户界面 5 5 3 2 3 接口 3 1 输出条件 学生权限验证成功且申请显示评议结果界面 2 传递消息定义 信息主存储区 3 传输方式 输出至用户界面 5 5 4 流程描述 5 5 4 1 用户登录 登陆 输入用户名和 密码正确 是否 弹出窗口1或2进入菜单页面 图图 5 5 4 1 学生登录学生登录 5 5 4 2 用户更改密码 15 进入更改密码页面 更改密码成功更改密码 退出 是 否 是 否 图图 5 5 4 2 学生评议学生评议 5 5 4 3 用户进入菜单页面进行选择 进入菜单页面 选择页面选择查询页面选择评议页面 已经发布评议 结果 弹出窗口3 是 进入查询页面 否 退出 图图 5 5 4 3 菜单选择菜单选择 16 5 5 4 4 用户评议 进入评议页面 提交 退出评议 提交成功 弹出窗口4弹出窗口5 是否 弹出窗口6 退出 图图 5 5 4 4 用户评议用户评议 5 5 4 5 用户查询 进入查询页面 查询评议结果退出 图图 5 5 4 5 结果查询结果查询 17 5 6 CSCI 4 管理员管理员 5 6 1模块名称 管理员 5 6 2功能描述 实现管理员对学生评议结果信息的审核 记录 公示 具体功能如下 管理学生的个人信息 管理学生的评议信息 对学生评议信息审核 发布评议结果 本包和其他包关系图 见图 5 6 2 CSCI 2 系系统统 管管理理人人机机界界 面面 CSCI 4 管管理理 员员 CSCI 5 数数据据 库库访访 图 5 6 2 CSCI 4 管理员关系图 18 5 6 3接口描述 5 6 3 1 输入接口 接口 1 所有个人信息 接口 2 所有评议信息 接口 3 管理员个人信息 5 6 3 1 1 接口 1 1 输入条件 管理员权限 管理员个人信息界面 2 传递消息定义 记录的管理员权限 记录管理员所在位置 3 传输方式 驱动程序系统调用 5 6 3 1 2 接口 2 1 输入条件 管理员权限 管理员个人信息界面 2 传递消息定义 记录的管理员权限 记录访问者所在页面 3 传输方式 驱动程序系统调用 5 6 3 1 3 接口 3 1 输入条件 管理员权限 管理员个人信息界面 2 传递消息定义 记录的管理员权限 记录访问者所在页面 3 传输方式 19 驱动程序系统调用 5 6 3 2 输出接口 接口 1 所有评议信息 接口 2 管理员个人信息 5 6 3 2 1 接口 1 1 输出条件 管理员权限验证成功且发出显示个人信息界面的申请 2 传递消息定义 信息主存储区 3 传输方式 输出至用户界面 5 6 3 2 2 接口 2 1 输出条件 管理员权限验证成功且发出显示个人信息界面的申请 2 传递消息定义 信息主存储区 3 传输方式 输出至访问用户界面 5 6 4 管理员流程描述 5 6 4 1 管理员登录 20 登录 进入页面 查询 成功 网络繁忙系统崩溃 失败 退出 图图 5 6 4 1 管理员登录管理员登录 5 6 4 2 系统归档 21 调出评议结果 排序 刷新 归档 图图 5 6 4 2 系统归档系统归档 5 6 4 3 管理员发布结果 22 登录 进入页面 查询 发布结果 退出 图图 5 6 4 3 管理员发布结果管理员发布结果 5 7 CSCI 5 数据库访问数据库访问 5 7 1模块名称 数据库访问 23 5 7 2功能描述 实现用户对数据库的访问 保存访问后的数据结果 实现管理员对数据库 的访问 以及日期截止后对数据库结果的发放 具体功能如下 用户进入数据库 更新数据库中内容 系统对数据库内容进行日志存档 管理员进入数据库查看 评议日期截止 管理员发放数据库结果 用户查看最终数据库结果 CSCI 1 用用户户 人人机机界界面面 CSCI 2 系系统统 管管理理人人机机界界 面面 CSCI 3 用用户户 CSCI 4 管管理理 员员 CSCI 5 数数据据 库库访访 图图 5 7 2 数据库访问关系图数据库访问关系图 5 7 3接口描述 5 7 3 1 输入接口 进行评议 1 输入条件 用户通过命令包进入数据库 并进行评议访问 24 2 传递消息定义 对评议表中各项进行打分 十分制 只能给出整数分数 3 传输方式 函数调用 5 7 3 2 输出接口 发放结果 1 输出条件 管理员统计数据库结果 通过命令包发放最终结果 2 传递消息定义 以柱状图形式发布最终评议结果 3 传输方式 函数调用 评议 评议完成 网路繁忙评议未完成 继续评议 失败退出 图 5 7 3 2 数据库访问流程图 25 6数据 库 结构设计 6 1逻辑结构设计要点 表 6 1 逻辑结构设计要点表 数据结构数据项类型长度 IDCHAR20 姓名CHAR8 个人资料 密码CHAR20 管理员信息 评议信息票数INT1000 IDCHAR20 姓名CHAR8 学号CHAR10 个人资料 密码CHAR20 是CHAR8 学生个人信息 评议状态 否CHAR8 管理员 姓名 ID 号 密码 管理 姓名 ID 号 学号 学 生 密码 mn 图 6 1 逻辑结构设计要点图 26 6 2物理结构设计要点 无 7部署设计 客客户户 服服务务 以太网 HTTP 客客户户端端人人机机界界面面 进进程程 组组件件1 组组件件2 组组件件3 日日志志文文件件 数数据据库库 access 服服务务器器断断人人机机界界面面 进进 组组件件1 组组件件2 组组件件3 27 8运行设计 8 1运行目录结构 本项目全部内容放在目录 project 下 Resource 源程序 module1 module2 各个模块 Project File 各种配置文件 系统体系架构 结构设计等关系图 系统体系架构 结构设计等关系图 Data 数据文件 数据库中数据管理备份文件 报表等 9性能设计 见 5 逻辑结构设计及 6 数据库结构设计 10系统出错处理设计 10 1出错信息 10 1 1 当主机主存储设备无存储空间时 系统发出警示 无存储空间 并及时 地通知用户 10 1 2 若同一时间进入该系统的用户过多 系统给于用户文字提示 系统繁忙 请稍后再试 提醒用户稍后再试 10 1 3 在用户使用错误的数据或访问没有权限的数据后 系统给出提示 对 不起 你非法使用数据 没有权限 28 10 2补救措施 a 后备技术 为防止数据丢失 在数据库中有备份备份数据 故在系统出 错后可以依靠数据库的恢复能力 使系统再启动 b 降效技术 当系统提示无存储 空间时 可人工进行无用数据的删除 c 恢复及再启动技术 当系统提示