详细设计说明书
数据库备份/恢复工具
详细设计说明书
目录
1引言 2
1.1编写目的... 2
1.2背景... 2
1.3定义... 2
1.4参考资料... 2
2程序系统的结构 2
3程序1（标识符）设计说明 2
3.1程序描述... 3
3.2功能... 3
3.3性能... 3
3.4输人项... 3
3.5输出项... 3
3.6算法... 3
3.7流程逻辑... 3
3.8接口... 3
3.9存储分配... 4
3.10注释设计... 4
3.11限制条件... 4
3.12测试计划... 4
3.13尚未解决的问题... 4
4程序2（标识符）设计说明 4
1引言
1.1编写目的
此软件需求说明书编写是为了方便编码人员及测试和项目负责人能够对整个软件的功能有整体的把握以及严格的按照需求分析进行实现，可以使得整个软件的开发过程能够更加有效的实现。通过，软件需求说明书其中对系统的各个功能都作了详细的描述，通过对需求的分析，了解客户的要求，可以保证软件的开发符合客户的需求，以及能够准确及时地完成整个项目的开发。
1.2背景
该数据库备份恢复工具是将系统软件的开发及应用软件开发有机结合成一体，同时强调系统的结构设计及实现，这个系统是基于数据库系统的应用开发，任务由需求方即北京交通大学计算机学院提出，由我方即北京交通大学计算机系学生负责开发实现，通过相应的开发环境从而根据客户的具体的需求而完成项目。通过实现本系统对于计算机系得学生能够了解更多的关于项目开发的具体的流程以及具体的实现方面法，该数据库备份恢复工具是一个很有用的开发工具，对于今后的软件开发有很好的基础，也有相应的应用。
1.3定义
DOM4J：XML的解析规范。
Eclipse：一种软件开发工具
JDBC:
1.4参考资料
《Java 开发实战1200例》
《JDBC文档相关资料》
《SQL Server企业管理器》
《Java语言导学》
2系统运行主体说明
2.1主体分类
本系统中运行主体包括以下内容：客户（系统的主要使用者）。
2.2主体描述
2.2.1用户
2.2.1.1用户定义
客户是所有使用本平台应用的使用者，也可称为用户，是本系统的服务对象。在系统或相关文档中提到的用户，均视同为客户。
2.2.1.2用户分类
客户按照群体进行分类可分为企业客户（包括企业、事件、政府机关等单位）、集团客户（包括家庭用户和由个人组成的非企事业和政府机关的群体）、个人客户。其中企业客户和集团客户可以建立多个子客户，个人客户则为唯一客户。
3程序系统的结构
系统顶级用例图
详细说明：
| 用例编号 |
用例描述 |
| A |
数据库信息浏览 |
| B |
数据对象维护 |
| C |
待添加 |
| D |
待添加 |
Ø 3.1系统整体结构关系图
4系统功能描述
Ø 4.1 数据库备份恢复工具 备份模块详细设计
4.1.1功能描述
此模块主要功能是提供将数据库备份到XML中。
4.1.2详细设计
数据库备份模块部分，由于系统要将数据库中的数据备份到XML中，所以需要设计XML的存储格式：，XML的存储格式如下：
4.1.4性能要求
要求：
l XML格式需要抑郁备份和恢复
l 使用的命令格式需要简洁明确。
Ø 4.2 CDBMS连接数据库模块详细设计
4.2.1功能描述：
数据库备份恢复工具要求能够连接不同的数据库，同时能够对数据库进行相应的处理等功能。因此，此系统要求可以连接大型的数据库如：mysql, sql server等。
4.2.2性能
要求：
l 能够连接两个不同数据库；
l 连接数据库的时间要尽可能的短；
l 对于一些安全性的处理问题，要全面，当数据库连接失败是要有相应的信息的提示。
4.2.3功能实现：
在JDBCUtil.java中实现。
Ø 4.3 XML读写的详细设计
4.3.1功能描述
1．将数据库中导出的数据包装成对象
2．将包装好的对象使用dom4j写入到XML中
4.3.2性能
要求：
l 各项功能实现的操作方便，易用
l 在时间上、空间上的要求比较严格
5 输人项
在输入项部分，主要有命令：格式如下
/*备份命令格式：
* Java –jar db.jar -dbType (SQLServer || mysql) -U(uesrName) -P (password) -dbName (dbname)
dbType:数据库类型：此处可以用字符串”SQLServer”或是”mysql”
U:数据库连接的用户名
P:数据库连接的密码
dbName:需要备份的数据库名称
* 恢复命令格式：
* Java –jar db.jar -dbType (SQLServer || mysql) -U(uesrName) -P (password) -path (filepath)
dbType:数据库类型：此处可以用字符串”SQLServer”或是”mysql”
U:数据库连接的用户名
P:数据库连接的密码
path:需要恢复的数据库相应的XML文件所对应的格式
* */
6输出项
备份：要求输出带有数据库对象和相应数据的XML文件
恢复：数据库中的一个数据库实例
７接口
CDBMS的接口设计不部分，要留有可以增加新功能。
所有的程序放入包：domain
８注释设计
在本系统的实现中要有一些注释的设计，其中主要包括：
a． 加在模块首部的注释；在每个模块实现的部分的首部要有注释，主要内容有程序员名，编程时间，版本号等信息。
b． 加在各分枝点处的注释；各分支处要有详细的记录标识，便于今后修改方便。
c． 对各变量的功能、范围、缺省条件等也要加写相应的注释；
d． 对使用的逻辑所加的注释等等。
9限制条件
由于系统需要与其他的大型数据库一起使用，所以在应用此系统时要求，使用机上要有至少一个数据库可以使用，便于连接。
10测试计划
根据测试的分类，有白盒测试和黑盒测试
白盒测试部分，要求程序员自己进行一些基本功能的测试。
测试人员对系统进行测试，按照需求分析部分的要求，对系统实现的功能进行测试，具体测试包括：
a. 功能测试
b. 性能测试
c. 界面测试
d. 压力测试等
使用junit测试框架。
3.13尚未解决的问题
在此详细设计中对各个模块的类的部分设计没有涉及，会在后面的实现中逐渐完善。