社区系统概要设计说明书(共15页).doc

《社区系统概要设计说明书(共15页).doc》由会员分享，可在线阅读，更多相关《社区系统概要设计说明书(共15页).doc（15页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、精选优质文档-倾情为你奉上版本号：V1.52012系统概要设计说明书 项目名称_11社区_ 拟 制 人_ _ 审 核 人_ _批 准 人_ _ 编著日期_ _ 专心-专注-专业目录1. 引言1.1 编写目的 从该阶段考试正式进入软件的实际开发阶段，本阶段完成系统的大致设计并明确系统的数据库与软件结构。在系统设计阶段主要是把一个软件需求转化为软件表示的过程，这种表示只是描述软件的总的概貌。本概要设计说明书的目的就是进一步细化软件设计阶段得到的软件总体概貌，把它加工成在程序细节上非常接近于源程序的软件表示。 在完成了“11社区”系统的可行性研究和需求分析的基础上，为了明确软件需求、安排项目规划与进

2、度，组织软件开发和测试，项目小组在考虑了几种可能的解决方案，并对每种方案进行深入探讨后，提出了这份概要设计说明书。 此概要设计说明书对BBS管理系统软件的软件架构、模块细化、程序的总体结构、接口设计以及数据库设计规划等方面做了全面的概括性说明，为“11社区”系统的详细设计奠定了基础。1.2 预期读者和阅读建议 该文档的预期读者为“11社区”程序开发员、系统设计师以及测试工程师等。本文档主要针对“11社区”设计概述、软件架构、子系统的结构和模块功能以及系统接口、数据库设计规划等方面进行了详细的说明，笔者建议，在阅读本文档之前，细细阅读“术语与缩略语”部分，这将有利于您对本文档的理解。对于程序开发

3、员，笔者建议仔细阅读系统的软件架构及子系统的结构和功能模块部分，了解每个功能模块之后，这样对系统的功能及运行模式将有整体的把握，然后阅读后面几部分内容，有利于“11社区”系统的实现。而测试工程师应把重点放在系统接口、数据库设计规划以及数据库设计上，在系统测试过程中，最容易出错的就是这两方面。总之，笔者建议读者根据自己阅读本文档的目的选择着重点，这样在满足需求的同时提高效率。1.3 参考资料1 王宜贵.软件工程M.北京：机械工业出版社,2002：20-792 孙卫琴.精通strutsM.北京：电子工业出版社,2004：50-703 孙卫琴.精通hibernateM.北京：电子工业出版社,2005

4、：100-1204 张洪斌.java2高级程序设计M.北京：中科多媒体出版社,2001：85-905 林信良.spring2.0技术手册M.北京：电子工业出版社,2006：50-1006 耿祥义编著.JSP基础编程M.北京：清华大学出版社,2004：55-1627 孙鑫编著Java Web开发详解M北京：电子工业出版社,2006：189-2741.4 术语与缩略语 无2. 设计概述2.1 限制和约束1、 技术条件：本系统涉及到开发平台的搭建、网站开发的框架设计、html基础、jsp基础、java基础，我们学习的仅仅是皮毛而已，还需要进一步的学习。 2、 资金状况： 3、 开发环境(包括：工具和

5、平台)；由于是个人电脑，所以硬件设施可能在性能上比较差；软件全部是免费的，功能可能会受到相应的限制；对windows xp比较熟悉，所以开发主要是在这个平台上进行的；4、 时间限制：除了本系统的开发以外，本组成员还有其他的任务，不能将全部精力都放在本系统的开发上。5、 客户需求会经常变更，影响项目的进度。在上述条件下，应该实现的系统目标为：以水木社区为模板，开发一个更适合师大全体师生交流的社区平台。实现的主要功能和水木社区相似，为：会员注册、会员登陆、会员管理、论坛版块管理、帖子管理、帖子发表、帖子回复、帖子浏览、帖子检索、意见建议；但是要进行一定的改进，增加投票栏目、资源共享、新生家园、新手

6、上路、版块介绍等这几个板块。2.2 设计原则和设计要求“11社区”系统开发过程中的设计原则和设计要求见表 2-1。表 2-1 设计原则及要求表设计原则及要求设计详述命名规则所有数据、模块、功能等命名要见名知意模块独立性原则高内聚低耦合边界设计原则边界明确，无模棱两可的说法灵活性要求系统运行不响应时间不能超过10秒。 对系统进行操作时，响应时间在5秒之内。多用户操作时，时间和相应的要求同上。数据库设计规则数据的共享性。数据独立性。数据的完整性，即保证数据库存中数据准确。灵活性，可在相当短的时间内回答用户的各种各样的复杂而灵活的查询问题。安全性与保密性，做到对数据指定保护级别和安全控制。安全措施及

