博客概要设计说明书.doc

概要设计说明书概要设计说明书 中软培训实训基地第 1 页 共 19 页 编写 日期 审核 日期 批准 日期 受控状态 是 发布版次 1 0日期 YYYY MM DD 编号 概要设计说明书概要设计说明书 概要设计说明书概要设计说明书 第 2 页 变更记录变更记录 日期版本变更说明作者 YYYY MM DD 1 0初始版本XXX 签字确认签字确认 系统模块对应章节对应部门负责人签字 概要设计说明书概要设计说明书 第 3 页 目目 录录 1 引言引言 4 1 1 编写目的 4 1 2 背景 4 1 3 基线 4 1 4 范围 4 1 5 定义 4 1 6 参考资料 4 2 总体设计总体设计 4 2 1 概述 4 2 1 1 功能描述 4 2 1 2 运行环境 4 2 1 3 开发环境 5 2 2 设计思想 6 2 2 1 系统构思 6 2 2 2 关键技术与算法 6 2 3 人工处理过程 7 3 系统功能设计系统功能设计 7 3 1 系统功能 7 4 系统数据结构设计系统数据结构设计 7 4 1 说明 7 4 2 数据结构 7 4 3 数据结构与系统元素的关系 7 5 接口设计接口设计 7 5 1 用户接口 7 5 2 外部接口 8 6 运行设计运行设计 8 6 1 系统初始化 8 6 2 运行控制 8 6 3 系统结束 8 7 系统出错处理设计系统出错处理设计 8 7 1 出错信息 8 7 2 补救措施 8 8 系统维护设计系统维护设计 8 8 1 检测点的设计 8 8 2 检测专用模块的设计 9 9 尚待解决的问题尚待解决的问题 9 概要设计说明书概要设计说明书 第 4 页 1 引言引言 1 11 1 编写目的编写目的 本文档用于描述 博客系统 项目的系统需求 为该项目概要设计 详细设计和测试用 例的设计依据 这个分析的阅读对象为任课老师和小组开发人员 1 21 2 背景背景 开发地点 开发单位 开发项目名称 1 31 3 基线基线 简单一点的 Blog 记载了日常发生的事情和自己的兴趣爱好 把自己的思想和知识与他人 分享 交流 同时又通过个人博客结识更多志同道合的朋友 使大家在网上可以进行各种 信息的交流 博客系统为大家提供了学习交流 工作交流 情感交流的平台 使人们的工 作更加简单快捷 使人们的生活更加丰富多彩 本文档用于描述 博客管理系统 项目的 系统需求 为该项目概要设计 详细设计和测试用例的设计依据 该需求规格说明书供概 要设计人员阅读 角色如表 1 表 1 各角色权限 序号序号角色角色权限权限 1 游客游客无需登陆就可以浏览相册 浏览博文或发表评论 2 博主登录后就可以修改用户资料 修改密码 发布 修改 删除 博文 添加 删除 修改相片 发表评论 3 博客管理 员 登陆后就可以管理注册用户 管理系统用户 管理博客文章 管理留言 管理相册 概要设计说明书概要设计说明书 第 5 页 1 41 4 范围范围 由于时间比较短 使用计算机不方便以及对于网络编程不熟悉 本博客管理系统功能不 怎么太全面 对信息的保护手段仅限于设置用户级别 以及提供数据文件的备份 比较简 单 安全性能有待进一步完善 1 51 5 定义定义 Blog Weblog 的简称 网络日志 通常称为博客 1 61 6 参考资料参考资料 1 付燕 软件体系结构实用教程 西安电子科技大学出版社 2009 9 2 参考书籍 软件体系结构原理 实践方法张友生清华大学出版社 2006 年 11 月 3 温昱 软件架构设计 电子工业出版社 2007 3 4 张友生 软件体系结构设计第二版 清华大学出版社 2006 11 2 总体设计总体设计 2 12 1 概述概述 2 1 1 功能描述功能描述 a a 注册注册 输入数据 账号 密码 以及各种个人信息 如昵称 生日 住处 爱好等 输出数据 注册是否成功的信息 功能 系统能够对用户输入的账号 密码等信息进行验证 确定是否可用 然后发送给服务器 概要设计说明书概要设计说明书 第 6 页 进行验证 验证通过后则存储于数据库并根据用户提供信息建立个人博客 如果验证没通 过 则提示用户原因 脚本如图 1 用户系统界面服务器 打开界面 提交注册信息 注册结果 选择注册 注册界面 输入注册信息 个人界面 图 1 注册脚本 b b 登陆登陆 输入数据 账号 密码 输出数据 提示信息 功能 系统能够按照用户输入的账号 密码发送给服务器进行验证 验证通过后可根据用户信 息进入个人博客主页 对于验证不通过的账号和密码系统能够做出相应的错误处理 脚本如图 2 概要设计说明书概要设计说明书 第 7 页 用户系统界面服务器 打开界面 验证账户密码 账号密码有效性 输入账户 密码 个人界面 图 2 登录脚本 c c 评论评论 留言留言 输入数据 所要发表的评论 留言的内容 输出数据 发表后内容 功能 游客或者注册用户可对当前浏览的博客内容进行评论或对当前浏览的博客进行留言 评 论 留言成功后会在当前博客或内容下显示 脚本如图 3 用户系统界面 服务器 打开博客界面 提交评论 留言内容 请求验证内容 验证通过 成功提交后界面 浏览博客内容 图 3 评论 浏览脚本 概要设计说明书概要设计说明书 第 8 页 d d 内容发表内容发表 输入数据 所要发表的内容的标题 内容与描述 输出数据 发表后内容 功能 系统能够对用户提交的标题 内容与描述进行验证 验证通过后存储至数据库 然后在 当前博客上显示成功提交的内容 若提交不成功 则显示错误提示信息并返回至内容编辑 页面 脚本如图 4 用户系统界面 服务器 打开博客界面 提交内容信息 请求验证内容 验证通过 成功提交后界面 选择博客内容 图 4 e e 内容管理内容管理 1 个人信息管理 输入数据 编辑的信息 输出数据 提示信息 功能 概要设计说明书概要设计说明书 第 9 页 系统能够对用户提交的对个人信息编辑后的内容进行验证 若验证通过 则修改数据库 相应信息 然后在页面提示用户编辑成功并显示新的个人信息 若不通过 则提示错误信 息并返回至个人信息页面 如图 5 用户系统界面 服务器 打开博客界面 提交编辑内容 请求验证内容 验证通过 成功提交后界面 打开个人信息界面 图 5 个人信息管理 2 博客内容管理 输入数据 编辑的标题 内容 描述等 输出数据 提示信息 功能 用户选择需要编辑的博客内容进行编辑 包括修改标题 修改内容 修改描述 修改权 限或删除当前内容 然后系统根据用户提交的信息进行验证 验证成功后修改数据库相应 内容 然后提示用户修改成功并显示成功修改后的内容 若失败 则提示错误信息并返回 编辑前内容界面 如图 6 概要设计说明书概要设计说明书 第 10 页 用户系统界面 服务器 打开博客界面 提交编辑内容 请求验证内容 验证通过 成功提交后界面 打开博客内容界面 图 6 博客内容管理 f f 系统管理系统管理 1 系统界面管理 输入数据 界面所需显示的内容 图片 公告等 输出数据 编辑后界面 功能 系统管理员对系统的界面进行管理 如修改界面布局 更改显示图片 发布公告 删除 部分内容等 修改成功后会在用户打开系统时显示修改后的系统界面 如图 7 所示 管理员系统界面 服务器 打开管理界面 提交编辑内容 请求更新内容 更新成功 成功提交后界面 选择管理内容 图 7 系统界面管理 概要设计说明书概要设计说明书 第 11 页 2 用户博客内容管理 输入数据 发送的信息 编辑的内容 输出数据 提示信息 发送信息 功能 系统管理员对系统的用户博客进行管理 管理员可以浏览系统用户的博客 对博客内容 进行审核 当发现不合规定的内容后 可以对当前内容进行编辑修改或删除 然后发送信 息给当前博客用户 如图 8 所示 管理员系统界面 服务器 打开管理界面 提交编辑内容 请求更新内容 更新成功 成功提交后界面 选择用户博客内容 图 8 博客内容管理 2 1 22 1 2 运行环境运行环境 a a 硬件硬件 处理器 Intel486 以上系列 AMD K6 以上系列 内存 1G 非最低配置 概要设计说明书概要设计说明书 第 12 页 网络 带宽 1M 非最低配置 b 软件软件 操作系统 windows 2000 XP vista 7 8 数据库 SQL Server 2008 客户端 Internet Explore 6 0 及以上 主流浏览器 firefox chrome opera 等 c c 运行系统 运行系统 windows 2000 XP vista 7 8 Internet Explore 6 0 及以上或主流浏览器 firefox chrome opera 等 2 22 2 设计思想设计思想 2 2 1 系统构思系统构思 a a 系统目标系统目标 本系统主要实现网站建设者与访问者之间的交流 展现网站建设者的思想 主要实现如 下目标 全面展示博客网站的主题思想 通过发表 我的文章 表达作者的想法和观点 实现与访问者的相互交流 通过上传个人相册 使访问者对网站建设者有进一步的了解 用户可以查看文章 并可以对文章发表意见 展现最新的的博客列表 方便访问浏览 提供网站统计信息 使访问者了解网站的基本信息 对文章信息进行管理 通过选择文章类别名称添加文正内容 并可以查询 修改和删除 文章内容 对相册信息进行管理 通过选择相册类别名称上传相册图片信息 并可以查看和删除相 册内容 可以修改管理员登陆信息 b b 系统功能结构系统功能结构 博客网站分为前台和后台 其中 根据博客前台的特点 可以将其分为博主信息 网络 日历 文章查询 公告查询及相册查询等 13 部分 其中各个部分及其包括的具体功能模块 概要设计说明书概要设计说明书 第 13 页 如图 9 所示 根据博客网站后台的特点 可以将其分为用户设置 公告管理 个人相册管理 博客文 章管理 投票管理 朋友信息管理及博主信息修改 7 部分 其中各个部分及其包括的具体 功能模块 如图 10 所示 博客网前台 查 看 博 主 信 息 查 看 网 站 说 明 网 络 日 历 邮 箱 联 系 文章查询朋 友 查 询 友 情 链 接 用 户 投 票 相 册 查 询 公告查询 文章详细查 询 文章留言 公告详细查 询 图 9 前台设计 博客网后台 博客文章管理个人相册管理公告管理投票管理朋友信息管理 公 告 添 加 相 册 添 加 相 册 设 置 发 表 博 客 文 章 朋 友 信 息 添 加 文 章 分 类 朋 友 信 息 设 置 博 主 信 息 修 改 投 票 内 容 设 置 设 置 内 容 添 加 公 告 设 置 用 户 设 置 博 客 文 章 设 置 图 10 后台设计 c c 系统流程图系统流程图 概要设计说明书概要设计说明书 第 14 页 为了更加清晰的表达系统的业务功能模块 下面给出博客网的系统流程图 对于不同 的角色 其所承担的任务也各自不同 流程图也不一样 包括面向用户的客户端流程图和 面向系统管理员的的流程图 如图 11 所示 开 始 用户登录 用户登 录判断 用户注册 博客网站首 页 相册查看 邮件联系朋友查看 博客说明查看 博主信息查看 投票 投票结果查看 公告信息查看公告信息详细查 看 文章分 类 文章查 看 文章详 细查看 文章回 复 图 11 系统结构流程图 2 2 2 关键技术与算法关键技术与算法 UML 技术 mysql 数据库技术 JAVA E 技术 web 技术 2 3 人工处理过人工处理过程程 在数据库设计这一快必须要有下列这些人工操作 主要包括如下四点 1 采集信息 在创建博客数据库之前 必须对博客信息有一个透彻的理解 与博客网中所涉及的每个 人进行交流 以找出他们所作的工作及他们需要从数据库中获得的内容 这是很重要的 概要设计说明书概要设计说明书 第 15 页 另外 了解该博客系统是否符合实际要求及找出相关系统的问题 限制和屏蔽也很重要 2 表示对象 在采集信息的过程中 必须标识将由博客数据库管理的主要对象或实体 对象可以是一 个有形的实体 如用户 也可以是一个无形的项目 文章 相册等 通常会有几个主要 对象 在标识了这些对象之后 相关的项目就会变得清晰 数据库中每个不同的项目都应 有一个对应的表 3 建立对象实体 标识了博客系统中的对象后 使用该博客系统的一种直观表示方式对这些对象进行记录 是很重要的 在数据库实现期间 可以使用数据库实体作为参考 4 标识每个对象的信息类型 标识必须为各对象存储的信息类型 这些信息是对象的表中的列 实际上就是数据表字 段的类型 3 系统功能设计系统功能设计 3 13 1 系统功能系统功能 博客的注册 登录验证功能 普通用户浏览文章和发表评论的管理 文章详细内容及相关评论显示 博客个人文章管理维护功能 博客个人文章分类管理维护功能 博客个人友情链接维护功能 博客个人基本信息管理维护功能 个人上传图片和相册管理的功能 管理员对博主的管理 管理员对个人信息的管理 管理员对网站在线人数的统计 概要设计说明书概要设计说明书 第 16 页 4 系统数据结构设计系统数据结构设计 4 14 1 说明说明 数据库采用 SQL Server 数据库 4 24 2 数据结构数据结构 静态数据 1 用户 用户 ID 用户名称 用户密码 博客主题 说明 E mail 注册日期 发表日 志数 2 用户类型表 用户 ID 用户类型 2 类别 类别编号 类别名 类别描述 3 日志 日志编号 日志标题 日志内容 类别编号 发表日期 最后修改日期 用户 ID 浏览次数 评论数 4 评论 评论编号 评论标题 评论内容 发表日期 最后回复日期 评论人 日志编 号 5 留言 留言编号 留言标题 留言内容 发表日期 最后回复日期 留言人 用户 ID 动态数据 1 注册新用户 2 发表新日志 留言 评论 3 日志 留言 评论的更改 4 个人信息管理 5 管理员更新 4 34 3 数据结构与系统元素的关系数据结构与系统元素的关系 它们是一一对应 相互依赖的 概要设计说明书概要设计说明书 第 17 页 5 接口设计接口设计 5 1 用户接口用户接口 本系统采用图形用户接口 以鼠标和键盘为用户接口 方便用户对博客系统的有效操作 更好地在博客里进行交流 5 2 外部接口外部接口 5 2 1 硬件接口硬件接口 支持各种 x86 系列 PC 机 5 2 25 2 2 软件接口软件接口 运行于 Windows95 98 及更高版本具有 WIN32 API 的操作系统之上 6 运行设计运行设计 6 1 系统初始化系统初始化 如下表 2 所示 表 2 6 2 运行控制运行控制 用户在登录页面后 登录自己的账号密码进行用户登录 而管理员是直接输入管理员账 号密码进入管理员页面 输入处理过程输出输入数据类型 账号 密码以及个人信息注册提示信息字符文本 数字 账号 密码登陆提示信息 个人博客界面字符文本 数字 评论 留言内容评论 留言提示信息字符文本 内容主体 标题 描述内容发表提示信息 发表后内容字符文本或图片 编辑的内容内容管理提示信息 编辑后内容字符文本或图片 管理的内容 发送的信息系统