BBS论坛管理系统_软件需求说明书_V1.1.docx

BBS论坛管理系统软件需求说明书 BBS论坛管理系统软件需求说明书Version 1.1 作 者： 完成日期： 签 收 人： 签收日期： 修改情况记录：版本号修改批准人修改人修改日期V1.0 1引言31.1编写目的31.2背景31.3定义31.4参考资料32任务概述42.1目标42.2用户的特点42.3假定和约束43需求规定53.1对功能的规定53.1.1用例图53.1.2系统角色划分63.1.3整体模块划分73.1.4功能清单73.1.5系统数据流图113.1.6系统原型界面123.2对性能的规定203.2.1精度203.2.2时间特性要求203.3输人输出要求203.4故障处理要求203.5其他专门要求204系统运行环境214.1设备214.2支持软件214.3接口211引言1.1编写目的为明确软件需求、安排项目规划与进度、组织软件开发与测试，撰写本文档。本文档供项目经理、设计人员、开发人员参考。1.2背景BBS起源于20世纪80年代初。最初，论坛只是用于发布公告信息，讨论问题的在线交流平台。后来，随着网络的普及，论坛的功能越来越丰富，受到广大网民的欢迎。当代的大学生几乎都会接触甚至经常登陆自己感兴趣的论坛，在上面可以分享，也可以交流意见。但同时，虽然目前网络上有很多优秀的商业或开源的BBS，但绝大多数都只是作为一个独立的论坛系统而发布，因此很难集成到其他系统中。为此，我们希望做出一套不仅功能完善，同时可以比较快捷方便地集成到客户现有系统中的BBS论坛管理系统。1.3定义(名词说明)BBS: Bulletin Board System (电子公告板)用例图（User Case）：定义了系统的功能需求，从系统的外部看系统功能，并不描述系统内部对功能的具体实现。数据流图（Data Flow Diagram）：从数据传递和加工角度，以图形方式来表达系统的逻辑功能、数据在系统内部的逻辑流向和逻辑变换过程。基本功能：能保证系统正常运作的基本功能需求。拓展功能：为使系统具有更好的实用性、交互性等，而对系统添加的特定功能需求。 1.4参考资料1 计算机软件产品开发文件编制指南 GB 8567-882 BBS论坛管理系统原型界面设计（基于excel绘制） 与本文档存放于相同目录2任务概述2.1目标这个系统预期的目的是为了做成一个功能完整的论坛管理系统。网上游客能够浏览论坛上的帖子，并且能够注册成为用户。论坛注册会员能够修改自己的资料信息，申请版主，发表帖子等。论坛管理员能够管理论坛，包括浏览游客留言，审核留言，对于不健康或是不利于社会稳定的留言能进行删除操作，会员管理以及论坛版主管理等。 该系统的另一个重要目标是，可通过某种协议约定，在不修改客户现有系统的代码及数据库的情况下，在其中通过超链接等形式无缝集成该BBS系统。即客户现有系统中的用户可直接跳转至BBS而不用注册或登录。同时，还必须保证一定程度上的安全性。2.2用户的特点本BBS论坛管理系统按预定设计为软件学院BBS论坛系统，但考虑到BBS系统的通用性和应用的广泛性，该系统的用户群定位为普通电脑用户，即不假定用户具有计算机方面的专业知识，而只需具备基本的电脑使用和网络浏览常识即可。系统的维护人员是软件专业人士，懂计算机基础知识、数据库与Web技术等相关知识。2.3假定和约束本系统所采用的开发技术必须遵循J2EE的开发规范，开发期限具体由指导老师规定截至的时间为准，且在开发完成时要保证最终形成产品的质量和实用性，以达到此次SEWA创新课程的项目要求。3需求规定 3.1对功能的规定3.1.1用例图图1 BBS论坛管理系统用例图3.1.2系统角色划分图2 系统角色划分图1 游客基本功能：1） 注册为注册用户2） 浏览版块，浏览和检索帖子（是否可匿名回复帖子待定）拓展功能：无2. 注册用户基本功能：1） 登陆、注册、修改个人信息2） 浏览版块，浏览、创建、回复、检索帖子2 管理员基本功能：1） 系统后台登陆2） 浏览、搜索、删除注册用户3） 浏览、创建、修改、删除版块4） 浏览、创建、删除和检索帖子拓展功能：1） 设置特定注册用户为特定版块版主2） 特定帖子置顶、加精3.1.3整体模块划分图3 整体模块划分图1用户管理包括用户注册、用户登陆、用户信息修改、搜索用户、删除用户等功能（不同角色用户所能使用的功能范围不同，角色划分参见下一节，下同），另外可拓展增加用户等级制度等。2版块管理包括版块的浏览、创建、修改、删除等功能，另外可拓展增加版主制度等。3帖子管理包括帖子浏览、创建、回复、删除和检索等功能，另外可拓展增加帖子置顶、设置为精华贴等。3.1.4功能清单根据以上分析结果，对功能进行细化，得出如下各模块的功能清单：1. 用户管理：图4 用户管理模块功能清单基本功能：1） 用户注册：用户输入自己的基本信息，系统验证信息的有效性，并将用户信息存入数据库。2） 用户登陆：用户输入自己的用户名和密码，系统检验用户名和密码的有效性，对合法用户基于角色授权。3） 用户信息修改：用户可以对自己的基本信息进行修改。4） 删除用户：管理员可以删除那些不符合BBS管理规则，长时间不登录帐号的用户。拓展功能：1） 用户积分制度：根据用户的登录次数、发帖数量和质量等给予用户不同加分，具体制度待定。2. 版块管理: 图5 版块管理模块功能清单基本功能：1） 浏览版块：用户（包括游客）可以浏览论坛中的各版块。2） 添加版块：管理员可以根据用户的需要添加新的版块。3） 删除版块：管理员可以对不能为用户提供更好信息的版块进行删除。拓展功能：1） 版主制度：管理员可以根据需要设置任意注册用户为任意版块的版主。3. 帖子管理: 图6 帖子管理模块功能清单基本功能：1） 浏览帖子：用户（包括游客）可以浏览论坛中的帖子。2） 发表帖子：注册用户可以在自己感兴趣的版块中发表新的帖子。3） 删除帖子：管理员可以对要进行删除的所有帖子进行删除，版主只能对自己版块内的帖子进行删除。4） 回复帖子：注册用户可以对自己感兴趣的主题回复帖子。5)检索帖子：用户（包括游客）可以通过输入关键字检索自己感兴趣的帖子。拓展功能：1） 帖子置顶：管理员可以对点击率高和回复率高的帖子进行置顶，版主只能对自己版块内的帖子进行置顶。2） 指定精华：当管理员发现用户所发表的帖子非常好时将该帖指定为精华，版主只能对自己版块内的帖子指定为精华。3.1.5系统数据流图图7 游客数据流图图8 注册用户与管理员数据流图3.1.6系统原型界面1首页图9 系统原型界面 首页页面说明：首页分为网站logo、导航条、帖子搜索区、用户登录区、通知区、新闻区、版块信息区、帮组服务与版权区。搜索服务可提供按主题（即帖子标题）、按作者两种方式通过关键字检索帖子，搜索结果将列出包含该关键字的全部条目。通知和新闻都是以帖子链接的形式给出，方便用户以跟贴的形式评论该新闻或通知以及信息补充。一般情况下通知帖或新闻帖只能由系统管理员发布。用户登录后原登录区将变为用户个人管理区，可以管理帐户，如修改密码、修改个人信息等，并提供链接可以直接注销登陆。2注册图10 系统原型界面 注册页面说明：帐户信息是必填的（每一项后面都有*号），包括用户名、密码和密码确认。用户名用来在网站范围内唯一标识用户，故不能重复，否则会提示用户注册失败，需更换注册用户名。 用户名和密码都应遵循一定格式，如用户名必须以字母开头，而密码长度应不低于6位等等。具体格式待定。用户信息是选填的（每一项后面不包括*号），包括用户的联系信息、个人简介、兴趣爱好等。用户信息是用来方便用户之间的交流联系的。3进入版块图11 系统原型界面 进入版块页面说明：在首页点击任意版块链接即可进入具体版块。用户登录区下方是版块信息，包括版块介绍、版块的主题数（及主帖数）、回复数（及跟贴数）和版主的用户名等。已登录用户点击发帖可直接进入发帖界面，未登录用户则转到登录界面，提示需要登录才能发帖。点击返回首页即退出当前版块返回至网站首页。主题列表区包括主题帖的标题、作者、发布时间、回复数、查看数以及最后回复用户的用户名和回复时间。点击列表区上方的链接可查看全部主题或精华主题，并可按时间段查看，如一天内、一周内等。4浏览帖子图12 系统原型界面 浏览帖子页面说明：在帖子列表区点击任意主题帖标题，即可进入帖子具体页面浏览。每一条帖子的左侧是发帖人信息，包括用户的用户名、头像、用户等级、用户类型等。帖子右侧上方是帖子信息，包括发帖时间、该贴所处楼层。右侧下方是帖子具体内容。注册用户点击回复可弹出回复窗口，编辑内容并点击发表回复及可回复该主题。未登录用户点击回复则转到登录界面，提示需要登录才能回复。5管理员登录图13 系统原型界面 管理员登录页面说明：管理员登陆界面需访问特定URL才可进入，例如: XXX/admin。其中XXX为网站根路径。系统管理员输入正确的用户名和密码，即可登入管理员界面。 6管理员首页图14 系统原型界面 管理员首页页面说明：在管理员登录界面成功登录，即进入管理员首页。由于管理员一般情况下就是论坛的建设者，需要了解论坛的使用情况。故首页可放置该论坛的统计信息，让管理员对自己的论坛规模、人气等有直观了解。统计信息可包括当前在线人数、今日访问人数、总访问人数等。 管理员首页左边为管理菜单，包括论坛参数、版块管理、用户管理、帖子管理四个菜单项，对应不同管理模块。 7论坛参数图15 系统原型界面 论坛参数页面说明：在管理员首页点击左侧菜单项“论坛参数”，即可进入论坛参数页面。论坛参数是整个BBS管理系统的一些全局可配置参数。例如：数据库连接URL、数据库用户名及密码、网站是否处于下线（offline）状态等，具体可设参数依据实际设计。 8版块管理图16 系统原型界面 版块管理页面说明：在管理员首页点击左侧菜单项“版块管理”，即可进入版块管理页面。如图，版块管理页面包含了对版块信息进行增、删、改、查的全部功能操作，且可以按名称、编号搜索特定版块。点击“添加”会进入新增版块页面，需要填写版块基本信息等。点击“查看”版块具体信息时，会进入版块详细信息页面，该页面包含编辑按钮，可修改版块全部信息。选中若干版块后点击“删除”，可删除所有选中版块。但若有版块仍有帖子存在，则提示不能删除，以免误删造成帖子信息丢失。注： 用户管理、帖子管理页面与版块管理页面类似，故不再重复。3.2对性能的规定3.2.1精度本系统不涉及高精度计算，对数据精度无特殊要求。3.2.2时间特性要求用户的操作响应时间应在3秒以内。3.3输人输出要求1. 系统所有输入数据（如表单填写）必须按照提示所给出的格式或按通用约定格式输入，否则系统将提示错误或不给予响应。2. 用户搜索和帖子检索采用模糊查询，即使用者只需给出查询所需关键字，系统将依据所查询项给出包含关键字的全部结果。3.4故障处理要求本系统使用频繁，要求长时间不间断运营，使用时应保证系统的容错性和稳定性。运行时若由于系统自身漏洞或用户操作不当等原因出现错误，应尽量使用用户友好的界面和出错提示，并详细地给出错误恢复的步骤；若出现不可修复的错误，应优先保证数据安全。3.5其他专门要求1. 用户密码加密：用户注册时所填密码需采用特定加密算法加密后，方可存入数据库相应字段，以保证用户信息的安全。用户登录时填写的密码也需经过相同加密算法加密后才能与数据库中所存字段相匹配。2验证码机制：为了避免不良用户使用程序对论坛进行灌水和发布垃圾广告，使用户得到更安全的服务，本系统采用验证码机制，即要求用户发贴或其它认证时，需要输入页面中用图片显示的字符串。用户不用记忆附加码，附加码只对当次服务有效，不能重复使用。4系统运行环境4.1设备l 内存要求至少为512Ml CPU要求为1.6 GHZ或更高频率以上l 硬盘容量要求为40G以上。4.2支持软件l 操作系统：Windows XP及以上l 数据库: MySQL 5l Web服务器： Tomcat 6l Java运行环境：Java Runtime Environment(JRE)4.3接口由于本系统的一个重要需求是可以比较快捷方便地集成到客户现有的系统中，故系统的集成接口部分的设计对于本系统尤其重要。预期的接口设计基本思路为：通过约定特殊字符串的方式，在不修改客户现有系统的核心代码及数据库的情况下，仅通过加入包含此（经过加密的）特殊字符串参数的URL链接，即可无缝集成该BBS系统。通过这种方式，客户现有系统中的用户第一次进入该集成BBS系统时，可直接跳转至已登录状态而不用输入登录信息或提示注册。该BBS系统将负责识别进入该系统时通过URL参数所传入的特殊字符串（经过解密后）是否符合约定，若符合则为其自动创建用户并跳过本系统的密码验证机制。由以上接口设计可知，客户系统和BBS系统的实现集成的流程分别为：一、客户系统流程：图17 系统集成实现 客户系统流程流程补充说明：1约定加密解密所使用的密匙使用对称密匙机制，故密匙需保密。2. 在需加入BBS入口的页面的某个位置加入超链接，显示链接为该BBS系统。链接的URL设置为该BBS的URL加上两个URL参数，第一个参数为用户在原系统中的用户名，第二个参数为该用户名经约定密