BBS 论坛详细设计说明书
编写人(签字):
日期: xxxx 年 xx 月 xx 日
用户方项目代表(签字):
日期: xxxx 年 xx 月 xx 日
开发方项目代表(签字):
质量保证 代表(签字):
日期: xxxx 年 xx 月 xx 日
日期: xxxx 年 xx 月 xx 日
目 录
第一章 引言................................................................................................................................................................5
1.1 编写目的........................................................................................................................................................5
1.2 背景................................................................................................................................................................5
1.3 定义................................................................................................................................................................6
1.4 参考资料........................................................................................................................................................6
第二章 系统结构设计................................................................................................................................................7
2.1 MVC 中各层组件设计.................................................................................................................................7
2.2 项目中的各个用例的时序图.................................................................................................................... 22
2.3 项目中的各个用例的协作图..................................................................................................................... 26
2.4 项目中的各个活动图..................................................................................................................................29
2.5 项目中的各个状态图..................................................................................................................................31
第三章 详细设计类图..............................................................................................................................................33
3.1 数据访问层组件类图..................................................................................................................................33
3.2 业务处理层组件类图..................................................................................................................................34
3.3 控制层组件类图..........................................................................................................................................35
3.4 表示层组件类图..........................................................................................................................................35
3.5 系统总体类图..............................................................................................................................................36
第四章 系统主要模块的界面设计......................................................................................................................... 36
4.1 后台内容发布系统主页面设计................................................................................................................. 37
4.2 后台内容发布系统二级页面设计............................................................................................................. 37
4.3 前台用户注册页面设计............................................................................................................................. 38
4.4 前台用户登录页面设计............................................................................................................................ 38
4.5 后台用户登录页面设计............................................................................................................................. 39
4.6 后台管理页面设计......................................................................................................................................40
第五章 系统中游客注册程序详细设计说明......................................................................................................... 40
5.1 游客注册程序(功能模块)描述............................................................................................................. 40
5.2 功能..............................................................................................................................................................40
5.3 性能..............................................................................................................................................................41
5.4 输入项..........................................................................................................................................................41
5.5 输出项..........................................................................................................................................................41
5.6 算法..............................................................................................................................................................41
5.7 流程逻辑......................................................................................................................................................42
5.8 接口..............................................................................................................................................................42
5.9 存储分配......................................................................................................................................................43
5.10 注释设计....................................................................................................................................................43
5.11 限制条件....................................................................................................................................................43
5.12 测试计划....................................................................................................................................................43
5.13 尚未解决的问题........................................................................................................................................43
第六章 系统中用户在线注销程序详细设计说明.................................................................................................44
6.1 程序描述......................................................................................................................................................44
6.2 功能..............................................................................................................................................................44
6.3 性能..............................................................................................................................................................44
6.4 输入项..........................................................................................................................................................44
6.5 输出项..........................................................................................................................................................44
6.6 算法..............................................................................................................................................................44
6.7 流程逻辑......................................................................................................................................................45
6.8 接口..............................................................................................................................................................45
6.9 存储分配......................................................................................................................................................46
6.10 注释设计....................................................................................................................................................47
6.11 限制条件....................................................................................................................................................47
6.12 测试计划....................................................................................................................................................47
6.13 尚未解决的问题........................................................................................................................................47
第七章 系统中注册用户登录程序详细设计说明.................................................................................................47
7.1 程序描述......................................................................................................................................................47
7.2 功能..............................................................................................................................................................47
7.3 性能..............................................................................................................................................................47
7.4 输入项..........................................................................................................................................................48
7.5 输出项..........................................................................................................................................................48
7.6 算法..............................................................................................................................................................48
7.7 流程逻辑......................................................................................................................................................48
7.8 接口..............................................................................................................................................................49
7.9 存储分配......................................................................................................................................................49
7.10 注释设计....................................................................................................................................................50
7.11 限制条件....................................................................................................................................................50
7.12 测试计划....................................................................................................................................................50
7.13 尚未解决的问题........................................................................................................................................50
第八章 系统中修改个人信息程序详细设计说明.................................................................................................50
8.1 程序描述......................................................................................................................................................50
8.2 功能..............................................................................................................................................................50
8.3 性能..............................................................................................................................................................50
8.4 输入项..........................................................................................................................................................51
8.5 输出项..........................................................................................................................................................51
8.6 算法..............................................................................................................................................................51
8.7 流程逻辑......................................................................................................................................................51
8.8 接口..............................................................................................................................................................52
8.9 存储分配......................................................................................................................................................52
8.10 注释设计....................................................................................................................................................53
7.11 限制条件....................................................................................................................................................53
8.12 测试计划....................................................................................................................................................53
8.13 尚未解决的问题........................................................................................................................................53
第九章 系统中查看留言评论程序详细设计说明.................................................................................................53
9.1 程序描述..............................................................................................................................................................53
9.2 功能..............................................................................................................................................................53
9.3 性能..............................................................................................................................................................53
9.4 输入项..........................................................................................................................................................54
9.5 输出项..........................................................................................................................................................54
9.6 算法..............................................................................................................................................................54
9.7 流程逻辑......................................................................................................................................................54
9.8 接口..............................................................................................................................................................54
9.9 存储分配......................................................................................................................................................55
9.10 注释设计....................................................................................................................................................55
9.11 限制条件....................................................................................................................................................55
9.12 测试计划....................................................................................................................................................55
9.13 尚未解决的问题........................................................................................................................................55
第十章 系统中回复留言程序详细设计说明......................................................................................................... 55
10.1 程序描述....................................................................................................................................................55
10.2 功能............................................................................................................................................................56
10.3 性能............................................................................................................................................................56
10.4 输入项........................................................................................................................................................56
10.5 输出项........................................................................................................................................................56
10.6 算法............................................................................................................................................................56
10.7 流程逻辑....................................................................................................................................................57
10.8 接口............................................................................................................................................................57
10.9 存储分配....................................................................................................................................................58
10.10 注释设计..................................................................................................................................................58
10.11 限制条件..................................................................................................................................................58
10.12 测试计划..................................................................................................................................................58
10.13 尚未解决的问题......................................................................................................................................58
第一章 引言
1.1 编写目的
本文档作为 BBS 的详细设计说明文档,用于与用户确定最终的目标,并成为协议文本的一部分,同时
也是本系统设计人员的基础文档。
1.1.1 详细设计说明书目的
本详细设计说明书说明了 BBS 论坛系统设计中的各个组件和类的详细设计和技术实现。
1.1.2 预期读者
本系统开发人员及维护人员。
1.2 背景
BBS 论坛,或者称为社区,是电子商务网站中一种常见功能,也是互联网上一种极为常见的互动交
流服务。它为上网用户提供了言论自由的讨论区。通过论坛可以向用户提供开放性的分类专题讨论区服务,
同时注册的用户可以根据需要在论坛上发表文章,交流技术经验,或者提出问题并表达自己的观点。不仅
如此,上网的用户还可以在论坛中看到他人发表的文章,并且能够对该文章进行评论。
一般情况下,BBS 按不同主题分为多个布告栏,其设立多是依据使用者的要求和喜好,但多具有信
件交流、软件交流、信息发布等功能。
目前,大部分 BBS 由教育机构、研究机构或商业机构管理,大多有自己的拨入电话号码,用户只需电
脑、调制解调器和电话线就可通过电话拨号登录 BBS 站点。
1.2.1 待开发软件系统的名称
BBS 论坛系统
1.2.2 项目的任务提出者
1.2.3 项目的任务开发者
1.3 定义
1.3.1 本文档中涉及的专业词汇
1、GB:中华人民共和国国家标准的英文缩写字母
2、构件:具有某种功能的可重用的软件模版单元,表示了系统中主要的计算元素和数据存储。
3、逻辑视图:描述支持系统的功能需求的视图。
4、开发视图:也称模块视图,主要侧重于软件模块的组织和管理描述。
1.3.2 名词说明
1、BBS:Bulletin Board Service
2、JSP(JavaServer Pages)
JSP 技术使用 Java 编程语言编写类 XML 的 tags 和 scriptlets,来封装产生动态网页的处理逻辑。网
页还能通过 tags 和 scriptlets 访问存在于服务端的资源的应用逻辑。JSP 将网页逻辑与网页设计和显示
分离,支持可重用的基于组件的设计,使基于 Web 的应用程序的开发变得迅速和容易
3、Struts 只是一个 MVC 框架(Framework)
它 用 于 快 速 开 发 Java Web 应 用 。 Struts 实 现 的 重 点 在 C(Controller) , 包 括
ActionServlet/RequestProcessor 和我们定制的 Action,也为 V(View)提供了一系列定制标签(Custom
Tag)。但 Struts 几乎没有涉及 M(Model),所以 Struts 可以采用 JAVA 实现的任何形式的商业逻辑。
1.4 参考资料
1、本软件项目规划依据标准为国家表准:GB856T——88;
2、技术参考资料
(1)J2EE 项目实训 Hibernate 框架技术(21 世纪高等学校实用软件工程教育规划教材)
杨少波 等编著
清华大学出版社
2008 年 5 月
(2)J2EE 项目实训 Spring 框架技术(21 世纪高等学校实用软件工程教育规划教材)
杨少波 等编著
清华大学出版社
2008 年 5 月
(3)J2EE 项目实训 UML 及设计模式(21 世纪高等学校实用软件工程教育规划教材)
杨少波 等编著
清华大学出版社
2008 年 5 月
(4)J2EE 项目实训 Struts 框架技术(21 世纪高等学校实用软件工程教育规划教材)
杨少波 等编著
清华大学出版社
2008 年 10 月
第二章 系统结构设计
2.1 MVC 中各层组件设计
2.1.1 MVC 中的视图层的设计
1、一个典型的 Web 应用的前端应该是表示层
表示层由 UI(User Interface)和 UI 控制逻辑组成。
(1)UI(User Interface)
UI 是客户端的用户界面,负责从用户方接收命令,请求,数据,传递给业务层处理,然后将结果呈现
出来。
(2)UI 控制逻辑
UI 控制逻辑负责处理 UI 和业务层之间的数据交互,UI 之间状态流程的控制,同时负责简单的数据验
证和格式化等功能。
由于在本项目中的表示层使用 Struts 框架,下面为 Struts 所负责的主要功能:
管理用户的请求,做出相应的响应
提供一个流程控制器,委派调用业务逻辑和其他上层处理
处理异常
为显示提供一个数据模型
用户界面的验证
以下内容,不该在 Struts 表示层中出现,因为它们应该是与表示层无关的。
与数据库直接通信
与应用程序相关联的业务逻辑及校验
事务处理
因为,如果我们在表示层引入这些功能的实现代码,将会给系统带来高耦合和难以维护的后果。
(3)本系统的表示层拟采用的技术
HTML:实现前台页面的组织编写。
Javascript:利用此脚本语言,实现前台表单的简单验证。
CSS:利用此技术来确定页面布局,达到前台页面的美化效果。
JSP:利用 jsp 脚本与后台进行交互,以实现页面的动态化。
Struts:利用 struts 标签技术以实现表示层和业务层的分离。
Ajax:此技术是近年来流行的基于 Web2.0 思想的客户端技术,旨在提高页面友好性的异步刷新
技术。本项目中对 Ajax 技术的使用主要是在用户注册、登录、密码找回等前后台交互型页面以
及拥有多级列表联动的页面。
Frameset:本系统后台拟采用此技术实现后台页面风格的一致性。整体设计为上左右结构,如图
所示:
2、基于 Struts 的 JSP 页面所产生的表示层
(1)如何实现表示和业务的分离---利用标签技术
尽管在 Struts 的 JSP 页面中还是可以继续使用 Java 脚本的,但是,标准的做法是尽可能的使用标签和
Java Bean,只有这样一来,才能够把业务逻辑和页面表示彻底分开,提高了系统设计的规范性和代码的
可重用性,为后期升级提供方便。
(2)在本项目中所涉及的标签
一方面即可以使用 Struts 中所提供的各个标签库的标签,同时页根据项目的实际需要定制了自己的标
签库的标签。本项目中的表示层中的部分组件类的类图以及它们之间的关系的图示请见下面