详细设计说明书模版

1、公路水路交通运输信息共享与服务系统一期工程（XX 子系统）详 细 设 计 说 明 书拟制日期审核日期文件编号批准日期版本号文件状态： 征求意见稿 正式发布公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书版 本 历 史版本/状态作者参与者起止日期修改内容公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书签字页签字页单位名称代表人日期（承建单位）（承建单位）（设计单位）（设计单位）（监理单位）（监理单位）（用户单位）（用户单位）（建设单位）（建设单位）（总集成单位）（总集成单位）公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细

2、设计说明书目目 录录第一章第一章概述概述.11.1项目背景.11.2编写目的.11.3预期的读者.11.4阅读建议.11.5参考资料.21.6术语.21.7设计的前提与限制.3第二章第二章XXX 系统设计系统设计.42.1平台功能要求.42.2运行环境.52.2.1平台安装网络环境.52.2.2数据中心运行环境.52.2.3客户端运行环境.52.3主要界面.62.3.1界面界面n.62.4功能结构.62.4.1功能功能n.152.5接口设计.172.5.1内部接口设计.172.5.2软件接口设计.172.5.3外部接口设计.172.5.4可扩展接口设计.172.

3、6安全保密设计.172.6.1用户使用权限设计.172.6.2存储安全性设计.17公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书2.6.3数据传输安全性设计.172.7出错处理设计.172.7.1出错信息.172.7.2补救措施.182.8维护设计.19公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书1第一章概述1.1项目背景1.2编写目的根据 XXX 系统需求规格说明书和概要设计说明书内容，对需求规格说明书确定的功能需求和数据需求，在概要设计的基础上，结合原型开发过程设计的类、函数、数据库表结构和字段等，从总体设计、各子项（平台及各应

4、用系统）程序设计的角度进行详细阐述，作为开发、测试、部署实施及验收的主要依据之一。该文档和概要设计、数据库设计文档一起，作为设计评审的依据。1.3预期的读者评审专家组成员；项目管理单位技术人员；项目开发单位项目经理、设计人员、开发人员、测试人员、文档管理人员等；项目监理单位具体负责人员；与本项目相关的其它人员。1.4阅读建议详细设计是在概要设计的基础上，对概要设计描述的功能点内容进一步细化，从功能实现的角度，详细描述功能接口、算法、输入输出、代码实现等内容，对于每一个实现的功能要附有代码或伪码，并标有注释描述。因此，详细设计主要供设计开发公路水路交通运输信息共享与服务系统一期工程项目 XXX

5、系统 详细设计说明书2人员阅读，作为开发人员开发的依据。1.5参考资料1.6术语元数据：元数据是数据的数据，即对数据的描述性信息，包括用于描述结构化数据的内容、覆盖范围、质量、管理方式、数据的所有者等信息。源数据：是指在进行数据交换时，数据所在地的原始数据。耦合：耦合是指两个或两个以上的模块或子系统、系统的输入与输出之间存在紧密配合与相互影响。松耦合：是指模块或子系统、系统间的独立性好，相互影响小，可移植性好，支持代码重用性。GIS：英文 Geographic Information System，中文指地理信息系统。公路网：一定区域内相互连通、交织成网状分布的公路系统。地理数据：指表征地理圈

6、或地理环境固有要素或物质的数量、质量、分布特征、联系和规律的数字、文字、图像和图形等的总称。地理信息：有关地理实体的性质、特征和运动状态的表征和一切有用的知识，它是对地理数据的解释。信息系统：具有数据采集、管理、分析和表达数据能力的系统，它能够为单一的或有组织的决策过程提供有用的信息。驱动：某一类事情的统称.如访问 ORACLE 数据库、访问 SYBASE 数据库、获取气象信息等等。事件：定义于某个函数，当这个函数被用户执行的同时，这个事件也同时被触发。如给获取北京的气象信息这个函数定义一个插入数据中心的事件，当用户获取北京的气象信息的时候，获取到的气象数据同时被插入到相应的数据中心里。公路水

7、路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书3数据源：DSN（Data Source Name） ，用于连接某个具体数据库的名称。度量指标：竖型显示数据的统计信息。全部以数字为主。主要展示出金额，车数流量等类似的统计信息。纬度指标：横向显示数据的明细信息。根据横向条件来显示竖型统计信息的明细。例如：按区划来横向分析车数流量。分析策略：根据竖型显示的数据和横向显示的数据显示出的的报表效果，做出一个什么样的分析。以表示每出的一个分析报表都是有意义，有针对性的。1.7设计的前提与限制XXX 系统详细设计说明书以需求规格说明书和概要设计为依据，设计的前提和限制条件是需求规格说

