BBS普通用户详细设计说明书

1、BBS普通用户详细设计说明书编写： 日期：2012-12-21审核：日期：批准：日期：受控状态：是 发布版次：1.0日期：2012-12-21编号：变更记录日期版本变更说明作者2012-12-211.0初始版本李赫然签字确认系统模块对应章节对应部门负责人签字目 录2 引言32.1 编写目的32.2 背景42.3 基线42.4 范围52.5 定义52.6 参考资料52.7 术语与缩写解释63 模块命名规则74 模块汇总74.1 模块汇总表74.2 模块关系图75 子系统模块设计85.1 用户注册85.2 用户登录85.3 新建留言95.4 发送留言95.5 已发送留言105.6 接收留言105.

2、7 草稿留言115.8 回收站115.9 通知管理115.10 通讯录125.11 客户反馈125.12 基本信息135.13 密码修改1312 引言2.1 编写目的读者范围：最终用户、软件设计人员本文档作为BBS论坛第一期的需求说明文档，用于与用户确定最终的目标，并成为协议文本的一部分，同时也是本系统设计人员的基础文档。2.2 背景BBS(Bulletin Board Service,公告牌服务)是Internet上的一种电子信息服务系统，它提供一块公共电子白板，每个用户都可以在上面书写，并且可发布信息或提出看法。大部分BBS由教育机构、研究机构或商业机构管理，象日常生活中的黑板报一样，电子

3、公告牌按不同的主题，分主题分成很多个布告栏。布告栏的设立的依据是大多数BBS使用者的要求和喜好，使用者可以阅读他人关于某个主题的最新看法，也可以将自己的想法毫无保留地贴到公告栏中。同样地，别人对你的观点的回应也是很快的。如果需要独下的交流，也可以将想说的话直接发到某个人的电子信箱中，如果想与正在使用的某个人聊天，可以启动聊天程序加人闲谈者的行列。虽然谈话的双方素不相识，却可以亲近地交谈。在BBS里，人们之间的交流打破了空间、时间的限制。在与别人进行交往时，无须考虑自身的年龄、学历、知识、社会地位、财富、外貌、健康状况，而这些条件往往是人们在其他交流形式中无可回避的。同样地，也无从知道交谈的对方

4、的真实社会身份。这样，参与BBS的人可以处于一个平等的位置与其他人进行任何问题的探讨。这对于现有的所有其他交流方式来说是不可能的。目前国内的BBS已经十分普遍，可以说是不计其数,其中BBS大致可以分为5类：（1）校园BBS CERNET建立以来，校园BBS恨快地发展了起来。目前很多大学都有了BBS，几乎遍及全国上下，像清华大学、北京大学等等都建立了自己的BBS系统。清华大学的水木清华很受学生和网民们的喜爱。（2）商业BBS站，这里主要是进行有关商业的商业宣传、产品推荐等等。目前手机的商业站、电脑的商业站、房地产的商业站比比皆是。 （3）专业BBS站，这里所说的专业BBS主要用于建立地域性的文件

5、传输和信息发布系统。（4）情感BBS，主要用于交流情感,是许多娱乐网站的首选。 （5）个人BBS，有些个人主页的制作者们在自己的个人主页上建设了BBS，用于接受别人的想法，更有利于与好友进行沟通。2.3 基线BBS普通用户详细设计说明书 v1.02.4 范围系统包括的范围：系统包括的范围：DB数据库的设计、管理员登陆的html界面以及相关的跳转界面。2.5 定义2.6 参考资料J2EE项目实训Hibernate框架技术（21世纪高等学校实用软件工程教育规划教材）杨少波 等编著 清华大学出版社 2008 年5月J2EE项目实训Spring框架技术（21世纪高等学校实用软件工程教育规划教材）杨少波

