概要设计说明书范例及模板

-*概要设计说明书张三、李四、王五1 引言11 编写目的在本机票预定系统项目的前一阶段，也就是需求分析阶段中，已经将系统用户对本系统的需求做了详细的阐述，这些用户需求已经在上一阶段中对航空公司、各旅行社及机场的实地调研中获得，并在需求规格说明书中得到详尽得叙述及阐明。本阶段已在系统的需求分析的基础上，对机票预定系统做概要设计。主要解决了实现该系统需求的程序模块设计问题。包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息，以及数据结构、模块结构的设计等。在以下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。在下一阶段的详细设计中，程序设计员可参考此概要设计报告，在概要设计对机票预定系统所做的模块结构设计的基础上，对系统进行详细设计。在以后的软件测试以及软件维护阶段也可参考此说明书，以便于了解在概要设计过程中所完成的各模块设计结构，或在修改时找出在本阶段设计的不足或错误。12 项目背景机票预定系统将由两部分组成：置于个旅行社定票点的前台客户程序，以及置于航空公司的数据库服务器。本系统与其他系统的关系如下：客户程序（旅行社） :机场飞机起飞管理:网（航空公司）飞机起飞数据客户程序服 务 器 及 程 序客户程序客户程序络13 定义131 专门术语SQL SERVER: 系统服务器所使用的数据库管理系统（DBMS）。SQL: 一种用于访问查询数据库的语言事务流：数据进入模块后可能有多种路径进行处理。主键：数据库表中的关键域。值互不相同。外部主键：数据库表中与其他表主键关联的域。ROLLBACK: 数据库的错误恢复机制。132 缩写.z.-系统：若未特别指出，统指本机票预定系统。SQL: Structured Query Language（结构化查询语言）。ATM: Asynchronous Transfer Mode (异步传输模式)。14 参考资料以下列出在概要设计过程中所使用到的有关资料：1 机票预定系统项目计划任务书浙江航空公司1999/32 机票预定系统项目开发计划*软件开发小组1999/33 需求规格说明书 *软件开发小组1999/34 用户操作手册（初稿）*软件开发小组 1999/45 软件工程及其应用周苏、王文等天津科学技术出版社 1992/16 软件工程张海藩清华大学出版社1990/117 Computer NetworkA.S.TanenbaunPrentice Hall1996/01文档所采用的标准是参照软件工程导论沈美明著 的“计算机软件开发文档编写指南”。2 任务概述21 目标22 运行环境系统将由两部分程序组成，安装在各旅行社客户机上的客户程序及航空公司内的数据服务器程序。根据调研得知所有旅行社的计算机配置均在 Pentium 133 级别以上，客户程序应能够在 Pentium 133 级别以上, Win NT 环境下运行。23 需求概述浙江航空公司为方便旅客，需开发一个机票预定系统。为便于旅客由旅行社代替航空公司负责为旅客定票，旅行社把预定机票的旅客信息，包括姓名、性别、工作单位、身份证号码、旅行时间、旅行目的地，输入机票预定系统的客户端程序，系统经过查询航空公司内的航班数据服务器后，为旅客安排航班，印出取票通知。旅客在飞机起飞前一天凭取票通知和帐单交款后取票，系统校对无误后即印出机票给旅客。要求系统能有效、快速、安全、可靠和无误的完成上述操作。并要求客户机的界面要简单明了，易于操作，服务器程序利于维护。24 条件与限制3 总体设计31 处理流程下面将使用（结构化设计）面向数据流的方法对机票预定系统的处理流程进行分析。系统可分为两大部分：一、客户机上的程序，二、服务器上的程序。以下将分别对系统的这两大部分进行流程分析：311 客户机程序流程.z.-客户机上的输入信息为旅客资料或帐单号，还包括一个定票/领票选项。输出为打印帐单或机票，和确认或出错信息。其内部处理流程如下：旅客资料234经网络送服定票/取票17务器程序8帐单号56打印帐单1312输出确定预定信息1114服务器经网络送来回答输出错误原因910151617输出确定预定信息181419打印机票下面对各模块（以数字表示）进行功能说明：201 读入并确定（定票/领票） 它是一个事务处理中心，若输入是定票时转入 2 ，输出则转入 5。2 读入旅客资料 读取所输入的旅客资料，并将其格式化，将格式化数据送 3。3 检验输入资料 检验格式化输入资料，初步检查输入是否有误，它是一个事务处理中心，有误则转 2 再次读入，检查无误则将数据送 4。4 准备服务器数据 由格式化旅客资料准备需发送到服务器的数据，将准备好的数据送 7。5 读入帐单号 读取所输入的帐单号，并将其格式化，将格式化数据送 6。6 准备服务器数据 由格式化帐单号准备需发送到服务器的数据，不同于 4，它将准备的是帐单号，将准备好的数据送 7。7 准备网络数据包 将数据准备/加密成网络传输数据包。8 网络数据发送 将数据包经网络发送到服务器程序， 它是程序与网络的接口。9 网络数据接受 接受由服务器程序经网络传送到客户机的数据包， 它是程序与网络的接口。10 解开/判断 解开 9 所接受的数据包，并判断数据是定票数据或是领票数据，它是一事务处理中心，是定票则将数据送 11，是领票则将数据送 18。11定票成功. 由数据判断定票是否成功，它是一事务处理中心，若定票成功则将数据送 11，不成功则将数据送 18。12准备输出数据 由接收的服务器数据准备输出数据，其中关于帐单的数据将送入 13，其他包括旅客资料等送入 14。13打印帐单 由帐单信息处理帐单格式并打印出帐单。14输出定位确定 在屏幕上显示确定定位及其他信息。15判断错误 由数据判断出错误类型，将类型送到 16。16准备错误语句 由具体错误类型准备错误语句，送 17。17输出错误语句 在屏幕上显示错误语句。18领票核对成功. 由数据判断领票核对是否成功，它是一事务处理中心，若成功则将数据送 19，不成功则将数据送 15。.z.-19准备机票输出数据 由接收的服务器数据准备将打印的机票数据数，据其中关于帐单的机票的数据将送入 20，其他包括旅客资料等送入 14。20打印机票 由机票信息处理机票格式并打印出机票。312 服务器程序流程7客户机经456客户机经网络送来网络送来89的数据的数据123SQL SERVER1617来自客户机(班机，票务数据库)送客户机13101112下面对各模块（以数字表示）进行功能说明：14151 网络数据接收 接受由客户机程序经网络传送到客户机的数据包， 它是程序与网络的接口。2 解开数据 解开/解密打包的数据，并将恢复的数据格式化送入 3。3 判断操作 由数据判断需要做什么数据库操作，它是一事务处理中心，若为定票操作则将数据送 4，若为领票操作则将数据送 15。4 准备数据库查询语句 由定票数据准备访问 SQL SERVER 数据库所需的 SQL 语句，送入 5。5 数据库操作 运行 SQL 语句，查询并存入数据库，获得相应的定票数据，将数据送入 6。它需包括初步对查询的判断。它必须为乘客安排可抵达目的地的有座位的航班。6 判断查询是否成功 利用查询所得的数据判断定票是否成功，它是一事务处理中心，若为定票操作成功则将数据送 7，若不成功则将数据送 8。7 准备回送数据 准备定票成功后需回送客户机程序的数据，送 16。8 确定原因 由查询数据判断定票不成功的原因，送 9。9 准备回送数据 根据不成功的原因，准备需送回客户机程序的数据，送入 16。10准备数据库查询语句 由领票数据准备访问 SQL SERVER 数据库所需的 SQL语句，送入 11。11数据库操作 运行 SQL 语句，查询并存入数据库获得相应的领票数据，将数据送入 6。它需包括初步对查询的判断。12判断查询是否成功 利用查询所得的数据判断领票是否成功，它是一事务处理中心，若为领票操作得到确认则将数据送 11，若不成功则将数据送 8。13准备回送数据 准备领票确认后需回送客户机程序的数据，送 16。14确定原因 由查询数据判断领票不能确认的原因，送 15。15准备回送数据 根据不成功的原因，准备需送回客户机程序的数据，送入 16。16准备网络数据包 将数据准备/加密成网络传输数据包。17网络数据发送 将数据包经网络发送到服务器程序， 它是程序与网络的接口。以上显示的各模块数字相同的为同一模块；由于事务流处理上的便利，将有些功能模块，拆分到各事务流中。32 总体结构和模块外部设计.z.-下面以结构图来描述机票预定系统的软件总体结构。框内注明了模块的名字；方框之间的直线表示模块的调用关系。321 客户机部分机票预定系统（客户机程序）接收输入数据联络服务器输出数据准备定票发送数据准备确认发送数准备网络数据包解开网络数据包确认操作类型检验输入发送数据接收数据定票成功.领票成功.读入旅客资料读入帐单号判断错误类型确定（定票/领票）准备输出准备错误信息准备输出旅客资定票/领帐单号打印帐单显示确认显示错误料票打印机票确认显示帐单机票322 服务器程序部分机票预定系统（服务器部分）接收数据数据处理、查询发送数据判断类型准备 SQL判断查询解开数据包数据库操作判断原因准备数据包接收客户机数据准备返回数据准备返回数据发送数据到客户机其中在数据处理、查询下作了省略只给出了一部分模块，实际上是有两部分，分别对应于定位及确认。3.3 功能分配各项模块的功能可参照 3.1 中的说明。客户机程序主要有三大块：接收数据、网络通信及输出部分。服务器程序主要也是由三大功能：接收网络数据、数据库操作及发送网络数据部分。服务器程序需与已建立的 SQL SERVER 数据库互连，其接口将于下面部分阐述。4 接口设计41 外部接口411 用户界面在用户界面部分，根据需求分析的结果，用户需要一个用户友善界面。在界面设计上，应做到简单明了，易于操作，并且要注意到界面的布局，应突出的显示重要以及出错信息。外观上也要做到合理化，考虑到用户多对 WINDOW 风格较熟悉，应尽量向这一方向靠拢。在设计语言上，已决定使用 MS VISUAL C+ 进行编程，在界面上可使用 VISUAL C+ 所提供的可视化组件，向 WINDOWS 风格靠近。 其中服务器程序界面要做到操作简单，易于管理。在设计上采用下拉式菜单方式，在出错显示上可调用 VISUAL C+ 库中的错误提示函数。总的来说，系统的用户界面应作到可靠性、简单性、易学习和使用412 软件接口服务器程序可使用 VISUAL C+ 提供的对 SQL SERVER 的接口，进行对数据库.z.-的所有访问。服务器程序上可使用 SQL SERVER 的对数据库的备分命令，以做到对数据的保存。在网络软件接口方面，使用一种无差错的传输协议，采用滑动窗口方式对数据进行网络传输及接收。413 硬件接口在输入方面，对于键盘、鼠标的输入，可用 VISUAL C+的标准输入/输出，对输入进行处理。在输出方面，打印机的连接及使用，也可用 VISUAL C+的标准输入/输出对其进行处理。在网络传输部分，在网络硬件部分，为了实现高速传输，将使用高速 ATM。42 内部接口内部接口方面，各模块之间采用函数调用、参数传递、返回值的方式进行信息传递。具体参数的结构将在下面数据结构设计的内容中说明。接口传递的信息将是以数据结构封装了的数据，以参数传递或返回值的形式在各模块间传输。5 数据结构设计51 数据库数据结构设计DBMS 的使用上系统将采用 SQL SERVER, 系统主要需要维护 3 张数据表：1 航班班次表起飞日期/时航班号飞行目的地座位空数商务仓票价经济仓票价间航班班次表保存了所有从本地起飞的班机信息，它的主键为航班号。在定位前先查寻座位空数，在定位后将修改座位空数。2 定位信息表航班号帐单号是否领票定位信息表保存了已定位信息，主键为帐单号，外部主键为航班号。在旅客领票过程时将用到此表，领票后修改是否领票域3 帐单信息/旅客资料表帐单号旅客姓名旅客性别旅客身份证号工作单位帐单信息/旅客资料表保存已定位的旅客信息资料，它的主键为旅客身份证号，外部主键为帐单号。主要用于领票时将旅客信息一同返回。4 机位信息表班机号机位信息.z.-机位信息表保存各班机各机位定票状况。它的外部主键为班机号。主要用于定票时确定旅客机位，并返回。52 物理数据结构设计物理数据结构设计主要是设计数据在模块中的表示形式。数据在模块中都是以结构的方式表示。1 旅客信息用于定票时接收1输入旅，客以姓及名领票时String服务器返回。2 帐2单号旅客性别Char可3使用身一份LONG证号码 INTLONG实现。INT用4于领工票作时单接位收输入String，以及定票时服务器返回。3 飞行目的1.航班号String用于定票时接收输入，以及领票时服务器返回。2.目的地String4 网络包起飞时间Date/Time3.1. 网络包 HeadINT4.座位号String用于数据在网络上的传输。2.传输数据String5 错误信息用于1关.于错错误误类操型作。INT6 机票2.信输息出语句String用于1打印航机班票号准备工作。数据类型可参照上面所述。7 帐单信2息目的地3起飞时间用于4打1印旅帐客帐单姓单准名号备工作。数据类型可参照上面所述。52旅客旅性客别姓名53 数据结构与程序的关系63身份身证份号证码号码服务器程7序4在座对位航定号班票号/领票进行操作时需对数据库数据库数据结构，也就是数据表进行查询和修85改：起在飞定时票间/领票过程中都需要对数据库中的所有表，进行联合查询、修改。6目的地物理数据结构主要用于各模块之间函数的信息传递。接口传递的信息将是以数据结构封装了的数据，以参数传递或返回值的形式在各模块间传输。出错信息将送入显示模块中，机票结构，帐单结构，送入打印准备模块中准备打印格式。6 运行设计61 运行模块的组合客户机程序在有输入时启动接收数据模块，通过各模块之间的调用，读入并对输入进行格式化。在接收数据模块得到充分的数据时，将调用网络传输模块，将数据通过网络送到服务器，并等待接收服务器返回的信息。接收到返回信息后随即调用数据输出模块，对信息进行处理，产生相应的输出。服务器程序的接收网络数据模块必须始终处于活动状态。接收到数据后，调用数.z.-据处理/查询模块对数据库进行访问，完成后调用网络发送模块，将信息返回客户机。62 运行控制运行控制将严格按照各模块间函数调用关系来实现。在各事务中心模块中，需对运行控制进行正确的判断，选择正确的运行控制路径。在网络传方面，客户机在发送数据后，将等待服务器的确认收到信号，收到后，再次等待服务器发送回答数据，然后对数据进行确认。服务器在接到数据后发送确认信号，在对数据处理、访问数据库后，将返回信息送回客户机，并等待确认。63 运行时间在软体的需求分析中，对运行时间的要求为必须对作出的操作有较快的反应。网络硬件对运行时间有最大的影响，当网络负载量大时，对操作反应将受到很大的影响。所以将采用高速 ATM 网络，实现客户机与服务器之间的连接，以减少网络传输上的开销。其次是服务器的性能，这将影响对数据库访问时间即操作时间的长短，影响加大客户机操作的等待时间，所以必须使用高性能的服务器，建议使用 Pentium III 处理器。硬件对本系统的速度影响将会大于软件的影响。7 出错处理设计71 出错输出信息程序在运行时主要会出现两种错误：1、由于输入信息，或无法满足要求时产生的错误，称为软错误。2、由于其他问题，如网络传输超时等，产生的问题，称为硬错误。对于软错误，须在定票/领票操作成功判断及输入数据验证模块由数据进行数据分析，判断错误类型，再生成相应的错误提示语句，送到输出模块中。对与硬错误，可在出错的相应模块中输出简单的出错语句，并将程序重置。返回输入阶段。出错信息必须给出相应的出错原因，例：全部班机座位已满！查无此定位信息！等。72 出错处理对策所有的客户机及服务器都必须安装不间断电源以防止停电或电压不稳造成的数据丢失的损失。若真断电时，客户机上将不会有太大的影响，主要是服务器上：在断电后恢复过程可采用 SQL SERVER 的日志文件，对其进行 ROLLBACK 处理，对数据进行恢复。在网络传输方面，可考虑建立一条成本较低的后备网络，以保证当主网络断路时数据的通信。在硬件方面要选择较可靠、稳定的服务器机种，保证系统运行时的可靠性。8 安全保密设计由于数据的传输上需要通过网络传输，为了客户资料进行保密，需要在网络的传输过程中对数据进行加密。这个工作主要是在准备网络包，及解开网络包这两个模块完成，它们各对数据进行加密及解密还原工作。.z.-在加密算法选择上将使用 RSA 加密算法。具体算法可参照参考资料中Computer Networkp.598。9 维护设计维护方面主要为对服务器上的数据库数据进行维护。可使用 SQL SERVER 的数据库维护功能机制。例如，定期为数据库进行 Backup，维护管理数据库死锁问题和维护数据库内数据的一致性等。.z.