8、明书规定的需求内容和概要设计描述的内容，对于没有规定和描述的内容，不纳入设计范畴。如需求发生变更，则首先履行需求变更手续，更改需求规格说明书，然后相应的更改概要设计内容，此后才更改相应的详细设计内容。公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书4第二章XXX 系统设计2.1平台功能要求XXX 系统，从逻辑功能来分，主要 等。整合平台功能需求如表(与需求规格说明书对应)所示。例：名称功能点详细功能点功能简要说明交换节点管理交换节点（适配器）注册。 功能节点管理功能节点依托于交换节点进行分发以及采集数据。节点管理事件管理功能节点通过事件进行对数据的处理，用户可以根据

9、事件对数据进行处理。数据抽取实现源数据的抽取(包括清洗、过滤等)、转换、装载以及与底层的消息服务器进行通讯。数据装载根据抽取规则所抽取的数据装载到目标数据库中。交换任务管理任务管理对配置的数据抽取和数据装载的规则进行配置任务数据源管理管理相关数据对象、基础数据对象等初始化配置。用户管理用来管理登陆平台的用户信息，增删改用户，分配角色，赋予权限。时间设置用来设置时间，保证平台时间与当前时间相同。IP 设置对平台 4 个网口进行配置。日志管理列出整合库可记录的所有工作日志类型项，进行日志监控和管理。日志查看对记录的日志进行查看。任务监控查看平台所进行的交换任务。驱动管理平台的预留接口，可以任意对平

10、台不断进行扩展。XXX系统系统管理密码修改为登陆平台的用户进行修改密码。公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书5表二-1XXX 系统功能需求点列表2.2运行环境2.2.1 平台安装网络环境平台安装网络环境 2.2.2 数据中心运行数据中心运行环境环境硬件环境要求硬件环境要求 软件环境要求软件环境要求 网络环境要求网络环境要求 2.2.3 客户端运行环境客户端运行环境硬件环境需求硬件环境需求 软件环境需求软件环境需求 网络环境需求网络环境需求 公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书62.3主要界面2.3.1 界面界面 1

11、2.3.2 界面界面 n2.4功能结构图：总体功能图2.4.1 功能功能 1增改增改 XXX 程序描述程序描述 功能功能例：本程序完成对驱动的增加和修改。交换节点（适配器）注册。性能性能例：一个驱动标识一个数据来源，包括来自数据库、其他业务系统接口。能准备定位新驱动的数据来源等信息。输入项输入项 例：公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书7交换节点名称：交换节点的唯一标识驱动名称：驱动的唯一标识数据源：用于连接节点数据库的唯一标识。描述：用于显示在界面上的节点标签。所属单位：标识交换节点的所属的单位。输入的方式输入的方式例：交换节点名称：用户可以页面编辑框

12、中输入。驱动名称：用户可在页面下拉框中选择。数据源：用户可在页面的下拉框中选择。描述：用户可以页面编辑框中输入。所属单位：用户可以页面编辑框中输入。输出项输出项 例：成功：返回成功信息。失败：返回错误提示。功能界面功能界面例：点击“节点管理”菜单下的“交换节点管理” ，您可以看见所有的节点信息。如图：公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书8图 3-1 交换节点管理您可以增加和删除交换节点。增加交换节点点击“增加”按钮，进入“选择驱动”页面，选择驱动名称，点击“下一步” ，填写相应信息，点击“保存” 。删除节点选择您需要删除交换节点的项目，可以多个，选择完毕

13、后，点击“删除”按钮进行删除。流程逻辑流程逻辑 例：本程序首先得选择这个驱动，驱动再进行调用的动态库文件。选择驱动后在系统数据库中的驱动基本信息表中增加相应的记录。编辑新交换节点组织新交换节点报文操作增加交换节点出错定义节点成功并返回结果报文至前台插入修改交换节点信息表操作返回错误提示出错成功发送新节点报文至后台后台程序拆解新节点报文连接系统数据库图 3-2 节点设置流程图接口接口例：与驱动之间进行动态调用。公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书9代码（伪码）实现代码（伪码）实现例：/*增改交换节点,组织新交换节点报文*/byte len = new by

14、te18;in.read(len);String headstr=null;/节点报文headstr = new String(len);String srevicestatus=null;/声明节点状态变量 String srevicekeytype=null;/声明加密方式变量 String srevicerow=null;/声明节点报文行数变量 String srevicerol=null;/声明节点报文列数变量 String srevicecount=null;/声明报文字节数变量 srevicestatus = headstr.substring(0,1); /得到节点状态，并赋值

15、srevicekeytype = headstr.substring(1,2);/得到加密方式，并赋值 srevicerow = headstr.substring(2,6); /得到节点报文行数，并赋值 srevicerol = headstr.substring(6,10); /得到节点报文列数，并赋值 srevicecount= headstr.substring(10,18);/得到节点报文字节数，并赋值存储分配存储分配 例：本程序的涉及到的数据都存于系统数据库的节点基本信息表中。当某个节点被调用时，系统会把这个节点的信息加载到内存中。数据引用数据引用例：节点基本信息表字段名数据类型字