6、 等编著 清华大学出版社 2008 年5月J2EE项目实训UML及设计模式（21世纪高等学校实用软件工程教育规划教材）杨少波 等编著 清华大学出版社 2008 年5月J2EE项目实训Struts框架技术（21世纪高等学校实用软件工程教育规划教材）杨少波 等编著 清华大学出版社 2008 年10月2.7 术语与缩写解释缩写、术语解 释JSP(JavaServer Pages) JSP技术使用Java编程语言编写类XML的tags和scriptlets，来封装产生动态网页的处理逻辑。网页还能通过tags和scriptlets访问存在于服务端的资源的应用逻辑。JSP将网页逻辑与网页设计和显示分离，支

7、持可重用的基于组件的设计，使基于Web的应用程序的开发变得迅速和容易StrutsStruts只是一个MVC框架（Framework）用于快速开发Java Web应用。Struts实现的重点在C(Controller)，包括ActionServlet/RequestProcessor和我们定制的Action,也为V(View)提供了一系列定制标签（Custom Tag）。但Struts几乎没有涉及M(Model),所以Struts可以采用JAVA实现的任何形式的商业逻辑。 JDBCJDBC（Java Data Base Connectivity,java数据库连接）它是一种用于执行SQL语句的J

8、ava API，可以为多种关系数据库提供统一访问，它由一组用Java语言编写的类和接口组成。JDBC为工具/数据库开发人员提供了一个标准的API，据此可以构建更高级的工具和接口，使数据库开发人员能够用纯 Java API 编写数据库应用程序。3 模块命名规则数据库表、字段命名规则数据库表名：表名说明USER用户信息表ADMIN管理员信息表AUTHORITY用户权限表BOARD版块信息表TOPIC话题信息表POST帖子信息表LINK友情连接表数据库表字段名：序号项目前缀备注1用户信息表字段名USER_2管理员信息表字段名ADMIN_3用户权限表字段名AUTH_4版块信息表字段名BOARD_5话题

9、信息表字段名TOPIC_6帖子信息表字段名POST_7友情连接表字段名LINK_对象命名规范序号项目前缀备注1按钮bt_Button2图片按钮ibt_ImageButton3文本框tb_TextBox4下拉列表ddl_DropDownList5单选按钮rbt_RadioButton6标签lb_Label7链接按钮lbt_LinkButton8数据列表GeidView_GridView9数据源DataSource_SqlSataSource函数命名规则及注释规范1) 函数命名规则：获取信息：Get*设置信息：Set*删除信息：Delete*修改信息：Modify*更新信息：Update*插入信息

10、：Insert*(2) 注释书写规范： 函数头部单行注释：/注释内容例如：/更新操作，TableName：表名，ht：哈希表，where：更新条件,例如：where=where id=1;public bool Update(String TableName, Hashtable ht, String where) return DBO.Update(TableName,ht,where); 函数头部多行注释：/* 注释内容*/例如：/*-以下这个函数是获取DtatTable数据集用法举例：if (dt.Rows00.ToString() != null)Label1.Text = dt.Ro

11、ws00.ToString() + dt.Rows01.ToString();返回DataTable */public DataTable GetDataTable(String strSQL) return DBO.GetDataTable(strSQL); 程序语句注释：语句; /注释例如：if (dt.Rows.Count = 1) /用户名已存在 return true; /返回真else /当前用户名可用 return false; /返回假4 模块汇总4.1 模块汇总表提示：这里模块是指相对独立的软件设计单元，例如对象类、函数包等等。留言管理模块名称功能简述新建留言用户编写留言发送

12、留言用户发送留言已发送留言存放用户发送过的留言内容，支持编辑转发接收留言存放接收留言草稿箱存放草稿，支持编辑发送回收站存放逻辑删除的留言内容通知管理显示管理员下发的通知通讯录显示用户的联系人客户反馈反馈信息用户管理模块名称功能简述基本信息用户基本信息密码修改由于修改登录密码公共模块模块名称功能简述登录用户登录注册 新用户注册4.2 模块关系图普通用户公共模块用户管理留言管理新建留言发送留言已发送留言接收留言草稿箱回收站通知管理通信录客户反馈基本信息密码修改登陆注册5 子系统模块设计5.1 用户注册模块名称用户注册功能描述用户进入注册页面需要填写以下信息昵称（不能包含非法字符）姓名（不能包含非法

