概要设计说明书

XXX项目概要设计说明书文档编号版本号最后更新日期敏感性级别公开/业务范围/技术范围/内部保密文档修订记录日期版本号操作类型经办人活动描述1.引言1.1术语和缩写本文用到的术语符合国家标准《软件工程术语（GB/T11475-1995）》。与本文直接相关的国家标准包括：（中国标准出版社1996年）GB8566-1995软件生存期过程GB8567-88计算机软件产品开发文件编制指南GB8567-88计算机软件数据库设计说明编制指南GB/T11457-1995软件工程术语1.2参考资料文件名称文件版本《XXX系统软件需求规格说明书》同附件V1.0《XXX系统业务需求说明书》V1.01.3设计约束（1）需求约束本系统应当遵循的标准或规范。硬件、操作系统、数据库等基础架构条件描述，如能在普通PC机、windows操作系统上运行。页面简单、操作方便快捷。具有较高的正确性、健壮性、可靠性、效率（性能）、易用性、清晰性、安全性、可扩展性、兼容性、可移植性。（2）隐含约束用户必须具备一定的计算机使用能力IE版本在5.0或5.0之上中央处理器CPU主频800MHZ以上，内存最小128MB，硬盘最小10G，以及必要的网络设备。1.4设计策略1．扩展策略XXX系统的软件设计采用模块化体系结构，新功能的引入不影响原有的功能模块，具有良好的可扩展性。2．复用策略信息查询、统计汇总设计考虑部分通用化设计，便于复用。3．安全性系统中涉及到敏感信息，系统应具备统一、完善的多级安全机制，以保证系统的安全性。4．易用性系统应提供友好的操作界面，便于用户的操作和管理。5．灵活性业务本身具有较多的灵活性，在系统设计时，设计上要充分考虑到灵活性。2.总体设计2.1设计规定1、所有的数据库命名都是以模块的缩写加上具体表的英文词汇组成，这样能够统一数据库表的命名，也能够更好的规范数据库表命名。2、所有数据库的设计，都采用RationalRose进行，并且采用面向对象的设计方法，首先进行对象实体的设计，最后将对象持久化到数据库中，所有的表和表之间的关联(ER图)都采用标准的Rose设计工具进行，这样能够将整个系统的设计和数据库设计有机的结合起来。3、界面风格：管理界面做到美观大方、风格统一，并有一些提示信息指导用户操作使用。尽量使用选择框、下拉框等选择操作界面，方便用户的使用。4、消息提示：中文提示，言简意赅。2.2运行环境2.2.1软件平台服务器操作系统：UNIXDB服务器数据库软件的名称：Oracle数据库软件的版本：9i客户端操作系统：MicrosoftWindows2000/XP；CPU：1G；内存：256M；硬盘：剩余1G2.2.2开发环境的配置类别标准配置计算机硬件HP520CPU：IntelCore（TM）DuoT2600主频：2.16GHz硬盘：160G内存：2G软件操作系统：WindowsXP开发环境：java+eclipse3.2VB6数据库：Oracle9i网络通信建议电信、网通各100M独享带宽2.2.3集成环境的配置类别标准配置计算机硬件CPU:IntelCPU2.66GHz（及以上）内存容量：1024硬盘容量：80G软件操作系统：Windows2000/2003/XP（及以上）开发环境：java+eclipse3.2VB6数据库：Oracle9i网络通信建议电信、网通各100M独享带宽2.2.4测试环境的配置类别标准配置计算机硬件CPU:IntelCPU2.66GHz内存容量：512M硬盘容量：80G软件操作系统：Windows2000/2003/XP开发环境：java+eclipse4.5VB6数据库：Oracle9i网络通信建议电信、网通各100M独享带宽2.3基本设计概念和处理流程设计方法：面向对象2.4技术架构描述实现中所采用的技术框架。如下述采用MVC设计范式的B/S多层网络计算架构，描述示例如下：应用系统构架采用了先进的MVC（Model-View-Controller）设计范式（DesignPattern），如下图所示。采用分布式多层体系，使用平台无关的的技术框架和业务逻辑构件化技术。MVC模型图所谓的MVC（Model-View-Controller）设计范式可以说是目前国际上最流行的先进软件设计范式。MVC是一种设计思想。这种思想强调实现模型(Model)、视图(View)和控制器的分离。在web开发中引入MVC思想，想要达到的目的是：UI层和业务逻辑层分离——控制器是为了实现上述目的而存在的！在解决了持久化的问题后，业务逻辑层和MVC中的Model指的是一回事，UI层和MVC中的View是一回事。MVC提供了让模型和视图相分离的思路——引入控制器。页面跳转关系管理、表单数据的封装及验证、国际化等任务交给控制器处理。因此，MVC框架都具有管理页面跳转关系、表单数据的封装及验证、国际化等特性。2.5功能需求与程序关系程序1程序2……程序n功能需求1√√功能需求2√……功能需求n√√3．界面设计3.1应当遵循的界面设计规范页面主色调为蓝色，配合桔黄色和淡黄色，整个页面显得清爽界面简单易懂，操作按钮放置位置明显、清楚。页面层次尽量少，规定页面链接在四级以下。3.2主界面插入主界面图片3.3美工设计（1）界面的布局及理由界面的布局遵循中以下四个原则：直观原则一致性原则合理化原则鼠标键盘对应原则（2）界面的色彩及理由界面色彩遵循《设计规范》中一下两个原则:美观与协调性原则舒适性原则3.4界面资源设计整个系统指示同一个功能必须使用相同的图标，所有图标资源放在icons目录。3.4.1图像资源本系统的图像资源由美工人员设计绘制，主要图像资源放在数据目录images。3.4.2界面组件控件布置整齐，界面组件的设计遵循简洁统一的原则。4.接口设计4.1外部接口说明本系统同外界的所有接口的安排包括软件与硬件之间的接口；本系统与各支持软件之间的接口关系请填写《系统接口设计说明书》。4.2内部接口说明本系统之内的各个模块采用配置文件进行连接。5.运行设计5.1程序模块结构图绘制程序中各模块的结构关系图。5.2运行控制根据业务处理类型的不同，把作业划分为两类：交互类业务、查询类业务。在本方案中，相关的性能指标如下：交互类业务交互类业务是指平时工作中在系统中进行的业务处理，如录入，修改或删除一条单据等操作。平均响应时间：2-5(秒)峰值响应时间：8-15(秒)查询类业务如信息查询、统计报表生成等。查询业务由于受到查询的复杂程度、查询的数据量大小等因素的影响，需要根据具体情况而定，在此给出一个参考范围。简单查询平均响应时间：2-10(秒)复杂查询平均响应时间：10-60(秒)6.安全设计6.1架构安全6.2数据安全6.3运行安全6.4管理安全7.数据结构设计7.1逻辑结构设计要点根据系统的实际情况来确定。遵循PAFA架构分层原理。如下所示：简单而言，分成三个层次：用户展示层(WEB层)、业务逻辑层，数据处理层（集成层、资源层）。8.系统出错处理设计8.1出错信息故障描述输出信息形式错误含义处理方法连接数据库失败对话框提示网络连接失败;服务未启动;数据库配置错误检查网络连接，开启数据库服务，进行正确的数据库配置目前权限无法进行相关操作对话框提示登陆用户的权限不能进行的相关的操作联系系统管理员请求授予权限8.2补救措施为了预防系统故障或者遭遇黑客攻击造成的丢失数据，将采用以下四种方法保护数据：a.后备技术：双机备份；b.降效技术：通过数据库的第三方工具（如PL/SQL，TOAD等）对数据库进行备份；c.设置数据库的自动备份，防止人工备份的不及时8.3系统维护设计本系统没有采用单独的维护设计模块，在做开发技术选择的时候采用易于维护的开发技术，所以系统采用数据库字段和应用界面中的控件绑定的技术，这样有利于今后的系统维护。