详细设计文档 (含系统说明书,源代码说明书)

东北师范大学

外语培训机构数据库详细设计文档

雷蕾 张丽云 丁鼎 孔祥楠

2009-11-1

目录

第一章

引言 .................................................................. 1

1.1项目说明 .................................................................. 1

1.2文档目的 .................................................................. 1

1.3参考资料 .................................................................. 1

第二章

设计流程图 ............................................................ 3

2.1注册功能流程图 ............................................................ 3

2.2用户登录功能流程图 ........................................................ 4

2.3搜索课程功能流程图 ........................................................ 5

2.3前台用户下载资料或留言功能流程图 .......................................... 5

2.3后台管理员功能流程图 ...................................................... 6

第三章

类规格说明 ............................................................ 7

2.1模块类图 .................................................................. 7

3.2 jsp页面说明 .............................................................. 8

3.3类说明 ................................................................... 10

第四章

程序设计说明 ......................................................... 15

第一章 引言

1.1项目说明

1、在互联网络高速发展的今天，网站是企业在因特网上全面介绍公司信息的一个发布平台：可以把任何想让人们知道的东西放入网站，如公司简介、公司的厂房、生产设施、研究机构、产品的外观、功能及其使用方法等，都可以展示于网上。

2、 网站树立培训机构形象，让别人看到自己，展示培训机构的实力。培训机构就能够在国内和世界"亮相"，无疑是一种宣传机构、产品和服务的机会。从广告意义上看，培训机构网站事关机构形象建设，没有网站也谈不上机构形象。

3、主动抢占先机，培训机构建设自己的网站，这是时代发展的必然，任何一家培训机构要想跟上时代发展的潮流，必须要有展示自己的一个信息平台。为了不被竞争对手建立网站抢占先机，为了不落后于时代潮流，应该考虑建站的必要性。

4、可以扩大业务范围，可以与潜在客户建立商业联系：这是该网址最重要的功能之一，也是为什么那么多的国外企业非常重视网站建设的根本原因。现在，世界各国大的采购商主要都是利用互联网络来寻找新的产品和新的供应商，因为这样做费用最低，效率最高。原则上，全世界任何地方的人，只要知道了公司的网址，就可以看到公司的产品。因此，关键在于如何将公司网址推介出去。一种非常实用而有效的方法是将公司的网址登记在全球著名的搜索引擎（如Google，百度，雅虎等）上，并选择与公司的产品及服务有关的关键字，则可以使潜在的客户能够容易地找到公司和产品。这正是国际商业上通行的做法，而且被实践证明是十分有效的。

5、给广大热爱外语，渴望了解外语信息的群体提供一个方便快捷的平台。

1.2文档目的

该文档的阅读群体是该项目组的全部成员，为了让所有成员能对本网站的数据库构成，数据流向有个深刻的了解，方便在以后的编程中合理运用。

1.3参考资料

数据库原理及应用教程 2版

北京人民邮电出版社

著者：陈志泊 王春玲

数据库原理与应用

北京 清华大学出版社

著者：狄文辉 宋真君 白劲波

面向对象技术与工具

北京 电子工业出版社

陈文宇 白忠建 白忠建

软件工程

北京 清华大学出版社

李代平

软件需求工程

北京 科学出版社

刘璘 金英 金芝

UML系统建模与分析设计课程设计

北京 机械工业出版社

刁成嘉 刁奕

UML及建模

北京 清华大学出版社 北京交通大学出版社

郭宁

数据库技术与应用

北京 清华大学出版社

王珊

网络资源：

第二章 设计流程图

2.1注册功能流程图

注册入口

是

必选项为空

否

用户名有效？

是

2次输入密码是否否

密码长度符合要求

是

E－mail地址有是

其他信息有效？

是

注册成功

否

否

否

否

是

否

2.2用户登录功能流程图

登录入口

否

查询用户是否存在

是

核对密码是否正确

是

取得用户名和密码

否

将UserID存入session中

登录成功

2.3搜索课程功能流程图

开始搜索

是

输入条件

搜索结果

查看课程

否

继续搜咨询

报名

2.3前台用户下载资料或留言功能流程图

浏览网页

下载或留言

未注册用户

已登录注册用未登录注册用注册

登录

可下载或留言