7、安全性和保密原则权限控制 根据不同用户角色，设置相应权限，用户的重要操作都做相应的日志记录以备查看，没有权限的用户禁止使用系统。普通用户只能删除自己的发帖、跟帖内容；而版主、超级版主、系统管理员可以删除所有人的发帖、跟帖的内容。重要数据加密 本系统对一些重要的数据按一定的算法进行加密，如用户口令、重要参数等。数据备份 允许用户进行数据的备份和恢复，以弥补数据的破坏和丢失。记录日志 本系统应该能够记录系统运行时所发生的所有错误，包括本机错误和网络错误。这些错误记录便于查找错误的原因。日志同时记录用户的关键性操作信息。系统安全措施可靠、高效、可维护性好，有权限控制、口令控制、临时锁定控制，其中口令

8、录入界面便于系统识别登录用户可靠性需求系统运行具有较高的可靠性，提供严格的并发控制，确保数据的一致性和正确性易操作性要求界面人性化，方便操作，操作流程合理尽量从用户角度出发，以方便使用本产品。如：发帖时，敲入回车键光标的自动跳转、输入法的自动转换，信息检索时输入汉语简拼快速检索到结果等。可以通过快速键方便用户录入信息，所有操作可仅通过键盘完成。支持没有计算机使用经验、计算机使用经验较少及有较多计算机使用经验的用户均能方便地使用本系统。控制必录入项本系统能够对必须录入的项目进行控制，使用户能够确保信息录入的完整。同时对必录入项进行有效的统一的提示。用户可自定义为了满足业务的不断变化，一些重要的参

9、数应该可以灵活设置。联机帮助与操作指南。可维护性要求为了保证系统的可维护性，要求具有详细的文档资料，同时，要求系统在功能设计上考虑可扩展性，以满足业务变动的需求。从用户的实际需要出发进行系统开发，不盲目追求高新技术的应用3. 系统总体结构图根据系统需求说明书，方便网站的开发、维护，切合模块“高内聚、低耦合”思想，特将11社区管理系统分解为3个子系统：会员管理系统、帖子管理系统，后台管理系统。会员管理系统主要负责用户信息的管理，如用户登录、注册等。当用户发帖或回复帖子时，将由帖子管理系统进行处理。若需对用户信息、站内帖子、站内版块进行综合管理，则需由后台管理系统完成。系统的总体结构图见图3-1。

10、图3-1系统的总体结构图根据系统的总结结构图，“11社区”子系统划分表见表3-1。表3-1 11社区管理系统子系统划分表 子系统编号英文名称中文名称业务职能SubSystem1Member Manager System会员管理子系统实现用户信息的管理，包括用户注册、登录，用户信息修改。SubSystem2Tip Manager System帖子管理子系统实现用户发帖、回复、查找、删除帖子等功能。SubSystem3Back-stage Manager System后台管理子系统实现管理员对会员、帖子、论坛的管理。管理员可对会员进行注册验证，修改会员信息，删除会员信息；删除、置顶帖子；改善站内版

11、块功能。4. 子系统的结构和功能模块会员管理子系统：在此子系统中，为了降低其复杂度，根据用户的不同操作，再将其分为会员注册、会员登录、好友查找、资料修改四个模块。其具体分配模块见图4-1。图4-1 会员管理子系统模块划分图会员管理子系统模块划分见表4-1。表4-1 会员管理子系统模块划分表模块编号英文名称中文名称业务职能所属子系统Module1-1Member Login会员登录实现用户的登录功能SubSystem1Module1-2Member Register 会员注册实现用户的注册功能SubSystem1Module1-3Member Search好友查找实现用户对站内会员的查询SubS

12、ystem1Module1-4MemberInfo Update资料修改实现用户对注册个人资料进行修改SubSystem1 帖子管理子系统：根据对帖子进行的不同操作，将其分为帖子发表、帖子回复、帖子查找3个模块，其具体分配模块见图4-2。图4-2 帖子管理子系统模块划分图帖子管理子系统模块划分见表4-2。表4-2 帖子管理子系统模块划分表模块编号英文名称中文名称业务职能所属子系统Module2-1Tip Post帖子发表完成用户在站内发表帖子功能SubSystem2Module2-2Tip Reply帖子回复完成用户对某帖子进行回复功能SubSystem2Module2-3Tip Search

