详细设计文档

外语培训机构数据库详细设计文档东北师范大学雷蕾 张丽云 丁鼎 孔祥楠目录第一章 引言 11.1 项目说明 11.2 文档目的 11.3 参考资料 1第二章 设计流程图 32.1 注册功能流程图 32.2 用户登录功能流程图 42.3 搜索课程功能流程图 52.3 前台用户下载资料或留言功能流程图 52.3 后台管理员功能流程图 6第三章 类规格说明 72.1 模块类图 73.2 jsp 页面说明 83.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()tDoctor第三章 类规格说明+ insert()bool+update()bool+delete()bool+select()String+update()bool+delect()booll+select()String 1AdminDaoimpln 口/+ insert() +delete() +update():bool :bool:bool+ se lect()S4in g厂1yschoolUser-UserID : String -UserName : String -UserPassword : String -UserAddress : String -UserSex : String -UserCity : String -UserTelephone : String -UserEmail : StringAddtime : 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() : DateDBconnection-DbDriver-URL-User-Pwd-conn-statement-rs-propFileName prop+DBConnection() + loadproperty() +getDbConn()+getStatement()UserDao+ insert() : bool +update() : bool+ select():String-DBconn+ insert():bool+update():bool+ select():String 1DoctorDaose tAddTim e()3.2 jsp 页面说明3.2.1 登录页面JSP页面说明页面名称userlog in .jsp功能简述用户登录表单定义编号表单成员说明Action URL说明1（1）in put:text UserID（2）in put:text USERpassword（3）in put:text Useryz（4）html:submit（5）html:resetUser提交登录信息到URL：User进行处理页面外观用户登录，诸先输入用户名和密码用户名:窖码；验证码：O爹剥9登录I 注册新用尸返回主页（用户登录页面）3.2.2 修改用户信息界面3.3 类说明3.3.1Admin 类类名称Admin所属包Doctor名称|类功能描述封装管理员的请求信息| 类静态变量定义|名称| 类型|描述无无无类变量定义(先 public-protected-private)| 名称| 类型| 描述UserIDStringprivateUserNameStringprivateUserPasswordStringprivateAddTimeDateprivate方法(先 public-protected-private)方法声明参数说明返回值说明方法简单 描述public Admin()无无返回值无public String getAdminID()无参数返回String类型返回管理员IDPublic voidsetAdminID(String adminid)adminid：管理员 ID无返回值设置管理员IDpublic String getAdminName()无参数返回String类型返回管理员 姓名public void setAdminName(String nickname)nickname： 用户名无返回值设置管理员IDpublic String getAdminPassword()无参数返回String类型返回管理员 密码public voidsetAdminPassword(String password)password :密码无返回值设置管理员 密码public Date getAddTime()无参数返回Date类型返回时间public void setAddTime(Date date)data :时间无返回值设置时间3.3.2 AdminDao 类类名称AdminDao所属包DoctorDao名称类功能描述处理管理员的请求信息类静态变量定义名称类型| 描述无无无类变量定义(先 public-protected-private)名称类型| 描述无无无方法(先 public-protected-private)方法声明参数说明返回值说明方法简单描述public boolean insert(Admin admin)admin管理员boolean增加管理员信息是 否成功public boolean update(Admin admin)admin管理员boolean修改管理员信息是 否成功public boolean delete(Admin admin)admin管理员boolean删除管理员信息是 否成功public ResultSet select(Admin admin)admin管理员ResultSet返回查询管理员的 信息public boolean update(User user)user：用户boolean修改用户信息是否 成功public boolean delete(User user)user：用户boolean删除用户信息是否 成功public ResultSet select(User user)user：用户ResultSet返回查询用户的信 息3.3.3 AdminDaoImpl 类类名称AdminDaoImpl所属 包名 称DoctorDao类功能描述实现管理员的请求| 类静态变量定义名称类型描述无无无类变量定义(先 public-protected-private)名称类型描述private DBConnectionDBconnDBConnectionprivate方法(先 public-protected-private)|方法声明参数说明|返回值说明| 方法简单描述public boolean insert(Admin admin)admin： 管理员 信息boolean管理员增添信息public boolean update(User user)user：用户信息boolean修改用户信息Public ResultSet select(User user)user：用户信息ResultSet查看用户信息public boolean delete(Admin admin)admin： 管理员 信息boolean删除管理员信息public boolean update(Admin admin)user :管理员信 息boolean管理员修改信息Public ResultSet select(Admin admin)admin： 管理员 信息ResultSet管理员查看信息public boolean delete(User user)user：用户信息boolean删除用户信息3.3.4 User 类类名称User所属包 名称Doctor| 类功能描述封装用户的请求信息| 类静态变量定义| 名称类型 | 描述无无无类变量定义(先 public-protected-private)| 名称类型 | 描述UserIDStringprivateUserNameStringprivateUserPasswordStringprivateUserAddressStringprivateUserEmailStringprivateUserTelephoneStringprivateUserCityStringprivateUserSexStringprivateAddTimeDateprivate方法(先 public-protected-private)方法声明参数说明返回值说明方法简单 描述public void setUserName(String nickname)nickname：姓名无返回值设置姓名public String getUserName()无参数返回String类型返回姓名public void setUserID(String userid)userid：用户 id无返回值设置用户名public String getUserID ()无参数返回String类型返回用户名public void setUserPassword(String password)password :密码无返回值设置密码public String getUserPassword ()无参数返回String类型返回密码public void set UserAddress (String address)address：用户角色 类型无返回值设置用户地 址public String get UserAddress ()无参数返回String类型返回用户地 址public void set UserEmail (String email)email邮箱地址无返回值设置用户邮 箱地址public String getUserEmail()无参数返回String类型返回邮箱地 址public void set UserTelephone (String telephone)telephone :电话号码无返回值设置用户电 话号码public String getUserTelephone()无参数返回String类型设置电话public void set UserSex (String sex)sex :性别无返回值返回用户性 别public String get UserSex()无参数返回String类型设置电话public void set UserCity (String cty)city:城市无返回值返回用户城 市public String get UserCity()无参数返回String类型设置城市public void set AddTime(String time)time :时间无返回值返回时间public String get AddTime()无参数返回Date类型设置时间3.3.5 UserDao 类类名称UserDao所属包DoctorDao名称|类功能描述处理用户的请求信息| 类静态变量定义|名称| 类型| 描述无无无类变量定义(先 public-protected-private)|名称| 类型| 描述无无无方法(先 public-protected-private)方法声明参数说明返回值说明方法简单 描述public boolean insert(User user)user：用户信息boolean用户是否 注册public boolean update(User user)user:用户信息boolean是否修改 用户public ResultSet select(User user)user:用户信息ResultSet是否查看用户信息3.3.6 UserDaoImpl 类类名称UserDaolmpl所属包DoctorDao名称|类功能描述实现用户的请求| 类静态变量定义| 名称| 类型| 描述无无无类变量定义(先 public-protected-private)| 名称| 类型| 描述private DBConnection DBconnDBConnectionprivate方法(先 public-protected-private)方法声明参数说明返回值说明方法简单 描述public boolean insert(User user)user：用户信息boolean用户注册public boolean update(User user)user：用户信息boolean用户修改 信息publicResultSet select(User user)user：用户信息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 注释设计实现注释的格式(I mplementation Comment Formats)程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和 行末(end-of-line)。4.4.1 块注释(Block Comments)块注释通常用于提供对文件、方法、数据结构和算法的描述。块注释被置于每个 文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功 能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：/* Here is a block comment.*/块注释可以以/*-开头，这样indent(l)就可以将之识别为一个代码块的开始，而不会重排它。/*-* Here is a block comment with some very special* formatting that I want indent(l) 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;/