2.3后台管理员功能流程图

管理员登录入口

否

查询用户是否存在

是

核对密码和验证码是否正确

是

登录成功

否

对信息进行增删改

退出系统

第三章 类规格说明

2.1模块类图

Admin-AdminID : String-AdminName : String-AdminPassword : String-AddTime : Date+Admin()+getAdminID() : String+setAdminID()+getAdminName() : String+setAdminName()+getAdminPassword() : String+setAdminPassword()+getAddTime() : Date+setAddTime()AdminDaoAdminDaoimpl+insert() : bool+update() : bool+delete() : bool+select() : String+update() : bool+delect() : bool+select() : String-DBconn+insert() : bool+delete() : bool+update() : bool+select() : StringDBconnection-DbDriver-URL-User-Pwd-conn-statement-rs-propFileName-prop+DBConnection()+loadproperty()+getDbConn()+getStatement()+close() : boolUser-UserID : String-UserName : String-UserPassword : String-UserAddress : String-UserSex : String-UserCity : String-UserTelephone : String-UserEmail : String-Addtime : Date+User()+getUserID() : String+setUserID()+getUserName() : String+setUserName()+getUserPassword() : String+setUserPassword()+getUserSex() : String+setUserSex()+getUserCity() : String+setUserCity()+getUserAddress() : String+setUserAddress()+getUserTelephone() : String+setUserTelephone()+getUserEmail() : String+setUserEmail()+getAddTime() : Date+setAddTime()schoolUserDao+insert() : bool+update() : bool+select() : StringUserDaoImpl-DBconn+insert() : bool+update() : bool+select() : StringDoctorDoctorDBDoctorDao

3.2 jsp页面说明

3.2.1 登录页面

JSP页面说明

页面名称

功能简述

表单定义

编号

1

表单成员说明

（1） input:text UserID

（2） input:text

USERpassword

（3） input:text Useryz

（4） html:submit

（5） html:reset

页面外观

Action URL

User

说明

提交登录信息到URL：

User进行处理

用户登录

（用户登录页面）

3.2.2修改用户信息界面

JSP页面说明

页面名称

功能简述

表单定义

编号

1 1、input:text UserID

2、input:text UserName

3、input:text

UserPassword

3、input:text UserQestion

3、input:text UserAnswer

3、input:text UserSex

3、input:text UserEmail

3、input:textarea

SignNamel

4、html:submit

5、html:reset

页面外观

User 提交修改用户信息到URL：User进行处理

表单成员说明 Action URL 说明

修改用户信息

3.3类说明

3.3.1Admin类

类名称

类功能描述

封装管理员的请求信息

类静态变量定义

名称

Admin 所属包名称

Doctor

类型

无

无

类变量定义(先public->protected->private)

名称 类型

UserID

String

UserName

String

UserPassword

String

AddTime Date

描述

无

描述

private

private

private

private

返回值说明 方法简单描述

无返回值 无

返回String类型 返回管理员ID

无返回值 设置管理员ID

返回String类型 返回管理员姓名

无返回值 设置管理员ID

返回String类型 返回管理员密码

无返回值 设置管理员密码

返回Date类型

无返回值

返回时间

设置时间

方法(先public->protected->private)

方法声明 参数说明

public Admin()

public String getAdminID()

Public voidsetAdminID(String

adminid)

public String getAdminName()

public void setAdminName(String

nickname)

public String

getAdminPassword()

public void

setAdminPassword(String

password)

public Date getAddTime()

public void setAddTime(Date

date)

无

无参数

adminid：管理员ID

无参数

nickname：用户名

无参数

password：密码

无参数

data:时间

3.3.2 AdminDao类

类名称 AdminDao 所属包名称

DoctorDao

类型

无

无

类变量定义(先public->protected->private)

名称 类型

无

无

方法(先public->protected->private)

方法声明 参数说明

public boolean admin 管理员

insert(Admin admin)

public boolean admin 管理员

update(Admin admin)

public boolean admin 管理员

delete(Admin admin)

public ResultSet admin 管理员

select(Admin admin)

public boolean user：用户

update(User user)

public boolean user：用户

delete(User user)

public ResultSet user：用户

select(User user)

类功能描述

处理管理员的请求信息

类静态变量定义

名称 描述

无

描述