13、帖子查找完成用户对自己需要的帖子进行查询功能SubSystem2 后台管理子系统：管理员是此系统权限最高的用户，能够进行所有对系统的操作，根据操作对象不同，将其分为三个模块：用户管理、帖子管理和版块管理。其具体分配模块见图4-3。图4-3 后台管理子系统模块划分图后台管理子系统模块划分见表4-3。表4-3 后台管理子系统模块划分表模块编号英文名称中文名称业务职能所属子系统Module3-1Member Management用户管理实现管理员对于违反站内制度的会员，可将其禁言或删除其IDSubSystem3Module3-2Tip Management帖子管理实现管理员根据需要对某些帖子进行置顶

14、或移动操作。SubSystem3Module3-3Board Management版块管理实现管理员对版块根据需要进行添加新版块、删除旧版块、完善现有版块功能。SubSystem3 11社区功能模块关系图见图 4-4。图 4-4 “11社区”类图5. 系统接口、数据库设计规划5.1 接口设计5.1.1 外部接口在用户界面部分，根据需求分析的结果，用户需要一个用户友善界面。在界面设计上，应做到简单明了，易于操作，并且要注意到界面的布局，应突出重要以及出错信息。外观上也要做到合理化，考虑到用户多对WINDOS风格较熟悉，应尽量向这一方向靠拢。总的来说，系统的用户界面应做到可靠性、简单性、易学性和实

15、用性。5.1.2 内部接口 会员管理子系统接口信息见表 5-1。表5-1 会员管理子系统接口列表子系统编号：SubSystem1子系统英文名称：Member Manager System子系统中文名称：会员管理子系统接口编号接口名称接口类型接口性质相关对象SubSystem1.Login用户名、密码必填项输入登陆界面SubSystem1.Register.1有效邮箱、密码、确认密码、昵称必填项输入注册界面SubSystem1.Register.2生日、性别、所在地、选填项输入注册页面SubSystem1.Search.1好友昵称选填项输入好友查找页面SubSystem1.Search.2好友地

16、址等选填项输入好友查找页面SubSystem1.Search.3相关好友信息只读、可加好友输出好友查找成功页面SubSystem1.Update.1所要修改的信息必填项输入修改个人信息页面SubSystem1.Update.2修改后信息只读输出修改个人信息成功后的页面说明：1、邮箱格式正确；2、密码与确认密码相同；3、在Search中，好友昵称、好友地址等好友信息必须填写一项；帖子管理子系统接口信息见表5-2。表5-2 帖子管理子系统接口列表子系统编号：SubSystem2子系统英文名称：Tip Manager System子系统中文名称：帖子管理子系统接口编号接口名称接口类型接口性质相关对象

17、SubSystem2.Post.1发帖标题必填项输入发帖页面SubSystem2.Post.2发帖内容选填项输入发帖页面SubSystem2.Post.3点击“发表”必须操作输入发帖页面SubSystem2.Post.4所发帖子内容只读输出发帖成功后页面SubSystem2.Reply.1回复内容必填项输入回复页面SubSystem2.Reply.2点击“回复”必须操作输入回复页面SubSystem2.Reply.3所回复帖子内容只读输出回复成功后页面SubSystem2.Search.1帖子主题、关键字、好友昵称等等选填项（必填其一）输入帖子查找页面SubSystem2.Search.2相关

18、帖子信息只读、可加回复输出帖子查找成功页面说明：1、发帖标题、发帖内容必须在规定的长度范围内；2、查找帖子时，必须填写一项查询条件；板块管理子系统接口信息见表5-3。表5-3 板块管理子系统接口列表子系统编号：SubSystem3子系统英文名称：Back-stage Manager System子系统中文名称：板块管理子系统接口编号接口名称接口类型接口性质相关对象SubSystem3.Member.1用户ID必填项输入用户禁用页面SubSystem3.Member.2用户ID必填项输入用户删除页面SubSystem3.Tip 发表的帖子必选想双向帖子处理页面SubSystem3.Board.1

19、 板块ID必填项输入板块删除页面SubSystem3.Board.2 板块排版修改项双向板块排版修改页面说明：无 5.2 数据库设计5.2.1 结构设计I、概念结构设计概念模型的表示方法很多，其中最为著名最为常用的是E-R图。简单的说，E-R图用来分析数据关系的。下面具体列出“11社区”系统主要的实体图及E-R图。根帖实体图如图5-1所示：主要属性有编号、所属版面、标题、内容、发布者、发布时间、表情、对帖子进行操作的时间、是否为置顶帖子、被置顶的时间、是否为精华帖子和被设置为精华帖子的时间。其中是否为置顶帖子与是否为精华帖子属性分别用来标识帖子是否被设置为置顶或精华帖子，1表示“是”，0表示“