13、字符）性别（不能为空）E-MAIL（要进行格式校验）民族家庭住址（50个字符）联系电话QQ号码密码（不少于6位）确认密码（不少于6位）当用户提交时判断昵称是否存在，给出提示信息（用户已存在注册成功（普通用户）接口与属性1、 用户名需用户输入，经检测如果与系统已有用户名无重名，则可使用。2、 密码需用户输入，可由数字、字母等构成，输入密码后，还需要再次输入密码进行确认。3、 性别，在下拉列表中选择，默认为“男”。4、 用户注册时间由系统自动获取。用户状态有系统自动设置为0。0表示正常用户，1表示被查封。注册成功后用户可自行修改信息。数据结构与算法采用哈希表保存用户注册信息，调用数据库操作类的函数

14、将信息写入用户表中。补充说明5.2 用户登录模块名称用户登录功能描述用户输入登录信息（用户名和密码不为空），若用户名不存在，则提示无此用户并跳转注册界面，若密码错误则提示密码输入有误，返回登陆界面。若信息读取成功，则进入该角色BBS留言板。接口与属性1、 用户名，对用户输入的信息进行安全检查，防止SQL注入攻击。2、 密码，也要进行安全检查。3、 验证码，验证码为根据当前时间产生的一个随机码，由四个数字构成。用户通过点击“登录”进行登录。4、 如果登录失败，则按照失败原因进行提示，如“用户名或者密码错误”、“验证码错误”等。数据结构与算法检索数据库之前，先对用户如入的信息进行有害字符过滤。然后

15、调用相应地函数检索数据库，先按照用户名检索出用户信息，再将用户输入的密码和数据库中的密码进行比较，密码一致则登录成功。补充说明5.3 新建留言模块名称新建留言功能描述新建留言模块的用户需求：用户打开新建留言，先选择好友，再编辑发送内容，可选择保存草稿或发送。当点击发送的时候，后台程序会进行页面校验，如果输入内容为空或者发送内容多于150字，则校验不通过并返回新建留言的界面。校验通过后开始发送，如果发送成功，发送的留言会保存在已发送留言中；如果发送失败，则提示发送失败并返回编辑页面。接口与属性4、 用户名，对用户输入的信息进行安全检查，防止SQL注入攻击。5、 密码，也要进行安全检查。6、 验证

16、码，验证码为根据当前时间产生的一个随机码，由四个数字构成。用户通过点击“登录”进行登录。4、 如果登录失败，则按照失败原因进行提示，如“用户名或者密码错误”、“验证码错误”等。数据结构与算法调用数据库操作类的函数将信息写入表中。补充说明5.4 发送留言模块名称发送留言功能描述普通用户进行发送留言的动作，将接受者的姓名以及发送的内容送入留言系统，系统对其进行模糊查询，根据其内容判断有无记录。若已有记录，则显示发送的内容。若无记录，则要进行提示，说明没有当前记录。若留言发送失败，则要进行再次发送这一动作。当留言发送完成后，要对当前内容进行删除，并将删除状态由未删除变更为已删除，将删除内容送入回收站

17、。接口与属性对输入留言进行校验，如留言内容超出字符或内容为空，则不能通过校验数据结构与算法调用数据库操作类的函数将信息写入表中。补充说明5.5 已发送留言模块名称已发送留言功能描述已发送留言：转发：提取发送人以及内容，对内容进行修改点击发送并进行内页面检验。如果发送成功提示成功信息，在已发送留言中产生记录，并进入已发送页面。如果失败，提示失败信息，在发送页面中产生记录，并进入发送页面。阅读状态：标记是否阅读。 逻辑删除：选中删除邮件点击删除成功，在回收站中产生相应记录并进入更新后的已发送留言界面。若未成功则提示“未成功”并返回到已发送留言界面。接口与属性对转发留言进行校验，如留言内容超出字符或