无

返回值说明

boolean

boolean

boolean

ResultSet

boolean

boolean

ResultSet

方法简单描述

增加管理员信息是否成功

修改管理员信息是否成功

删除管理员信息是否成功

返回查询管理员的信息

修改用户信息是否成功

删除用户信息是否成功

返回查询用户的信息

3.3.3 AdminDaoImpl类

类名称 AdminDaoImpl 所属包名称

DoctorDao

类功能描述

实现管理员的请求

类静态变量定义

名称 类型 描述

无

无

类型

DBConnection

无

描述

private

类变量定义(先public->protected->private)

名称

private DBConnection

DBconn

方法(先public->protected->private)

方法声明 参数说明

public boolean admin：管理员insert(Admin admin) 信息

public boolean user：用户信息

update(User user)

Public ResultSet user：用户信息

select(User user)

public boolean admin：管理员delete(Admin admin) 信息

public boolean user：管理员信update(Admin admin) 息

Public ResultSet admin：管理员select(Admin admin) 信息

public boolean user：用户信息

delete(User user)

3.3.4 User类

类名称 User

类功能描述

封装用户的请求信息

类静态变量定义

名称

返回值说明

boolean

boolean

ResultSet

boolean

boolean

ResultSet

boolean

方法简单描述

管理员增添信息

修改用户信息

查看用户信息

删除管理员信息

管理员修改信息

管理员查看信息

删除用户信息

所属包名称

Doctor

类型

无

无

类变量定义(先public->protected->private)

名称 类型

UserID

String

UserName

String

UserPassword

String

UserAddress

String

描述

无

描述

private

private

private

private

UserEmail

UserTelephone

UserCity

UserSex

AddTime

String

String

String

String

Date

private

private

private

private

private

返回值说明

无返回值

方法简单描述

设置姓名

方法(先public->protected->private)

方法声明 参数说明

public void

setUserName(String

nickname)

public String

getUserName()

public void

setUserID(String userid)

public String getUserID ()

public void

setUserPassword(String

password)

public String

getUserPassword ()

public void set UserAddress

(String address)

public String get

UserAddress ()

public void set UserEmail

(String email)

public String get

UserEmail()

public void set

UserTelephone (String

telephone)

public String get

UserTelephone()

public void set UserSex

(String sex)

public String get UserSex()

public void set UserCity

(String cty)

public String get

UserCity()

public void set

AddTime(String time)

nickname：姓名

无参数

userid：用户id

无参数

password：密码

返回String类型 返回姓名

无返回值 设置用户名

返回String类型 返回用户名

无返回值 设置密码

无参数 返回String类型 返回密码

address：用户角色无返回值 设置用户地类型 址

无参数 返回String类型 返回用户地址

email邮箱地址 无返回值 设置用户邮箱地址

无参数 返回String类型 返回邮箱地址

telephone:电话号无返回值 设置用户电码 话号码

无参数

sex:性别

无参数

city:城市

无参数

time:时间

返回String类型 设置电话

无返回值 返回用户性别

返回String类型 设置电话

无返回值 返回用户城市

返回String类型 设置城市

无返回值 返回时间

public String get AddTime()

无参数

3.3.5 UserDao类

类名称 UserDao

类功能描述

处理用户的请求信息

类静态变量定义

名称

返回Date类型 设置时间

所属包名称

DoctorDao

类型

无

无

类变量定义(先public->protected->private)

名称 类型

无

无

方法(先public->protected->private)

方法声明 参数说明

public boolean user：用户信息

insert(User user)

public boolean user:用户信息

update(User user)

public ResultSet user:用户信息

select(User user)

3.3.6 UserDaoImpl类

类名称 UserDaoImpl

类功能描述

实现用户的请求

类静态变量定义

名称

描述

无

描述

无

返回值说明

boolean

boolean

ResultSet

方法简单描述

用户是否注册

是否修改用户

是否查看用户信息

所属包名称

DoctorDao

类型

无

无

类变量定义(先public->protected->private)

名称 类型

private DBConnection DBconn DBConnection

描述

无

描述

private

方法(先public->protected->private)

方法声明 参数说明

public boolean

insert(User user)

user：用户信息

返回值说明

boolean

方法简单描述

用户注册

public boolean

update(User user)

