《留言板系统 项目需求说明书.doc》由会员分享，可在线阅读，更多相关《留言板系统 项目需求说明书.doc（28页珍藏版）》请在三一办公上搜索。
1、项目需求说明书一、 引言 随着网络的逐步普及，以及网络技术的不断发展，人们通过网络交流的方式变得多样化。留言板功能就是网站应用程序中最常用的功能之一。现在很多人开微博，流行在网上留言，这里面也有留言板。网络留言板为用户提供发表留言、发表评论的便捷功能，已成为各类网站的重要组成部分。1. 编写目的为了培养学生独立开发项目的能力，及实现普通用户发表留言功能，普通用户或管理员浏览留言内容的功能，管理员登入后台功能，管理员审核留言内容功能，管理员删除留言功能。本说明书的预期读者为：网站的普通用户和管理员等。2. 项目背景说明：a) 项目名称：留言板信息管理系统b) 本项目的任务提出者及单位：江西农业大
2、学c) 开发者：软件1014黄佳 周天红 廖世勇 龙灏笛 刘阳d) 用户：各大高校e) 实现该软件的计算中心或计算机网络：江西农业大学阶三机房f) 软件环境：MYSQL，MyEclipse，Tomcat5.5；操作系统：windowsXP3. 定义关键名词含义备注HTML超文本标记语言用于描述网页文档的一种标记语言Jdbc 数据库连接连接数据库的类和接口Java 面向对象程序设计语言MyEclipse用于开发Java, J2EE的Eclipse插件集合4. 参考资料a) 李兴华 王月清编著Java Web 开发实战经典北京：清华大学出版社 2010b) 胡孔法等编著的数据库原理及其应用 北京：
3、机械工业出版社 2010c) 高金兰等编著数据库原理与SQL Sever应用（第二版） 北京：科学出版社 2010二、 任务概述1. 目标1. 用户可以浏览主题，注册，登陆。2. 论坛的普通注册用户拥有的浏览，发表主题，回复主题，修改自己的个人资料，查询主题，修改自己发布或回复的帖子等功能。 3. 版主对版块的管理功能，包括对帖子的操作（查询主题，置顶，加为精华，移动，删除，编辑），对用户的操作（禁言，删除id），对版块的操作（发布版块内公告）。4. 系统管理员对版块的操作（版块的建立，修改，删除），对用户的操作（禁言，删除id）, 对帖子的操作（查询主题，移动，删除）,对论坛的操作（开放/关
4、闭会员注册功能）。5. 论坛自身拥有的一些机制包括防止恶意注册，防止机器人恶意访问论坛。6. 用户可以发表留言，管理员可以通过管理员登录进行审核删除的操作，只有进过管理员审核的留言才能显示在用户端。基于系统需求分析，该系统需要实现以下基本功能，下面分别对一些主要功能模块进行介绍。前台管理用户发表留言，填写自己的信息，留言经管理员审核后显示在前台界面，否则显示审核状态。后台管理1. 管理员登录2. 删除留言3. 审核留言4. 发表留言2. 用户的特点 功能描述已注册的用户可以根据输入名字、留言主题、电子邮件、IQCQ、我的主页、留言内容进行提交方可登入系统，其中任何一项未填写系统就会自动弹出提示
5、框，留言内容会有敏感词过滤，留言内容只有经管理员审核才能通过。 功能实现l 用户填写登入信息。l 信息无误，点击提交，完成登入。l 进入用户首页。3. 假定和约束本小组根据对项目的深入分析以及测试和对自己能力的综合评定，决定此项目于一个礼拜之内完成并上交。三、 需求规定1对功能的规定系统划分该网站建设包含以下子系统：前台服务功能后台管理功能登录、注册、修改信息、注销管理个人的留言信息查看、发表、回复留言用户管理留言板信息管理系统查询留言（分类、高级）管理员后台管理版主后台管理系统设置留言管理公告管理其它管理用户角色划分1、 普通（游客）用户是该论坛的一种用户，普通用户以游客身份登录本系统，只具
6、有察看帖子的功能，不能留言。2、 注册用户具备普通用户所有的能力。并且是已经注册了的用户，可以登录、修改个人信息，并且可以发表留言。3、版主具备注册用户所有的能力，其主要权限是对分论坛进行文章管理。4、管理员管理员登录以后可以对论坛系统进行管理，包括论坛的基本信息、用户设置，还可以修改管理员密码。前台服务的用例图1、各种用户信息的操作（面向注册用户）4、各种个人信息的浏览操作（面向注册用户）前台服务的用例事件流1、注册（1）说明主要是指除管理员以外的用户角色（一般为游客），在网上在线填写一些会员的注册信息。注册后即可成为会员。（2）会员注册信息如下信息类型描述用户名20个字符密码20个字符重复
7、密码20个字符昵称20个字符在网上的代号密码提示问题50个字符为了能够找回密码密码提示答案50字符用户的E-MAIL20个字符用户的形象表示的图像50个字符图的文件名称或者文件的编号（3）注册确认用户通过网上在线注册后，由系统管理员收集相应的资料，核实后，进行用户注册确认，确认后用户成为会员正式生效，可以享受网站提供的各种服务。（4）对应的事件流内容说明用例编号Customer_1用例名称用户注册用例说明未注册用户注册成为会员参与者未注册用户前置条件该用户不能是已经注册的用户（帐号不能已经存在！）后置条件后台系统正确地收集用户提交的信息并保存到数据库表中基本路径1、Actor点击注册2、系统显
8、示注册页面3、Actor填写用户名密码等相关信息，点击提交4、后台系统处理该请求并最后显示注册成功5、注册成功后将跳转到登录页进行登录扩展路径3a、Actor填写的信息格式不正确3a1、系统提示输入正确的数据4a、注册失败4a1、系统再跳转到注册页面，提示Actor重新注册补充说明（5）顺序图2、登录（1）说明用户输入登录信息，如用户名、密码。（2）会员登录的信息信息类型描述用户名20个字符密码20个字符（3）登录确认用户通过网上在线输入用户的ID标识信息后，由后台系统收集相应的资料，并进行核实比较确认。（4）对应的事件流内容说明用例编号Customer_2用例名称用户登陆用例说明用户登录系统
9、参与者注册用户前置条件用户是有效的注册用户后置条件用户所输入的信息与后台系统数据库表中所保存的信息一致基本路径1、Actor填入用户名、密码和验证码，点击提交2、系统验证验证码3、系统验证用户名和密码4、验证成功，系统跳转到主页扩展路径1a、用户所输入的登录信息无效1a1、系统提示输入正确格式的用户标识信息2a、验证失败2a1、系统提示Actor重新填写验证验3a、验证失败3a1、系统提示Actor重新填写用户名和密码补充说明（5）顺序图3、修改信息（1）说明会员登录成功后，可以修改自己的注册信息，如密码或者其它的内容等。（2）对应的事件流内容说明用例编号Customer_3用例名称修改用户信
10、息用例说明用户修改自己的注册信息参与者注册用户前置条件注册用户已经登陆系统后置条件系统正确地接收用户提交的信息并且成功地保存到数据库表中基本路径1、Actor点击修改信息2、系统判断该用户是否是已经登录过的用户3、系统再显示信息修改页面4、Actor在该页面中输入新的信息，最和再点击提交按钮5、系统显示修改成功，然后跳转到登录页面进行重新登录确认扩展路径2a、用户身份不合法 2a1、提示用户转去登录4a、修改失败 4a1、系统跳转到错误信息页面，并提示Actor重新修改补充说明（5）顺序图4、在线注销（1）说明会员登录成功后，可以在线注销。此后将不再拥有登录后的在线权限。（2）对应的事件流内容
11、说明用例编号Customer_4用例名称用户在线注销用例说明会员登录成功后，可以在线注销参与者登录后的用户前置条件注册用户已经成功登陆系统后置条件无基本路径1、Actor点击在线注册2、系统判断该用户是否是已经登录过的用户3、系统再显示警告提示是否真的要在线注销4、Actor输入确认信息，最和再点击提交按钮5、系统将在线注销该用户扩展路径2a、用户身份不合法 2a1、提示用户转去登录4a、Actor输入取消在线注销 4a1、系统将退出在线注销状态补充说明（5）顺序图5、某个特定的BBS信息的显示（1）说明游客或者登录成功的用户，可以选择自己感兴趣的版块，并察看其中所感兴趣的帖子（留言）。（2）
12、对应的事件流内容说明用例编号Customer_5用例名称察看帖子用例说明用户查看所需帖子参与者游客或者登录成功的用户前置条件无后置条件无基本路径1、Actor找到需要浏览的版块，点击文章标题进入2、系统显示出该文章扩展路径补充说明6、发表帖子（1）说明注册用户登录成功以后，可以在某版块发表自己的帖子。（2）会员发表留言的信息应该包括下面的内容信息类型描述留言者字符20个字符以内留言标题字符100个字符以内留言摘要字符不限制留言字符不限制（3）发表确认用户通过网上在线发表后，由后台系统收集相应的资料并正确地保存到数据库表中。（4）对应的事件流内容说明用例编号Customer_6用例名称发表帖子用
13、例说明用户发表帖子参与者注册用户前置条件注册用户已经登陆系统后置条件后台系统收集相应的资料并正确地保存到数据库表中基本路径1、Actor点击发表留言2、系统显示发表留言页面表单3、Actor按照表单的要求输入相关的信息，点击提交4、系统显示留言成功扩展路径1a、用户身份不合法1a1、提示用户转去登录3a、输入的信息格式不正确 3a1、系统提示Actor重新填写对应的项目补充说明7、回复帖子（1）说明注册用户登录成功以后，可以在某版块针对某个帖子进行回复。（2）会员回复留言的信息应该包括下面的内容信息类型描述回复者字符20个字符以内回复留言标题字符100个字符以内回复留言摘要字符不限制回复留言的
14、内容字符不限制（3）回复确认用户通过网上在线回复后，由后台系统收集相应的资料并正确地保存到数据库表中。（4）对应的事件流内容说明用例编号Customer_7用例名称回复帖子用例说明用户针对某个感兴趣的留言进行回复参与者注册用户前置条件注册用户已经登陆系统后置条件后台系统收集相应的资料并正确地保存到数据库表中基本路径1、Actor点击回复留言2、系统显示回复留言页面表单3、Actor按照表单的要求输入相关的信息，点击提交4、系统显示回复留言成功扩展路径1a、用户身份不合法1a1、提示用户转去登录3a、输入的信息格式不正确 3a1、系统提示Actor重新填写对应的项目补充说明8、修改留言（1）说明
15、用户登录成功以后，可以针对自己所发表的某个留言进行在线修改。（2）对应的事件流内容说明用例编号Customer_8用例名称修改帖子用例说明用户针对自己已经发表的某个留言进行修改参与者注册用户前置条件注册用户已经登陆系统并发表了留言后置条件后台系统收集相应的资料并正确地保存到数据库表中基本路径1、Actor点击指向某个留言的修改链接2、系统显示修改留言页面表单3、Actor按照表单的要求输入相关的信息，点击提交4、系统显示修改留言成功扩展路径1a、用户身份不合法1a1、提示用户转去发表留言3a、输入的信息格式不正确 3a1、系统提示Actor重新填写对应的项目补充说明9、删除留言（1）说明用户登
16、录成功以后，可以针对自己所发表的某个留言进行在线删除。（2）对应的事件流内容说明用例编号Customer_9用例名称删除帖子用例说明用户针对自己已经发表的某个留言进行删除参与者注册用户前置条件注册用户已经登陆系统并发表了留言后置条件后台系统成功地从数据库表中删除该留言的记录基本路径1、Actor点击指向某个留言的删除链接2、系统显示确认删除的对话框3、Actor输入确认删除的信息4、系统显示留言删除成功扩展路径1a、用户身份不合法1a1、提示用户转去发表留言3a、输入取消删除 3a1、系统退出删除状态补充说明10、分类查询留言（1）说明游客或者登录成功的用户，可以选择自己感兴趣的分类版块，并察
17、看其中所感兴趣的帖子（留言）。（2）对应的事件流内容说明用例编号Customer_10用例名称分类查询留言用例说明用户按照系统的分类形式查看某个类别中的留言参与者游客或者登录成功的用户前置条件无后置条件无基本路径1、Actor找到需要浏览的分类版块，点击分类的名称进入到某分类显示的页面2、系统显示该分类中的各个留言标题3、Actor找到自己所感兴趣的某个留言，系统显示出该留言扩展路径补充说明11、高级查询（1）说明游客或者登录成功的用户，可以按照系统所给定的各种查询选项选择自己感兴趣的查询条件，并察看其中检索到的所感兴趣的帖子（留言）。（2）对应的事件流内容说明用例编号Customer_11用
18、例名称高级查询帖子用例说明照系统所给定的各种查询选项选择自己感兴趣的查询条件，查看某个留言参与者游客或者登录成功的用户前置条件无后置条件无基本路径1、Actor点击高级查询进入到高级查询的页面2、系统显示该高级查询中的各种查询条件选项3、Actor输入各种所感兴趣的查询条件选项4、系统显示出所找到的满足条件的留言扩展路径2a、未输入条件选项2a1、将以系统中默认的查询条件选项进行查询4a、未找满足条件的留言 4a1、系统提示请改变查询条件选项，重新查询补充说明12、显示用户列表用例名称显示用户列表功能简述显示所有注册用户的信息。主事件1、点击“会员列表”按钮，显示所有会员信息。备注事件后台管理
19、系统中的各个模块留言板信息管理系统后台管理功能用户管理管理员后台管理版主后台系统设置留言管理公告管理其它管理1用户个人信息管理1、个人资料查看:查看自己的所有资料。2、编辑个人资料:修改除帐号密码外的所有资料3、个人头像，系统默认一个个人头像，并提供12个左右的头像供用户选择，若用户不满意系统自带的头像，可以自己上传头像，头像会被系统按照一定的算法进行压缩以适应论坛的外观和结构，不会产生大的变形。4、好友管理，删除、添加、编辑用户的好友。5、短消息管理，收件箱、发件箱、草稿箱中的信息删除、编辑等操作。2版主后台版主的管理界面除了个人后台的所有功能外，还包括以下的功能：1、帖子管理：斑竹有权对自
20、己管理范围内的帖子进行删除、编辑操作。主要操作包括：删除帖子、帖子加精、帖子置顶。2、用户管理：对违章用户进行惩罚，具体如下：封用户ID，没收用户ID一定时间。3、版块公告发布：此权限需要管理员允许。3管理员后台管理员后台拥有斑竹后台的所有内容，除此之外还包含以下权限：1、全论坛用户帐户的删除权限2、公告发布3、论坛设置(UBB,HTML支持等)4、斑竹设置(添加,更改,废除斑竹)5、后台帐户管理(密码修改)6、版块管理:添加版块,子版块,设置版块斑竹;编辑版块,子版块,变换斑竹;删除版块,子版块,同时废除斑竹后台管理系统中的各个用例后台管理系统中的各个用例的事件流1、系统管理员登陆系统管理员
21、提交用户名和密码，系统验证用户名和密码的合法性，系统显示系统管理员管理页面（包含管理员的信息）2、论坛基本信息管理对网站参数、通行证设置、COOKIE设置、公告设置进行管理-下面的各个用例只是示例说明，实际应该进一步对下面的部分用例进行细化。内容说明用例编号System_1用例名称论坛基本信息管理用例说明管理员对用户进行权限管理，状态管理，查询信息参与者管理员前置条件管理员登陆系统后置条件基本路径1、Actor点击论坛基本信息管理2、系统显示论坛基本信息管理页面3、Actor对论坛管理进行相关操作扩展路径补充说明3、打开/关闭论坛对论坛的打开或关闭进行管理。内容说明用例编号System_2用例
22、名称打开/关闭论坛用例说明管理员对论坛的打开关闭进行管理参与者管理员前置条件管理员登陆系统后置条件基本路径1、Actor点击打开/关闭论坛2、系统显示打开/关闭管理页面3、Actor对设置进行相关操作扩展路径补充说明3、 用户级别设置对用户的级别进行管理。内容说明用例编号System_4用例名称用户级别设置用例说明管理员对用户进行级别设置参与者管理员前置条件管理员登陆系统后置条件基本路径1、Actor点击用户级别设置2、系统显示用户级别设置页面3、Actor对用户级别设置进行相关操作扩展路径补充说明4、 封锁中心对封锁IP和文字过滤进行管理。内容说明用例编号System_5用例名称封锁中心用例
23、说明管理员对用户IP/文字进行过滤参与者管理员前置条件管理员登陆系统后置条件基本路径1、Actor点击封锁中心2、系统显示封锁中心页面3、Actor对封锁进行相关操作扩展路径补充说明5、 发帖设置对用户的帖子设置、上传文件设置、全文检索设置、缓存设置进行管理。内容说明用例编号System_6用例名称发帖设置 用例说明管理员对用户进行发帖设置 参与者管理员前置条件管理员登陆系统后置条件基本路径1、Actor点击发帖设置2、系统显示发帖设置页面3、Actor对发帖设置进行相关操作扩展路径补充说明6、 邮件设置对邮件用户名、密码进行管理。内容说明用例编号System_7用例名称邮件设置用例说明管理员
24、对邮件进行设置参与者管理员前置条件管理员登陆系统后置条件基本路径1、Actor点击邮件设置2、系统显示邮件设置页面3、Actor对邮件设置进行相关操作扩展路径补充说明7、 版区设置：对各个版区进行管理。内容说明用例编号System_8用例名称版区设置用例说明管理员对版区进行设置参与者管理员前置条件管理员登陆系统后置条件基本路径1、Actor点击版区设置2、系统显示版区设置页面3、Actor对版区进行相关操作扩展路径补充说明8、 修改密码对管理员的用户名和密码进行管理。内容说明用例编号System_9用例名称修改密码用例说明管理员对自己的用户名和密码进行更改参与者管理员前置条件管理员登陆系统后置
25、条件基本路径1、Actor点击修改密码2、系统显示修改密码页面3、Actor对密码进行相关操作扩展路径补充说明2. 对性能的规定（1）网站整体要求对于网站风格方面，应该尽量做到网站结构简单明了，结构条理清晰，页面精美、功能实用；而对于版面方面的要求，则应该设计构思力求精巧、布局要求简捷合理、网站整体设计风格统一。（1）界面设计精美、友好，信息化设计，体现企业级应用的特色（2）更快的信息访问速度、更加省时和智能化的用户界面-网络响应速度应该尽量快（3）更简便、智能化程度更高的浏览查询流程 （4）后台管理功能强大、录入效率高（5）易于查看基于网民的建议和评论，以及后台信息（6）提供给用户的书籍信息
26、尽可能详细（2）精度a. 用户输入精度的要求取决于相应功能所需参数的精度要求在用户浏览的页面内如果需要用户输入相关的信息或参数将给出详细的数据类型说明，并且如果用户在非恶意的情况下输入了错误的数据类型参数，系统将自动提示用户再次输入正确的参数。b. 管理员输入的精度要求主要取决于数据库的相关数据类型要求在数据库为系统管理员提供的多种视图中将有各类数据库对象的相关数据类型及精度要求。管理员工作过程中可以利用工具或查询有关数据库对象的精度信息已决定输入的参数。如果管理员输入的参数与要求不符将得到提示并重新进行操作。（3）时间特性的要求a. 响应时间由硬件条件的不同决定，但总体上客户端的请求处理响应
27、时间不应多余15sb. 更新处理时间由硬件条件及处理的数据量决定，但总体上向数据库添加和删除一条记录的时间不应多余15sc. 数据的转换和传送时间根据具体的转换和传送数据不同所需的时间不同，总体不应超过15sd. 解题时间用户身份认证的时间不应超过15s（4）灵活性本网站采用四层架构设计并利用JAVA语言编写，从平台移植的角度来讲有很大的活力。a. 操作方式上的变化不同平台对于网站功能的使用是没有影响的。b. 运行环境的变化本系统可以利用部署配置文件来完成对系统的编译过程，并且这种部署是一次部署长久使用的，因此从运行环境来看有很好的可控性和灵活性。c. 精度和有效时限的变化该系统的精度和有效时
28、限依赖于开发过程中的整体设计可变性较小。d. 计划的变化或改进该系统明确了必须完成的用户功能，对于额外的功能在规定的时间内提前完成的可能性比较小。3. 输入输出要求（1）系统后台与前台的统一设计本系统设计是将后台部分的入口放在主页面上，以方便系统管理人员的通用化管理。当系统管理员登陆系统首页面时，在系统的最上方会出现管理员登陆的入口，可以从此进入后台管理页面。同时在系统后台和前台的设计上，系统采用了共同的页面开发模式和组件调用模式，其中的文件头和文件尾等部分是相互通用的。因此两个部分的设计，可以说是分离与结合的完美统一。（2）页面内容的分块设计在系统主页中，从页面头、版面列表、推荐论坛、用户来
29、访信息、论坛图例、文件尾等部分都进行了抽象提取，这样在需要用到某部分的页面时，只需要进行相关的包含或者利用模板技术来引用。4. 数据管理能力的要求4.1 数据采集的要求1.输入源：手工键盘输入 2.输入介质和设备：键盘、磁盘 3.输出介质和设备：磁盘、打印纸4.2数据采集的处理1.javabean组件2.jsp页面3浏览器编译4.3.数据容量 本系统需要10张表，每个表记录规模1万条记录，每张表使用的空间1G左右，最多使用10G存储。增长数据非常少，可忽略不计。5. 故障处理要求 5.1 正常时不应出错 若运行时遇到不可恢复的系统错误，系统也必须保证数据库完好无损 5.2故障处理方法1系统如果
30、出现应用服务器关闭，数据库连接断开等软件异常，会给在log信息详细表示。2如果事务处理过程出现故障，事物回滚，保证数据的完整性。3如果多人同时访问一条记录，加锁该记录，避免脏数据。4数据库采用增量备份法，出现数据库故障时数据库恢复。5.2 错误日志的要求 应用程序应能提供易于查看的日志，便于系统的维护、调试、错误定位等，系统日志应至少可以保存50000条程序运行记录。同时，由于是多线程环境下运行，每条日志中应该打印出该日志的线程ID。6其他专门要求 1应保证使用时的安全性，防止病毒破坏系统 2安全性方面的具体要求：服务器安装防火墙和身份认证 3性能方面：Web支持1000个人同时在线浏览，数据
31、库支持20个连接。 4.对网络构建的要求：硬件设备系统在本地机上进行开发。测试。然后部署到基与Tomat服务器的远程5 服务器：a.处理型号及内存容量：1G以上 b.外存容量、脱机、或联机及媒体及其存储格式，设备的型号及数量：硬盘1000G以上 c.输入及输出设备型号和数量，联机和脱机，考虑到数据的安全性问题，要求使用磁盘阵列 d.数据通信设备的型号和数量：本地机：处理器型号及内存容量：内存256M以上；外存容量、联机和脱机、媒体及其存储格式，设备的型号及数量：硬盘40G以上。支持软件： e.操作系统：利用windows操作系统进行开发，后台开发工具使用Myeclips。应用服务器选择为Tomacat数据库选择SQLServer。测试软件 普通的javabean。四、运行环境规定1.设备要求：l 处理器：英特尔奔腾III及以上l 内存：1GB以上2.支持软件：（1）服务器端：TOMCAT5.5、SQLServer2005（2）客户端：Windows XP/Vista/7/8、MAC OS（3）测试软件：Chrome、IE、FireFox、世界之窗、360安全浏览器、搜狗浏览器等浏览器（4）使用程序：浏览器3.控制：该程序使用JSP代码实现相关功能，运行在浏览器上，功能的实现效果直接显现在网页上。该程序使用网页上的按钮控制程序的使用。4接口：该系统使用HTTP协议