16、段说明交换节点编号字符型用作节点基本信息表的主键，唯一标识一个驱动。交换节点名称字符型能含有中文。交换节点描述字符型可以为中文，作为显示在页面上的节点标签。公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书10交换节点类型字符型标识该驱动获取数据的方式。驱动字符型支撑驱动功能的动态库文件。注释设计注释设计 例：加在模块首部的注释；/*定义交换节点*/b加在各分枝点处的注释； 对各变量的功能、范围、缺省条件等所加的注释； /*增加新节点*/*组织报文*/*发送报文*/*处理报文*/*连接数据库*/*插入新记录到节点基础表中*/*断开数据库*/*修改节点信息*/*组织报文

17、*/*发送报文*/*处理报文*/*连接数据库*/*修改交换节点基础表中相应信息*/*断开数据库*/模块测试计划模块测试计划 公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书11例：增改交换节点模块采用交叉测试。删除删除 XXX 程序描述程序描述 功能功能例：删除某个交换节点。性能性能例：能把用户要删除的交换节点的基本信息从系统数据库的节点基础表中清除。输入项输入项 例：交换节点编号：用于唯一标识一个交换节点。输入的方式输入的方式例：在页面上选择。输出项输出项 例：成功：返回成功信息。失败：返回错误提示。功能界面功能界面例：点击“节点管理”菜单下的“交换节点” ，您可

18、以看见所有的节点信息。如图：公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书12图 3-3 节点展示您可以删除节点。删除节点点击“删除”按钮，弹出对话框，点击“确定” 。流程逻辑流程逻辑 例：本程序通过用户页面提供的驱动编号，访问系统数据库中的驱动基础表，删除相应记录并清除内存中相应的驱动信息。获取节点编号访问数据库操作出错删除节点成功数据库删除操作返回错误提示成功选择交换节点删除所选节点组织删除交换节点报文发送删除交换节点报文至后台后台程序拆解报文图 3-4 删除节点流程图代码（伪码）实现代码（伪码）实现例：/*删除交换节点*/*遍历节点列表，获取要删除的交换节点

19、编号*/for(int row=0;row 0 ) int itmp = 0; String stmp = null; stmp = UtilTool.strspilt(revicepackeg1,t,0); itmp = stmp.indexOf(_); if(itmp 0) itmp = itmp+1; stmp = stmp.substring(itmp, stmp.length(); list.del(configdto); /删除节点注释设计注释设计 例：加在模块首部的注释；/*删除交换节点*/加在各分枝点处的注释； 对各变量的功能、范围、缺省条件等所加的注释； /*获取节点编号*/

20、*组织报文*/*发送报文*/*连接数据库*/*删除相应节点记录*/*断开数据库*/ 模块测试计划模块测试计划 例：删除交换节点模块采用交叉测试。公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书142.4.2 功能功能 n增改增改 XXX 程序描述程序描述 功能功能性能性能输入项输入项 输入的方式输入的方式输出项输出项 功能界面功能界面流程逻辑流程逻辑 接口接口代码（伪码）实现代码（伪码）实现公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书15数据引用数据引用注释设计注释设计 模块测试计划模块测试计划 删除删除 XXX 程序描述程序描述 功

21、能功能输入项输入项 输入的方式输入的方式输出项输出项 功能节点管理界面功能节点管理界面流程逻辑流程逻辑 代码（伪码）实现代码（伪码）实现注释设计注释设计 模块测试计划模块测试计划 公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书162.5接口设计2.5.1 内部接口设计内部接口设计2.5.2 软件接口设计软件接口设计2.5.3 外部接口设计外部接口设计2.5.4 可扩展接口设计可扩展接口设计2.6安全保密设计2.6.1 用户使用权限设计用户使用权限设计2.6.2 存储安全性设计存储安全性设计2.6.3 数据传输安全性设计数据传输安全性设计2.7出错处理设计2.7.1

22、 出错信息出错信息例：下表列出来系统可能出现的轻微错误及相应的处理办法：公路水路交通运输信息共享与服务系统一期工程项目 XXX 系统 详细设计说明书17可能出现错误可能出现错误系统内部错误信息系统内部错误信息处理方法处理方法连接数据库错误3001检查用户输入用户名、密码和数据源名是否有误。获取数据错误3002检查附加数据语法是否有误。SOCKET 通讯错误3003检查网络是否连通。HTTP 通讯错误3004检查网络和防火墙是否开启。SOAP 通讯错误3005检查网络。用户操作错误3006后退，并重新操作。用户输入错误3007检查用户输入的数据格式或数据类型是否合理。模块接口错误3008检查软件内部接口是否完好。2.7.2 补救措施补救措施为了保证数据交换平台的安全性，我们设计的数据交换平台有很完善的故障补救方案，包括下面几项：后备技术：数据交换平台可以把数据以XML的格式发布给其他应用系统或其他用户，用户也可以通过手工的方式把数据导出到其他存储设备中。降效技术：数据交换平台中以插件的方式，