publicResultSet

select(User user)

user：用户信息

user：用户信息

boolean

boolean

用户修改信息

用户查看信息

第四章 程序设计说明

4.1程序描述

本系统的程序可以分为两个大类，一类是类程序，一类是jsp程序。

以下表格可以充分说明这些程序各自的特点和设计目的：

表格 4.1-1程序描述

程序类别

设计目的

类程序

体现面向对象的思想，方便方法的重用

常驻内存吗？ 否

是子程序吗？ 是

是可重人吗？ 是

有覆盖要求有

吗？

程序处理方式 顺序执行

Jsp程序

实现界面的正常显示

否

是

否

否

并发处理

4.2功能

（1）、首页设计

首页设计应该清晰简单、美观大方，同时还要做到信息充足，突出网站的特点和操作的入口。

（2）、信息管理

只有的登录后的用户可以修改自己的信息以及发布在网站上的一切信息。

本站管理员登录后可以对自己的信息进行更新操作，以及对用户信息进行增加，删除，修改操作；并且可发布新闻以及上传文件等操作。

本站不能因为商业目的向外界公开，个人信息完全由个人来控制其内容，程序应提供个人信息维护的页面。

（3）、信息浏览

根据网站的不同页面，用户可以浏览到相关分类信息。另外可以通过本网站提供的站内搜索搜到自己想要的信息。

（4）、安全管理

安全方面的管理，防止恶意攻击、非法入侵和对数据的篡改。

4.3性能

4.3.1精度

1、个人信息：注册用户名不能超过12个字符（6个汉字）；密码区分大小写，只能使用大小写字母和数字的组合；邮件地址必须有效；验证码必须正确。

2、各分类信息：

考试的许愿墙中每条记录不超过30个字符；

博客中的留言板可以是任意字符。

3、用户选择或者输入数据，进行信息查询，应不区分大小写；

4、用户选择或者输入数据，进行信息查询，应执行不完全匹配的模糊查询；

3.3.2时间特性要求

1、用户登录请求、个人信息填写完毕后的提交、个人信息更改、删除的操作，响应时间应该在2s之内——用户不应感到系统有延迟的时间；

2、用户执行信息查询，返回记录在100行之内的，响应时间应不超过2s，超过20行记录的情况，应该进行分页显示，每页显示10-30行（具体由设计人员来设定）结果信息；

3.3.3灵活性

A、操作方式

程序在通常的应用环境下使用鼠标和键盘进行输入操作，对于执行按钮，通常使用鼠标的点击完成，但是，IE页面要求全部支持键盘的定位操作（在不安装鼠标的计算机上，也能够使用该网站）。

B、运行环境

程序在通常的条件下，在Win98/NT/2000/XP/7及vista,后续的MS的操作系统上，

只要已经安装了IE6.0或者后续版本或者是IE内核的其他版本浏览器，都能够浏览所公布的页面、执行对应的操作。

页面服务器的环境应安装tomcat，正常启动Web服务，数据库服务器及详细的配置和安装参考以下硬件和软件的支持。

4.4 注释设计

实现注释的格式(Implementation Comment Formats)

程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line)。

4.4.1块注释(Block Comments)

块注释通常用于提供对文件、方法、数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。

块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：

/*

* Here is a block comment.

*/

块注释可以以/*-开头，这样indent(1)就可以将之识别为一个代码块的开始，而不会重排它。

/*-

* Here is a block comment with some very special

* formatting that I want indent(1) to ignore.

*

* one

* two

* three

*/

4.4.2单行注释(Single-Line Comments)

短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释。单行注释之前应该有一个空行。以下是一个Java代码中单行注释的例子：

if (condition) {

/* Handle the condition. */

...

}

4.4.3尾端注释(Trailing Comments)

极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该具有相同的缩进。

以下是一个Java代码中尾端注释的例子：

if (a == 2) {

return TRUE; /* special case */

} else {

return isPrime(a); /* works only for odd a */

}

4.4.4行末注释(End-Of-Line Comments)

注释界定符"//"，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；然而，它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子：

if (foo > 1) {

// Do a double-flip.

...

}

else {

return false; // Explain why here.

}

//if (bar > 1) {

//

// // Do a triple-flip.

// ...

//}

//else {

// return false;

//}