BBS管理员详细设计说明书.docx
- 文档编号:5760889
- 上传时间:2023-01-01
- 格式:DOCX
- 页数:14
- 大小:48.46KB
BBS管理员详细设计说明书.docx
《BBS管理员详细设计说明书.docx》由会员分享,可在线阅读,更多相关《BBS管理员详细设计说明书.docx(14页珍藏版)》请在冰豆网上搜索。
BBS管理员详细设计说明书
BBS管理员详细设计说明书
变更记录
日期
版本
变更说明
作者
2012-12-21
1.0
初始版本
李赫然
签字确认
系统模块
对应章节
对应部门
负责人签字
目录
1引言4
1.1编写目的4
1.2背景4
1.3基线4
1.4范围4
1.5定义5
1.6参考资料5
1.7术语与缩写解释5
2模块命名规则7
3模块汇总7
3.1模块汇总表7
3.2模块关系图7
4子系统模块设计8
4.1留言管理8
4.1.1屏蔽留言8
4.1.2通知管理9
4.1.3站内留言9
4.1.4客户反馈9
4.2用户管理10
4.2.1基本信息10
4.2.2密码修改10
4.2.3用户管理11
4.3系统管理11
4.3.1类参数管理11
4.3.2子参数管理12
1引言
1.1编写目的
读者范围:
最终用户、软件设计人员本文档作为BBS论坛第一期的需求说明文档,用于与用户确定最终的目标,并成为协议文本的一部分,同时也是本系统设计人员的基础文档。
1.2背景
BBS(BulletinBoardService,公告牌服务)是Internet上的一种电子信息服务系统,它提供一块公共电子白板,每个用户都可以在上面书写,并且可发布信息或提出看法。
大部分BBS由教育机构、研究机构或商业机构管理,象日常生活中的黑板报一样,电子公告牌按不同的主题,分主题分成很多个布告栏。
布告栏的设立的依据是大多数BBS使用者的要求和喜好,使用者可以阅读他人关于某个主题的最新看法,也可以将自己的想法毫无保留地贴到公告栏中。
同样地,别人对你的观点的回应也是很快的。
如果需要独下的交流,也可以将想说的话直接发到某个人的电子信箱中,如果想与正在使用的某个人聊天,可以启动聊天程序加人闲谈者的行列。
虽然谈话的双方素不相识,却可以亲近地交谈。
在BBS里,人们之间的交流打破了空间、时间的限制。
在与别人进行交往时,无须考虑自身的年龄、学历、知识、社会地位、财富、外貌、健康状况,而这些条件往往是人们在其他交流形式中无可回避的。
同样地,也无从知道交谈的对方的真实社会身份。
这样,参与BBS的人可以处于一个平等的位置与其他人进行任何问题的探讨。
这对于现有的所有其他交流方式来说是不可能的。
目前国内的BBS已经十分普遍,可以说是不计其数,其中BBS大致可以分为5类:
(1)校园BBSCERNET建立以来,校园BBS恨快地发展了起来。
目前很多大学都有了BBS,几乎遍及全国上下,像清华大学、北京大学等等都建立了自己的BBS系统。
清华大学的水木清华很受学生和网民们的喜爱。
(2)商业BBS站,这里主要是进行有关商业的商业宣传、产品推荐等等。
目前手机的商业站、电脑的商业站、房地产的商业站比比皆是。
(3)专业BBS站,这里所说的专业BBS主要用于建立地域性的文件传输和信息发布系统。
(4)情感BBS,主要用于交流情感,是许多娱乐网站的首选。
(5)个人BBS,有些个人主页的制作者们在自己的个人主页上建设了BBS,用于接受别人的想法,更有利于与好友进行沟通。
1.3基线
BBS管理员需求分析说明书v1.0
1.4范围
系统包括的范围:
系统包括的范围:
DB数据库的设计、管理员登陆的html界面以及相关的跳转界面。
1.5定义
1.6参考资料
J2EE项目实训Hibernate框架技术(21世纪高等学校实用软件工程教育规划教材)
杨少波 等编著清华大学出版社2008年5月
J2EE项目实训Spring框架技术(21世纪高等学校实用软件工程教育规划教材)
杨少波 等编著清华大学出版社2008年5月
J2EE项目实训UML及设计模式(21世纪高等学校实用软件工程教育规划教材)
杨少波 等编著清华大学出版社2008年5月
J2EE项目实训Struts框架技术(21世纪高等学校实用软件工程教育规划教材)
杨少波 等编著清华大学出版社2008年10月
1.7术语与缩写解释
缩写、术语
解释
JSP
(JavaServerPages)JSP技术使用Java编程语言编写类XML的tags和scriptlets,来封装产生动态网页的处理逻辑。
网页还能通过tags和scriptlets访问存在于服务端的资源的应用逻辑。
JSP将网页逻辑与网页设计和显示分离,支持可重用的基于组件的设计,使基于Web的应用程序的开发变得迅速和容易
Struts
Struts只是一个MVC框架(Framework)用于快速开发JavaWeb应用。
Struts实现的重点在C(Controller),包括ActionServlet/RequestProcessor和我们定制的Action,也为V(View)提供了一系列定制标签(CustomTag)。
但Struts几乎没有涉及M(Model),所以Struts可以采用JAVA实现的任何形式的商业逻辑。
JDBC
JDBC(JavaDataBaseConnectivity,java数据库连接)它是一种用于执行SQL语句的JavaAPI,可以为多种关系数据库提供统一访问,它由一组用Java语言编写的类和接口组成。
JDBC为工具/数据库开发人员提供了一个标准的API,据此可以构建更高级的工具和接口,使数据库开发人员能够用纯JavaAPI编写数据库应用程序。
2命名规则
数据库表、字段命名规则
表名
说明
USER
用户信息表
ADMIN
管理员信息表
AUTHORITY
用户权限表
BOARD
版块信息表
TOPIC
话题信息表
POST
帖子信息表
LINK
友情连接表
数据库表字段名:
序号
项目
前缀
备注
1
用户信息表字段名
USER_
2
管理员信息表字段名
ADMIN_
3
用户权限表字段名
AUTH_
4
版块信息表字段名
BOARD_
5
话题信息表字段名
TOPIC_
6
帖子信息表字段名
POST_
7
友情连接表字段名
LINK_
对象命名规范
序号
项目
前缀
备注
1
按钮
bt_
Button
2
图片按钮
ibt_
ImageButton
3
文本框
tb_
TextBox
4
下拉列表
ddl_
DropDownList
5
单选按钮
rbt_
RadioButton
6
标签
lb_
Label
7
链接按钮
lbt_
LinkButton
8
数据列表
GeidView_
GridView
9
数据源
DataSource_
SqlSataSource
函数命名规则及注释规范
(1)函数命名规则:
获取信息:
Get***
设置信息:
Set***
删除信息:
Delete***
修改信息:
Modify***
更新信息:
Update***
插入信息:
Insert***
(2)注释书写规范:
●函数头部单行注释:
//注释内容
例如:
//更新操作,TableName:
表名,ht:
哈希表,where:
更新条件,例如:
where="whereid=1";
publicboolUpdate(StringTableName,Hashtableht,Stringwhere)
{
returnDBO.Update(TableName,ht,where);
}
●函数头部多行注释:
/*
注释内容
*/
例如:
/*-----------------------------------------------
以下这个函数是获取DtatTable数据集
用法举例:
if(dt.Rows[0][0].ToString()!
=null)
Label1.Text=dt.Rows[0][0].ToString()+dt.Rows[0][1].ToString();
返回DataTable
*/
publicDataTableGetDataTable(StringstrSQL)
{
returnDBO.GetDataTable(strSQL);
}
●程序语句注释:
语句;//注释
例如:
if(dt.Rows.Count==1)//用户名已存在
{
returntrue;//返回真
}
else//当前用户名可用
{
returnfalse;//返回假
}
3模块汇总
3.1模块汇总表
留言管理
模块名称
功能简述
屏蔽留言
管理员可对普通用户留言进行屏蔽和解除屏蔽的操作
通知管理
管理员可发送、查看通知
站内留言
管理员可查看,发送站内留言
客户反馈
管理员可查看并回复客户反馈
用户管理
模块名称
功能简述
基本信息
管理员可查看、修改管理员信息
密码修改
管理员可修改管理员密码
用户管理
管理员可查看、修改普通用户信息
系统管理
模块名称
功能简述
类参数管理
用于进行对类参数的操作
子参数管理
用于进行对子参数的操作
3.2模块关系图
4子系统模块设计
4.1留言管理
4.1.1屏蔽留言
模块名称
屏蔽留言
功能描述
管理员登录BBS留言管理系统后,在管理员业务管理项中有留言管理功能项,其中屏蔽留言功能是指管理员有权限屏蔽用户的留言。
当管理员屏蔽某用户留言时,该留言的屏蔽状态由未屏蔽变为已屏蔽。
反之,当一条留言被解除屏蔽时,屏蔽状态则变为未屏蔽。
接口与属性
数据结构
与算法
调用数据库操作类的函数将信息写入用户表中。
补充说明
4.1.2通知管理
模块名称
通知管理
功能描述
管理员登录BBS留言管理系统,进入通知管理,进入后可以新建通知或者查找已有通知。
在查找通知时,采用模糊查找,只需要输入通知中的部分内容进行检索,如果有符合检索条件的通知则返回给管理员;如果没有查找到所需要的内容则提示管理员没有找到相关通知。
当点击新建通知则系统自动获取用户名,输入通知内容后点击发送,系统将校验留言内容如果输入内容超过150子或为空则提示错误返回修改内容,如果符合要求则发送通知。
接口与属性
用户只需填写回复的内容即可,回复时间、所回复话题的ID、回复人的ID等信息由系统自动写入数据库,回复编号由数据库自动增加。
数据结构
与算法
调用数据库操作类的函数将信息写入用户表中。
补充说明
4.1.3站内留言
模块名称
站内留言
功能描述
功能分析:
1.管理员登录BBS信息系统后,可以新建信息发送给广大用户,在确认发送站内留言时系统校验留言内容是否为空或者超出150字,是则返回重新输入站内留言内容,否则将站内留言发送给所有用户。
2.管理员也可以搜索已经发送给所有用户的留言,并将搜索结果返回给管理员。
接口与属性
1、版块信息以列表形式显示每行,每行均有命令按钮,点击命令按钮即可执行相应地功能,点击翻页按钮可以查看更多信息。
点击修改、添加按钮后需要跳转到其他页面。
数据结构
与算法
采用哈希表保存用户注册信息,调用数据库操作类的函数将信息写入用户表中。
补充说明
4.1.4客户反馈
模块名称
通知管理
功能描述
管理员登录BBS留言管理系统,进入通知管理,进入后可以新建通知或者查找已有通知。
在查找通知时,采用模糊查找,只需要输入通知中的部分内容进行检索,如果有符合检索条件的通知则返回给管理员;如果没有查找到所需要的内容则提示管理员没有找到相关通知。
当点击新建通知则系统自动获取用户名,输入通知内容后点击发送,系统将校验留言内容如果输入内容超过150子或为空则提示错误返回修改内容,如果符合要求则发送通知。
接口与属性
数据结构
与算法
采用哈希表保存用户注册信息,调用数据库操作类的函数将信息写入用户表中。
补充说明
4.2用户管理
4.2.1基本信息
模块名称
基本信息
功能描述
用户登陆BBS登陆界面之后,可以点击基本信息查看自己的基本信息,并可以进行修改用户的基本信息。
基本信息,包括昵称,姓名,性别,E-MAIL,民族,家庭住址,联系电话和QQ号码
接口与属性
数据结构
与算法
采用哈希表保存用户注册信息,调用数据库操作类的函数将信息写入用户表中。
补充说明
4.2.2密码修改
模块名称
密码管理
功能描述
管理员输入旧密码,新密码,确认新密码。
如果旧密码不正确,则重新输入旧密码;如果新密码与确认新密码不一致,则重新输入确认新密码,如果新密码与确认新密码一致,则修改成功
接口与属性
数据结构
与算法
采用哈希表保存用户注册信息,调用数据库操作类的函数将信息写入用户表中。
补充说明
4.2.3用户管理
模块名称
用户管理
功能描述
在该模块中,管理员可以有以下管理功能:
1、管理员可以查看用户的基本信息如果点击查看,则看到用户注册的详细信息2、管理员可以修改用户的密码,如果点击修改密码则用户的密码置为123456,用户的状态不变3、管理员可以查看用户的状态。
点击查看,则看到用户的状态,以及用户的身份。
点击修改权限,则该用户的权限改变,点击上箭头由普通用户升级为管理员,点击下箭头则管理员降为普通用户。
点击屏蔽则用户被屏蔽,点击非屏蔽,则用户变为非屏蔽状态。
接口与属性
数据结构
与算法
采用哈希表保存用户注册信息,调用数据库操作类的函数将信息写入用户表中。
补充说明
4.3系统管理
4.3.1类参数管理
模块名称
类参数管理
功能描述
类参数的操作主要包含:
创建类参,查询类参,修改类参,删除类参。
创建类参:
输入创建类参名,判断创建的类参名是否存在,存在则返回重新创建,不存在则创建成功。
查询类参:
输入所需要查询的类参名,判断查询的类参名是否存在,存在则显示,不存在,则显示提示信息,返回重新查询。
修改类参:
输入所需要修改的类参名,判断修改的类参名是否存在,存在则修改,不存在则返回重新输入类参名。
删除类参:
输入所要删除的类参名,判断类参名是否存在,存在则删除,不存在则返回重新输入类参名。
接口与属性
数据结构
与算法
采用哈希表保存用户注册信息,调用数据库操作类的函数将信息写入用户表中。
补充说明
4.3.2子参数管理
模块名称
子参数管理
功能描述
子类参数的操作主要包含:
创建子类,查询子类,修改子类,删除子类。
创建子类:
输入创建子类名,判断创建的子类名是否存在,存在则返回重新创建,不存在则创建成功。
查询子类:
输入所需要查询的子类名,判断查询的子类名是否存在,存在则显示,不存在,则显示提示信息,返回重新查询。
修改子类:
输入所需要修改的子类名,判断修改的子类名是否存在,存在则修改,不存在则返回重新输入子类名。
删除子类:
输入所要删除的子类名,判断子类名是否存在,存在则删除,不存在则返回重新输入子类名。
接口与属性
新增时检测子参数是否存在
数据结构
与算法
采用哈希表保存用户注册信息,调用数据库操作类的函数将信息写入用户表中。
补充说明
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- BBS 管理员 详细 设计 说明书