20、否”。 内容 发布者发布时间是否顶置 标题所属版面顶置时间精华时间 编号是否精华 跟 帖图5-1 根帖信息实体图图 5-1 跟帖信息实体图用户信息表实图如图5-2所示：主要有编号、用户名、密码、头像、性别、联系方式、QQ号码、邮箱、籍贯、权限。权限分为三种：0表示普通用户，1表示版主，2表示管理员。 图5-2 用户信息实体图回复帖实体图如图5-3所示：主要有编号、根帖ID、标题、内容、回复者、回帖时间和表情属性。图5-3 回复帖实体图回复帖回复者内容根帖ID表情编号回帖时间标题版面实体图如图5-4所示：主要有编号、所属类别ID、版面名称、版主、版面公告。图5-4 版面实体图版面版主版面名称编号

21、版面公告所属类别idIDIDID论坛类别实体图如图5-5所示：主要有编号、类别名称、介绍。类别名称 介绍 编号 论坛类别图 5-5 论坛类别实体图图5-5论坛类别实体图II、逻辑结构设计 用户表设计见表 5-4。表5-4 User表 帖子表设计见表5-5。表5-5 Tip表 版块表设计见表5-6。表5-6 Board表 回帖表设计见表5-7。表5-7 Reply表 各表之间的关系见图5-7。图5-7 表之间的关系图III、物理结构设计A. 缓存区设计：对于不经常发生变化的数据，采用缓存机制，将数据缓存在内存中，以提高系统的访问性能；B. 外存设备及外存空间的组织：无；C. 数据库访问方式：JD

22、BC。5.2.2 运用设计 根据E-R图可以对数据库进行设计，以下列出详细的数据库运用设计。 论坛用户信息表用来保存论坛所有用户的详细信息，其具体信息见表5-8。表5-8 用户信息表(User)域名数据类型说明主要属性useridint用于自动存储用户ID主键Not nullnameVarchar(200)用于存储用户名称NullpasswordVarchar(200)用于存储用户密码NullfaceVarchar(200)用于存储用户头像NullsexVarchar(20)用于存储用户性别NullphoneVarchar(50)用于存储用户联系方式NullqqVarchar(50)用于存储用

23、户QQ号码NullemailVarchar(100)用于存储用户邮箱NullregionVarchar(200)用于存储用户籍贯Nullableint0表示普通用户1表示版主2表示管理员Null 根帖信息表，用于保存发布的全部根帖信息，该表具体字段具体信息见表 5-9。表5-9 根帖信息表(Tip)域名数据类型说明主要属性tipidInt用于自动存储帖子ID主键Not nulltitlevarchar(100)用于存储帖子标题(-1)contentvarchar(8000)用于存储帖子内容 nullpublishtimevarchar(100)用于存储帖子发布时间 nulluseridint用

24、于存储帖子发布者id nullboardidint用于存储帖子所属版块id nullbbs_isTopint1表示置顶帖子0表示非置顶帖子 (0)bbs_isTopTimevarchar(100)在显示置顶帖子时，按该字段降序排列 nullbbs_isGoodint1表示精华帖子0表示非精华帖子 (0)bbs_isGoodTimevarchar(100)在显示精华帖子时，按该字段降序排列null 版面信息表用来保存论坛中版面信息，其具体信息见表5-10。表5-10 版面信息表（Board）域名数据类型说明主要属性boardidint用于自动存储版面ID主键not nullboardnameva

25、rchar(100)用于存储版面名称 nullparentidint用于存储版面所属版块id null回复帖子信息表用来保存回复帖子的信息，其具体信息见表5-11。表5-11 回复帖子信息表（Reply）域名数据类型说明主要属性replyidIntID值(自动编号)主键not nulltitleVarchar(100)用于存储回复帖子的标题 NullcontentVarchar(8000)用于存储回复帖子的内容 Nulluseridint用于存储回复帖子的回复者ID NullpublishtimeVarchar(100)用于存储回复帖子的时间 Nulltipidint用于存储回复帖子的根帖ID

26、 Null 在数据库的设计中，我们将通过用户的“able”属性值来判断访问者，able=0表示为普通用户；able=1表示为版主；able=2表示为管理员。通过able的值来判断访问的类型以确定他们的权限，从而保证数据库的安全性和保密性。6. 难点及处理方案无7. 文档历史版本修改内容修改日期修改人审阅人V1.0整合全文2012.11.18*V1.1修改全文2012.11.19*V1.2修改格式2012.11.19*V1.3结构设计、修改表名及图名2012.11.24*V1.4接口设计、运用设计2012.11.25*V1.5修改格式2012.11.26*V1.6系统总体结构图、全文格式2012.11.27*