18、内容为空，则不能通过校验数据结构与算法调用数据库操作类的函数将信息写入表中。补充说明5.6 接收留言模块名称接收留言功能描述用户接受其他用户发来的留言，用户可以对发送来的留言进行查看，回复和转发操作，当点击查看按键，在列表栏有一栏显示是否已阅读留言就会由未阅读变为已阅读，单点击回复，将会显示一个新的窗口，你可以在最上面的文本框用户名栏输入你要发送的用户的姓名，你也可以通过下拉列表对你想要发送的用户的姓名，选择完毕后，在下面的文本域中输入你的要回复的内容（不可超过150字），即可点击发送，若不发送则将会保留在草稿箱中，当点击转发，则会提取你收到信息的内容，你可以对其进行修改，以下等同回复。当发送

19、成功着会提示发送成功，并复制一份到已发送文件中，若不正确则提示你发送失败，你要发送的信息将会保存在草稿箱中。接口与属性数据结构与算法调用数据库操作类的函数将信息写入表中。补充说明5.7 草稿留言模块名称草稿留言功能描述新建留言模块的用户需求：用户打开新建留言，先选择好友，再编辑发送内容，可选择保存草稿或发送。当点击发送的时候，后台程序会进行页面校验，如果输入内容为空或者发送内容多于150字，则校验不通过并返回新建留言的界面。校验通过后开始发送，如果发送成功，发送的留言会保存在已发送留言中；如果发送失败，则提示发送失败并返回编辑页面。接口与属性对输入留言进行校验，如留言内容超出字符或内容为空，则

20、不能通过校验数据结构与算法调用数据库操作类的函数将信息写入表中。补充说明5.8 回收站模块名称回收站功能描述用户选择回收站功能后，点击进入回收站，点击查询，输入要查找的内容，找到所查找的内容后，此时对此内容有两个操作：一个是还原操作，点击还原，系统自动获取内容删除的原位置，从而把内容还原到原来的位置上，文件由已删除状态转换成未删除状态；另一个功能是删除操作，点击删除，该内容将永久性删除，不会保留在系统内。接口与属性回收站为逻辑删除数据结构与算法调用数据库操作类的函数将信息写入表中。补充说明5.9 通知管理模块名称通知管理功能描述在此模块中主要负责用户对通知的查看和查询，选择查看通知可以使用户查

21、看当前最新通知，系统校验检查是否存在通知，若通知不存在，提示用户通知不存在，并跳转至查看通知的界面；若通知存在，则显示相应通知；选择查询通知，为用户提供三种方式进行查询，第一查看全部通知，第二按通知来源查询，第三按通知日期查询；当用户选择一定的方式查询通知后，系统校验检查是否存在通知，若通知不存在，提示用户通知不存在，并跳转至查询通知的界面；若通知存在，则显示相应通知。接口与属性数据结构与算法调用数据库操作类的函数将信息写入表中。补充说明5.10 通讯录模块名称通讯录功能描述用户新建组，点击新建组，跳转到编辑页面，录入组名信息等相关内容，组名不能为空，不能重复，若组名为空或者重复，提示重新录入

22、，返回编辑页面。新建组成功，可以添加人员，跳转到编辑页面，录入人员信息，人员名不能为空，不能重复，提供确认机制，提示添加成功或者是失败，录入人名为空或者重复，则提示失败，并且返回重新录入，添加成功，可以查询人员，输入人员名，确定后显示人员信息，输入人员名如果不存在，返回重新录入。查询成功，可以进行信息发送。查询成功，还可以删除人员，确定后提示是否要删除该项，删除成功。新建组成功，可以对组进行修改，编辑组名，注意所要修改的组名不能为空，提供确认机制，提示修改成功或者是失败。修改成功，则显示修改后的内容。若修改失败，返回编辑组名页面。新建组成功可以进行组查询，显示有分组情况选择组，确定后，显示该组信息及人员，查询时校验，提供确认机制，如果没有记录，提示没有该记录，返回查询页面，如果有记录，则显示组信息和组内人员。查询成功，可以进行删除组操作， 选择要删除组 ，提供确认机制，校验删除组内是否有人员，有人员，则删除失败，没有人员，删除成功，可以删除多个记录。可以删除人员，选择组确定后，选择删除人员，确定后删除，删除成功。接口与属性数据结构与算法调用数