TSPITF01概要设计说明书模板.docx

1、TSPITF01概要设计说明书模板概要设计说明书部 门： 编 写： 审 核： 批 准： 日 期： YYYY.MM.DD 文件修订记录时间作者主要修订内容YYYY.MM.DD目 录1 引言 11.1 目的 11.2 目标与范围 11.3 定义和缩写 11.4 参考资料 12 总体设计 22.1 设计思想 22.2 网络结构 22.3 系统架构 32.4 开发工具 42.5 总体结构 52.6 关键处理流程 52.7 接口设计 62.8 出错处理设计 62.8.1 出错输出信息 62.8.2 出错处理对策 62.9 质量属性设计 72.9.1 易用性设计 72.9.2 可靠性设计 72.9.3 效

2、率性设计 72.9.4 兼容性设计 72.9.5 安全性设计 73 系统功能设计 错误！未定义书签。3.1 子系统（模块）名称 错误！未定义书签。3.1.1 功能名称 错误！未定义书签。3.1.1.1 功能描述 错误！未定义书签。3.1.1.2 实现方法 错误！未定义书签。3.1.1.3 数据库设计 错误！未定义书签。3.1.1.4 权限设计 错误！未定义书签。3.1.1.5 接口描述 错误！未定义书签。3.1.1.6 补充说明 错误！未定义书签。3.2 错误！未定义书签。4 附录 101 引言1.1 目的列举本文档所针对的不同读者的目的，例如项目管理人员、设计人员等。此文档用于阐述XXX系统

3、（简称xxx）的概要设计方案，为项目管理人员、开发人员、测试人员的工作提供指导。1.2 目标与范围对本项目的目标与范围进行描述。1.3 定义和缩写列出本文件使用的术语定义和缩写字母的原词组。表1 定义和缩写表术语/缩写词定义术语/缩写词PPQA术语定义、缩写词的原词组、以及相关的详细解释等Process and Product Quality Assurance 过程与产品质量保证1.4 参考资料列出有关的参考文件，如：本项目的经核准的计划任务书或合同，上级机关的批文；属于本项目的其他已发表文件；本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、发表日期和出版单位，

4、说明能够得到这些文件资料的来源。2 总体设计2.1 设计思想简要说明系统的设计思想等。由于市委办公厅在市中心，其信息化建设对全市的电子政务内网建设具有重大示范效应和推动力。因此该系统的设计要求站在全市电子政务内网的高度来设计： 要充分注意系统的功能性、易用性、安全性、开放性、扩展性、兼容性、先进性和稳定性。 要处理好应用和安全的关系，以应用为龙头，应用做到哪里，安全保障就到哪里；2.2 网络结构描述系统的网络结构，画出拓扑图下图表示办公厅网络的结构：如图所示，办公厅网络具有如下特点： 办公厅内部局域网通过防火墙与系统其它部分完成逻辑隔离功能； 在防火墙停火区放置服务器群：内网网站、办公网站、数

5、据库服务器、LDAP服务器、备份服务器。 用磁带机提供备份功能； 在WEB服务器上，利用SSL协议提供受控信息的身份认证功能；对于公开信息，不作处理； 外部用户通过HTTP协议访问系统的公开信息，通过HTTPS协议访问受控信息，访问受控信息的用户需要使用USB KEY中保存的证书进行身份认证； 拨号上网用户首先要通过加密机,保证拨号链路达到普密级安全性。拨号上网用户要用PCI加密卡（台式机）或PC卡（笔记本）。2.3 系统架构说明系统采用的技术架构及运行环境等进行描述在本项目中将选用J2EE技术。以下为其结构图：数据库平台选用Oracle 数据库。Oracle 是以高级结构化查询语言(SQL)

6、为基础的大型关系数据库，是目前最流行的数据库之一。同时Oracle提供了高级安全性解决方案，保证数据的安全性和完整性。本系统中使用9i 系列的版本。2.4 开发工具对拟采用的开发工具进行描述。开发工具使用Eclipse。Eclipse平台的特点如下： 开放的可扩展的IDE：Eclipse平台是一个开放的可扩展的IDE。Eclipse平台是建造模块和构造并运行集成软件开发工具的基础。Eclipse平台允许工具建造者独立开发与其他工具无缝集成的工具，用户甚至无须去分辨一个工具功能在哪里结束、而另一个工具功能在哪里开始。 成功的底层图形界面API：从Java诞生至今，已经在太多的领域取得成功，然而它

7、却很少在图形界面程序上崭露头角。究其原因，Java语言缺省的图形界面开发包AWT和SWING实在是难辞其咎，无论速度和外观，它们都难以让人接受。如今，Eclipse组织编写的SWT开发包，为Java程序员提供了AWT和SWING之外的一个更佳的选择。 强大的插件加载功能：可以通过不断地加载插件来实现同其他制品的合作。整个Eclipse体系结构就像一个大拼图，可以不断地向上加插件，同时，现有插件上还可以再加插件，进而实现功能的扩展。目前，Eclipse已经开始提供C语言开发的功能插件。更难能可贵的，Eclipse是一个开放源代码的项目，任何人都可以下载Eclipse的源代码，并且在此基础上开发自

