软件架构设计说明书.doc

1 架构设计说明书架构设计说明书 版本版本 1 0 01 0 0 1 签署栏签署栏 拟制拟制审核审核批准批准 修订历史修订历史 版本说明作者审核修订日期 1 0 发布 Dick 2 目录目录 1 1 引言引言 6 6 1 1目的 7 1 2范围 7 1 3预期的读者和阅读建议 7 1 4术语 首字母缩写 7 1 5参考资料 7 2 2 系统逻辑结构系统逻辑结构 7 7 2 1总体结构 7 2 2系统功能实现 8 2 3组件接口 8 2 4组件功能 8 2 5数据库关系模型 8 3 3 系统物理实现系统物理实现 9 9 4 4 系统部署系统部署 9 9 5 5 系统其它考虑系统其它考虑 9 9 5 1系统可扩展性 10 5 2系统可靠性 10 5 3系统性能 10 5 4系统维护性 10 5 5系统安全 10 5 6系统异常处理 10 6 6 约束约束 1010 6 1设计指南 10 6 2编码规范 10 6 3配置文件约定 11 6 4日志文件约定 11 3 6 5运行目录约定 11 7 7 需求矩阵需求矩阵 1111 4 1 1 引言引言 对于由多个进程构成的复杂系统 系统设计阶段可以分为 架构设计 构架设计 组件高层设 计 组件详细设计 对于由单个进程构成的简单系统 系统设计阶段可以分为 系统概要设计 系统 详细设计 本文档适用于由多个进程构成的复杂系统的构架设计 架构设计说明书是软件产品设计中最高层次的文档 它描述了系统最高层次上的逻辑结构 物理 结构以及各种指南 相关组件 粒度最粗的子系统 的内部设计由组件高层设计提供 系统 指待开发产品的软件与硬件整体 其软件部分由各个子系统嵌套组成 子系统之间具有明 确的接口 组件 指粒度最粗的子系统 模块 指组成组件的各层子系统 模块由下一层模块或函数组成 此文档的目的是 1 描述产品的逻辑结构 定义系统各组件 子系统 之间的接口以及每个组件 子系统 应 该实现的功能 2 定义系统的各个进程以及进程之间的通信方式 3 描述系统部署 说明用来部署并运行该系统的一种或多种物理网络 硬件 配置 对于每 种配置 应该指出执行该系统的物理节点 计算机 网络设备 配置情况 节点之间的连 接方式 采用何种通信协议 网络带宽 另外还要包括各进程到物理节点的映射 4 系统的整体性能 安全性 可用性 可扩展性 异常与错误处理等非功能特性设计 5 定义该产品的各个设计人员应该遵循的设计原则以及设计指南 各个编程人员应该遵循的 编码规范 建议架构设计工程师与组件设计工程师共同完成此文档 5 架构设计说明书的引言应提供整个文档的概述 它应包括此文档的目的 范围 定义 首字母缩 写词 缩略语 参考资料和概述 1 1 目的 简要描述体系结构文档的目的 1 2 范围 简要说明此文档的范围 它的相关项目以及受到此文档影响的任何其它事物 1 3 预期的读者和阅读建议 说明此文档的阅读对象 简要说明此文档中其它章节包含的内容与文档组织方式 对于不同读者 的阅读方式建议 如 目标读者是系统最终用户 系统分析员 项目经理 产品经理 市场人员等 此文档的第 2 章描述 本项目的组织架构和参与人员如下 A A 项目负责人 项目负责人 参与开发策划 负责批准项目开发计划书 安排项目组成人员 从技术和业务上总体把握 确定项目进度及检验标准 了解开发中存在问题 并及时制定相应对策 B B 技术总协调 技术总协调 负责制订软件标准 负责支撑软件的维护 6 评估将在其中部署项目最终产品的目标组织的情况 协调目标组织的建模工作 在必要时对业务工程工作进行讨论和协调 对目标组织中所建议的任何变更进行成本效益分析 C C 系统分析 设计 系统分析 设计 负责获取用户最终需求 概括系统的功能和界定系统来领导和协调需求获取及用例建模 编写 XXX 新版本软件详细设计 制订命名规范 软件构架设计 划分子模块并详细描述各模块功能 要求 和测试要点 对软件架构中重要的类做详细说明 描述其属性 方法 和相互之间的关系 数据库设计 包括定义表 索引 视图 约束条件 触发器 存储过程等 D D 软件开发 软件开发 严格按照软件详细设计说明 负责自己开发的模块的资料 软件的备份及保管工作 在软件开发中如发现系统分析设计时漏洞提出异议 提交问题报告至项目负责人 对各自编写的内容相互交换作单元测试 负责 用户使用手册 的编写 E E 文档编写 文档编写 负责编写软件 详细设计说明书 数据库设计说明书 测试方案文档 F F 软件测试 软件测试 负责对各模块的集成测试 和软件的整体评估测试 在测试完后负责编写 测试报告 1 4 术语 首字母缩写 序号缩写英文说明中文说明 1ACCAFC Clearing Center AFC 清算管理中心 2ACLAccess Control List 访问控制列表 3ACPI Advanced Configuration and Power Interface 先进的配置和电源接口 7 序号缩写英文说明中文说明 4AFCAutomatic Fare Collection 自动售检票 5AGMAutomatic Gate Machine 自动检票机 6ALDT Administrative and Logistics Down Time 行政和后勤响应时间 7ALUArithmetic Logic Unit 算术逻辑部件 8ASAAdaptive Security Algorithm 适应的安全算法 9AVMAdd Value Machine 自动充值机 10BCDBinary Code Decimal BCD 码指每位十进制数用 4 位二 进制数编码表示的方法 11BIOSBasic Input Output System 微机的基本输入输出系统 12MAC Municiple Administration Communication Card Co 市政交通一卡通 13BOMBooking Office Machine 半自动售票机 14CPUCentral Processing Unit 中央处理器 15CRCCyclic Redundancy Check 循环冗余校验 16DATDigital Audio Tape 数字音频磁带 17DBDatabase 数据库 18DBADatabase Administrator 数据库管理员 19DDLData Definition Language 数据定义语言 20DDSDigital Data Storage 数字数据存储 21DESData Encryption Standard 数据加密标准 22 Default Gateway Default Gateway 默认网关 23DMZDe militarised zone 非军事区 8 序号缩写英文说明中文说明 24DoSDenial of Service 拒绝服务 25DRPDynamic Routing Protocol 动态路由协议 26DSCP Differentiated Services Code Point 区分服务代码 27E SEncoder Sorter Machine 车票编码分拣机 28EBEmergency Button 紧急按钮 29ECCError Checking and Correcting 错误检查校正 30ECUEquipment Control Unit 设备的主要控制单元 31EEPROM Electrically Erasable Programmable Read Only Memory 电可擦除只读内存 32EMCElectromagnetic Campatibility 电磁兼容性 33EnGEntry Gate 进站自动检票机 34ExGExit Gate 出站自动检票机 35Fail OverFail Over 容错 36FC ALFibre Channel Arbitrated Loop 光纤通道仲裁环 37FCSWFiber Channel Switch 光纤通道交换机 38FDDFloppy Disk 软盘 39GUIGraphical User Interface 图形用户接口 40H WHardware 硬件 41HAHigh Availability 高可用性 42HDHard Disk 硬盘 43HDDHard Disk Drive 硬盘驱动器 44 Hot Standby Unit Hot Standby Unit 热备份单元 9 序号缩写英文说明中文说明 45I OInput Output 输入 输出 46IDIdentification 身份 47IDEIntegrated Drive Electronics IDE 接口 48ISAIndustry Standard Architecture 工业标准结构总线 49Kbps Kilo thousand bits per second 千比特 秒 速率 50KMSKey Management System 密钥管理系统 51LANLocal Area Network 局域网 52LCDLiquid Crystal Display 液晶显示器 53LCLine Center 线路中央计算机系统 54LCSLine Computer System 线路计算机系统 55LEDLow Emitting Diode 发光二极管 56LTOLinear Tape Open 线性磁带开放协议 57MACMessage Authentication Code 消息认证码 58MAKMemory Access Key 内存存取密钥 59MbpsMega Million bits per second 兆比特 秒 速率 60MCBFMean Cycles Between Failure 平均无故障时间 61MCUMain Control Unit 主控单元 62MHzMega Hertz 兆赫兹 频率 63MTBFMean Time Between Failure 平均无故障时间 64MTTRMean Time To Repair 平均故障恢复维修时间 65N WNetwork 网络 66NICNetwork Interface Card 网络接口卡 67NMSNetwork Management System 网络管理系统 10 序号缩写英文说明中文说明 68NTPNetwork Time Protocol 网络时间协议 69OAOffice Automation 办公自动化 70OTTotal Operating Time 总运营时间 71PCIProtocol Control Information 一种局部总线 72PCI X Peripheral Component Interconnect Extended 扩展的 PCI 73PeerPeer 端 74QAQuality Assurance 质量保证 75RAID Random Array of Inexpensive Disks 磁盘阵列 76RDBMSDatabase Management System 数据库管理系统 77RFRadio Frequency 射频 78RMONRemote Monitoring 远程监控 79RSERouting Switching Engine 路由交换引擎 80S WSoftware 软件 81SLEStation Level Equipment 车站现场设备 82SAMSecure Access Module 安全存取模块 83SANstorage area network 存储网络 84SNMP Simple Network Management Protocol 简单网络管理协议 85SCStation Computer system 车站计算机系统 86SCSI Small Computer System Interface 小型计算机接口 87STTotal Standby Time 总待机时间 11 序号缩写英文说明中文说明 88TCMTicket Checking Machine 自动查询机 89TCP IP Transmission Control Protocol Internet Protocol 传输控制协议 网际协议 90TFT LCD Thin Film Transistor Liquid Crystal Display 薄膜晶体管液晶显示器 91TomTransactions Per Minute 每分钟内系统处理的交易个数 92TVMTicket Vending Machine 自动售票机 93UPSUn interruptible Power Supply 不间断电源 94USBUniversal Serial Bus 通用串行总线 95VLANVirtual Local Area Network 虚拟局域网 96VRRP Virtual Router Redundancy Protocol IETF 虚拟路由器冗余协议 97 10 100 Base FX 10 100Base FX 10 100Base FX 标准 98Usecase viewUsecase view 99 Implementation view Implementation view 100Activity viewActivity view 101Class viewClass view 102 UMLUnified Modeling Language 1 5 参考资料 此软件架构文档引用文件如下 计算机软件开发规范 GB8566 88 计算机软件产品开发文件编制指南 GB T 8567 2003 12 计算机软件需求说明编制指南 GB9385 88 计算机软件测试文件编写规范 GB9386 88 计算机软件可靠性及可维护性管理 GB T14394 1993 计算机软件质量保证计划规范 GB T12504 1990 计算机软件配置管理计划规范 GB T12505 1990 计算机软件测试文件编制规范 GB T9386 1988 软件维护指南 GB T14079 1993 软件文档管理指南 GB T16680 1996 软件质量评价 ISO IEC 14589 2 2 系统逻辑结构系统逻辑结构 本章描述系统的总体逻辑结构 包括组件 子系统 的划分与依赖关系定义 组件之间的接口定 义 系统功能在组件之间的实现流程 组件功能定义 2 1 总体结构 本节定义系统的总体逻辑结构 定义组件划分以及组件之间的依赖关系 为了能够使系统具有较好的可重用性以及能够控制对第三方系统的依赖性 如第三方系统软件 中间件等 在结构设计时可以采用分层方法 系统可以分为专用应用层 通用应用层 中间件层 系统软件层 为了统一与便于理解 当用图形化表示组件 子系统 组件之间的依赖关系时 要求采用 UML 的符号与表示方法 2 2 系统功能实现 针对 产品需求说明书 中定义的功能特性 在此描述它们在相关组件 子系统 之间是如何实 现的 系统功能实现描述是定义组件之间的接口以及组件功能的基础 选择若干代表性的用例来说明 在此要求用两种方式来描述功能实现 13 1 UML 的顺序图 2 对顺序图的文字解释 需要注意的是 UML 顺序图中的生命线代表组件 子系统 产品需求说明书 中各个功能特性 的数据流图或顺序图描述是此处设计的基础 2 3 组件接口 本节明确定义 各个组件之间的接口 系统内部接口 如果组件之间采用通信协议作为接口 则需要详细定义应用层协议以及低层通信方式 如果采用 API 作为接口 则需要详细定义 API 接口函 数 包括参数定义 系统的所有对外接口在 产品需求说明书 中明确定义 2 4 组件功能 本节明确定义各个组件的软件功能 其依据是 产品需求说明书 以及系统功能实现描述 本节 通常按照组件进行组织 2 4 1 组件 1 2 5 数据库关系模型 本节在逻辑层面上定义系统所包含的主体数据库模型 以及主要的实体关系 通常以 E R 图形 式来表现 14 pw card special cardid inouttype systemlist processrule relationlist fareruleno varchar 9 varchar 1 varchar 800 varchar 2 varchar 2000 varchar 4 pw card speciallist cardid cardidphysical cardtype tradedate dealtype registtype varchar 9 varchar 16 varchar 2 timestamp varchar 1 varchar 2 pw card speciallist batch cardidstart cardidend tradedate dealtype registtype operator varchar 9 varchar 9 timestamp varchar 1 varchar 2 varchar 6 pw card speciallist date listdate cardid cardidphysical dealtype timestamp varchar 9 varchar 16 varchar 1 pw card store cardid cardidface cardidphysical cardtype cardsn solddate foregift charge startdate enddate currentvalue point autoflag cardstatus updatedate varchar 9 varchar 9 varchar 16 varchar 2 integer timestamp integer integer timestamp timestamp integer integer varchar 2 varchar 2 timestamp pw fare basic basicplanno stationno1 stationno2 farebasic varchar 4 varchar 10 varchar 10 integer pw fare basicplan basicplanno basicplanname basicrule startprice unitprice units divideno varchar 4 varchar 40 varchar 2 integer integer integer varchar 4 pw fare cardtype cardtype cardtypename description foregift charge dateavailable mediatype cardstatus curvalue issuesn cardattrib varchar 2 varchar 40 varchar 100 integer integer integer varchar 2 varchar 2 integer integer varchar 2000 pw fare cardtype plan cardplanno cardtype cardattrib ruleplanno pointplanno varchar 4 varchar 2 varchar 2000 varchar 4 varchar 4 pw fare continuousrule ruleid priorsystemid priorfareplan mininterval maxinterval cardtyperule varchar 4 varchar 9 varchar 4 integer integer varchar 2000 pw fare plan fareplanno fareplanname faretype basicplanno cardplanno varchar 4 varchar 40 varchar 2 varchar 4 varchar 4 pw info station stationno stationname description lines stationtype road longitude latitude direction varchar 10 varchar 40 varchar 100 varchar 200 varchar 20 varchar 20 numeric 8 5 numeric 8 5 char pw info station divide divideno serialno stationno edge varchar 4 integer varchar 10 varchar 1 pw info station relation divideno stationno1 stationno2 normalridetime distance others1 others2 varchar 4 varchar 10 varchar 10 integer integer varchar 40 varchar 40 td autoadd download cardid cardtype tradetype startterminal endterminal autoflag status confirmation receivedate tradedate varchar 9 varchar 2 varchar 2 varchar 9 varchar 9 varchar 2 varchar 2 varchar 1 timestamp timestamp td autoadd regist cardid tradetype tradedate receivedate bankid bankaccount autoflag confirmation terminalid varchar 9 varchar 2 timestamp timestamp varchar 8 varchar 30 varchar 2 varchar 1 varchar 9 td changepin cardid tradetype tradedate receivedate oldpin newpin varchar 9 varchar 2 timestamp timestamp varchar 16 varchar 16 td charge cardid tradetype tradedate terminalid receivedate chargetype memo varchar 9 varchar 2 timestamp varchar 9 timestamp varchar 2 varchar 30 td clearflag cardid tradetype tradedate receivedate startflag startdate startaddress startterminal varchar 9 varchar 2 timestamp timestamp integer timestamp varchar 10 varchar 9 td common cardid cardtype tradetype tradeaddress tradedate terminalid operator trademoney tradevalue currentvalue foregift charge cardsn terminalsn terminalsum tac receivedate tradesn receivesn startdate startaddress startterminal dataresource varchar 9 varchar 2 varchar 2 varchar 10 timestamp varchar 9 varchar 6 integer integer integer integer integer integer integer integer varchar 8 timestamp integer integer timestamp varchar 10 varchar 9 varchar 1 td common bak cardid cardtype tradetype tradedate terminalid operator trademoney cardsn state receivedate varchar 9 varchar 2 varchar 2 timestamp varchar 9 varchar 6 integer integer varchar 6 timestamp td common print cardid tradetype tradedate PrintMemo varchar 9 varchar 2 timestamp varchar 2000 td customer cardid cardtype tradedate receivedate customername sex customerid idtype pin addressphone varchar 9 varchar 2 timestamp timestamp varchar 16 varchar 1 varchar 20 varchar 2 varchar 16 varchar 100 td exchange tradetype tradeaddress tradedate terminalid operator receivedate terminalsn orgcurrency orgamt exchangerate curcurrency curamt varchar 2 varchar 10 timestamp varchar 9 varchar 6 timestamp integer varchar 3 integer varchar 8 varchar 3 integer td fareend cardid tradetype tradedate receivedate farebasic startdate startaddress startterminal varchar 9 varchar 2 timestamp timestamp integer timestamp varchar 10 varchar 9 td log cardid tradetype tradedate commandid tradecontent terminalid operator varchar 9 varchar 2 timestamp varchar 3 varchar 4000 varchar 9 varchar 6 td lose return cardid tradetype tradedate receivedate customername sex idtype customerid pin varchar 9 varchar 2 timestamp timestamp varchar 16 varchar 1 varchar 2 varchar 20 varchar 16 td refund cardid tradetype tradedate receivedate customername sex idtype customerid pin startdate enddate autoflag point varchar 9 varchar 2 timestamp timestamp varchar 16 varchar 1 varchar 2 varchar 20 varchar 16 timestamp timestamp varchar 2 integer td refund download cardid cardidface cardtype tradetype selection tradevalue currentvalue foregift charge customername sex idtype customerid pin addressphone startdate enddate autoflag point startterminal endterminal status confirmation receivedate tradedate varchar 9 varchar 9 varchar 2 varchar 2 varchar 1 integer integer integer integer varchar 16 varchar 1 varchar 2 varchar 20 varchar 16 varchar 100 timestamp timestamp varchar 2 integer varchar 9 varchar 9 varchar 2 varchar 1 timestamp timestamp td sell cardid tradetype tradedate receivedate startdate enddate varchar 9 varchar 2 timestamp timestamp timestamp timestamp td transfer cardid tradetype tradedate receivedate bankid bankaccount bankcardid bankauthen checkflag checkmeno varchar 9 varchar 2 timestamp timestamp varchar 8 varchar 30 varchar 20 varchar 40 char varchar 255 tx command command id command name command type data type priority resend time valid time content explain length varchar 3 varchar 40 varchar 3 varchar 1 varchar 1 integer integer varchar 2000 varchar 1000 integer tx command content command id seq no segment name segment len segment type sample content varchar 3 integer varchar 255 integer varchar 2 varchar 255 varchar 255 tx ole ole id src addr dest addr occur time ole type status content len if process operator ole content processway processtime varchar 40 varchar 16 varchar 16 timestamp varchar 10 varchar 1 integer varchar 1 varchar 6 long binary char timestamp tx recv row id row id0 command id arrv time aspect src addr add addr dest addr status content numeric 10 numeric 10 varchar 3 timestamp varchar 1 varchar 16 varchar 16 varchar 32 varchar 1 varchar 4000 tx recv bak row id row id0 command id arrv time aspect src addr add addr dest addr status content numeric 10 numeric 10 varchar 3 timestamp varchar 1 varchar 16 varchar 16 varchar 32 varchar 1 varchar 4000 tx recv bak0 row id row id0 command id arrv time aspect src addr add addr dest addr status content if reprocess numeric 10 numeric 10 varchar 3 timestamp varchar 1 varchar 16 varchar 16 varchar 32 varchar 1 varchar 4000 varchar 1 tx send row id row id0 command id born time send time resend time valid time aspect add addr dest addr status content numeric 10 numeric 10 varchar 3 timestamp timestamp integer integer varchar 1 varchar 16 varchar 16 varchar 1 varchar 4000 tx send bak row id row id0 command id born time send time resend time valid time aspect add addr dest addr status content numeric 10 numeric 10 varchar 3 timestamp timestamp integer integer varchar 1 varchar 16 varchar 16 varchar 1 varchar 4000 tx send bak0 row id row id0 command id born time send time resend time valid time aspect add addr dest addr status content if reprocess numeric 10 numeric 10 varchar 3 timestamp timestamp integer integer varchar 1 varchar 16 varchar 16 varchar 1 varchar 4000 varchar 1 tx send temp row id row id0 command id born time send time resend time valid time aspect add addr dest addr status content numeric 10 numeric 10 varchar 3 timestamp timestamp integer integer varchar 1 varchar 16 varchar 16 varchar 1 varchar 4000 tz account list detail systemid seqno subseqno operatortype class1 class2 status class3 differnum tradenum remainsum differmoney trademoney remainmoney operator relationer co systemid operatordate sendupflag varchar 9 varchar 10 varchar 2 varchar 2 varchar 2 varchar 20 varchar 1 varchar 20 integer integer integer integer integer integer varchar 6 varchar 6 varchar 9 timestamp varchar 1 tz account stock systemid class1 class2 status differnum tradenum remainsum differmoney trademoney remainmoney operator operatordate varchar 9 varchar 2 varchar 20 varchar 1 integer integer integer integer integer integer varchar 6 timestamp wh coding content coding code content class1 class2 class3 varchar 100 varchar 255 varchar 2000 varchar 2000 varchar 2000 varchar 2000 wh coding list coding coding name coding type memo if update coding len varchar 100 varchar 100 varchar 20 varchar 255 varchar 1 numeric 10 wh function function id function name subsystem help seqno help title help file memo grade right varchar 40 varchar 100 varchar 10 varchar 10 varchar 100 varchar 100 varchar 2000 varchar 20 wh operate log system id operatedate operateid operatorid operatorname operateaddress operatecontent sendup varchar 9 timestamp varchar 40 varchar 20 varchar 20 varchar 255 varchar 255 varchar 1 wh system parameter param id param content param type system type memo if updown if update varchar 40 varchar 2000 varchar 20 varchar 255 varchar 255 varchar 1 varchar 1 wh user user id user name password grade sex dept id cardid cardidphysical classid property varchar 20 varchar 40 varchar 10 varchar 10 varchar 40 varchar 20 varchar 20 varchar 40 varchar 1 varchar 255 wh user trace seq no user id network add type id system id function id enter time exit time numeric 10 varchar 20 varchar 40 varchar 2 varchar 20 varchar 40 timestamp timestamp yy equipment system id equipment id equipment name species id comm parent id coordinate aspect net id default mode recently state state update time authentic type if dynamic ip if use parameter groupid varchar 9 varchar 9 varchar 40 varchar 2 varchar 9 varchar 40 varchar 40 varchar 255 varchar 255 varchar 255 timestamp varchar 1 varchar 1 varchar 1 varchar 2000 varchar 20 yy equipment state log equipment id operatedate globalstateinf stateinf receivedate sendup varchar 9 timestamp varchar 20 varchar 2000 timestamp varchar 1 yy species species id species name default protocol default state default mode flag default map explain default file transmit parameter varchar 2 varchar 40