8、己的功能插件。也就是说未来只要有人需要，就会有建立在Eclipse之上的COBOL，Perl，Python等语言的开发插件出现。同时可以通过开发新的插件扩展现有插件的功能，比如在现有的Java开发环境中加入Tomcat服务器插件。可以无限扩展，而且有着统一的外观、操作和系统资源管理，这也正是Eclipse的潜力所在。 可以通过导入一些CVS相关的插件来实现版本管理的便易性：Eclipse平台提供了对于直接从工作区进行团队开发操作的支持。这种支持允许开发人员并发地与几个独立的资源库以及不同版本的代码或项目进行交互。工作区中的资源允许团队支持组件处理版本和配置管理问题。当然，单个工作区也可以同时访

9、问不同类型的资源库。Eclipse平台并没有提供它自己的代码管理解决方案，它总是依靠外部系统。Eclipse平台只对一个（但也是最流行的一个）源代码管理系统提供内置支持并发版本控制系统CVS。 充分的帮助文件：在下载了Eclipse的多国语言翻译包之后，所有的菜单和联机帮助都已经翻译成了中文，使用起来非常方便。2.5 总体结构可用结构图来描述系统模块间关系的层次图，结构图的基本组成部分是模块，模块用来标识一个或几个功能，在结构图中表示了系统的层次关系和调用关系。本系统按照功能可以分为以下功能模块：2.6 关键处理流程对本系统中的关键处理流程进行描述。2.7 接口设计此处说明该系统的外部接口，包

10、括与硬件的接口和与其它软件系统的接口。应说明接口范围（与那些硬件、软件存在或可能存在接口）、需要交换的数据内容，再说明如何处理接口。案件管理系统与统计系统之间的接口采用中间文件的方式实现，案件管理系统中的报表导出为满足统计系统要求的xxx格式，再导入到统计系统中。2.8 出错处理设计2.8.1 出错输出信息 说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。2.8.2 出错处理对策如设置后备、性能降级、恢复及再启动等。2.9 质量属性设计2.9.1 易用性设计关于易用性方面的设计。 1复杂操作在页面上显示帮助信息；2每个页面支持在线帮助，“F1”键响应；3采用图形按钮，鼠

11、标移到按钮上时显示提示信息；42.9.2 可靠性设计关于可靠性方面的设计。1 每天进行进行数据自动备份；2 2.9.3 效率性设计关于效率性方面的设计。1 尽量避免在循环中反复连接数据库；2 SQL语句长度适当，采用分组等进化优化；3 2.9.4 兼容性设计关于兼容性方面的设计。1 为了兼容SqlServer 和Oracle，程序中使用标准SQL语句，要使用SqlServer或Oracle特定的SQL语句时，要进行判断。2 2.9.5 安全性设计系统安全性设计主要考虑两个方面：a）从硬件及网络方面保证系统的可靠性，比如服务器采用千兆网卡与主干交换机相连，利用光纤通道访问磁盘阵列，利用磁带机备份

12、数据等方法。b）从软件方面主要是操作系统、数据库、数据保密性、数据网关、管理工具、系统功能等多个层次上对用户权限进行管理。市委办公厅安全系统主要从两个方面进行考虑：硬件方面：使用防火墙、防病毒、LDAP服务器、USB KEY、数据密码卡、文件保险箱等。软件方面：包括身份认证、访问控制、数字签名，日志等。对这些措施的简单描述如下： 身份认证：基于PKI体系，利用USB KEY或拨号加密卡中存放私钥和证书，实现身份认证； 访问控制：根据身份验证结果，从LDAP服务器中取得角色和权限信息，应用系统根据这些信息，决定用户是否能够进行某种操作或访问某种信息； 数字签名：对重要文件和数据提供完整性保护。进

13、行数字签名时，应用程序将从USB KEY或拨号加密卡中取得用户的私钥。对数字签名进行验证时，应用程序需要从LDAP服务器中取得用户的公钥； 日志：由操作系统，WWW服务器和应用系统提供的各种日志等； 应用安全：包括上面提到的身份认证，访问控制，数字签名和日志外，另外还有对输入数据进行有效性和长度检查，程序设计和编制时要避免出现漏洞等方面；3 数据库设计整体叙述。3.1 设计规范3.1.1 环境说明（1）说明所采用的数据库系统，设计工具，编程工具等（2）详细配置3.1.2 设计原则3.1.3 命名规范3.1.4 管理与维护规则3.2 物理设计3.2.1 物理模型图列出数据库设计的模型图3.2.2

14、 数据字典3.2.2.1 数据库表设计3.2.2.1.1 车辆基础信息表序号字段名称中文标识数据类型必须赋值默认值主键备注01USER_ID用户账号VARCHAR2(20)TRUETRUE02NSRSBH纳税人识别号VARCHAR2(20)TRUEFALSE03WIDTH宽NUMBER(6)FALSEFALSE04HEIGHT高NUMBER(6)FALSEFALSE05PDFECLEVEL纠错率 1-8NUMBER(6)FALSEFALSE06X图片分辩率NUMBER(6,2)FALSEFALSE07LRRQ录入日期DATEFALSEFALSE08DKH条码枪端口号，com1至com9VARCHAR2(10)FALSEFALSE09EDZDKLX设置端口类型 0代表COM口，1代码USB口VARCHAR2(2)FALSEFALSE10EDZCJ读卡器厂家：1代表华旭 0代表公安一所（包含神盾）2代表国腾VARCHAR2(2)FALSEFALSE11EDZDK设置端口，0表示COM1 ，1：COM2 2：COM3VARCHAR2(6)FALSEFALSE3.2.2.2 存储过程、函数、包设计4 附录把其他与设计相关的文档放在这里，可以直接写在文档中，也可以放到其他文档中，在这里进行索引。比如利用其他工具所做的各种模型文件等。如没有则直接将该章节删除。