软件架构设计说明书完整版

软件架构设计说明书

HEN system office room 【HEN16H-HENS2AHENS8Q8-HENH1688】

架构设计说明书

版本1.0.0

签署栏

拟制

审核

修订历史

版本

说明

发布

作者

Dick

审核

修订日期

批准

目录

1. 引言

[对于由多个进程构成的复杂系统，系统设计阶段可以分为：架构设计（构架设计）、组件高层设计、组件详细设计。对于由单个进程构成的简单系统，系统设计阶段可以分为：系统概要设计、系统详细设计。本文档适用于由多个进程构成的复杂系统的构架设计。]

[架构设计说明书是软件产品设计中最高层次的文档，它描述了系统最高层次上的逻辑结构、物理结构以及各种指南，相关组件（粒度最粗的子系统）的内部设计由组件高层设计提供。]

[系统：指待开发产品的软件与硬件整体，其软件部分由各个子系统嵌套组成，子系统之间具有明确的接口；

组件：指粒度最粗的子系统；

模块：指组成组件的各层子系统，模块由下一层模块或函数组成；]

[此文档的目的是：

1）

2）

3）

描述产品的逻辑结构，定义系统各组件（子系统）之间的接口以及每个组件（子系统）应该实现的功能；

定义系统的各个进程以及进程之间的通信方式；

描述系统部署，说明用来部署并运行该系统的一种或多种物理网络（硬件）配置。对于每种配置，应该指出执行该系统的物理节点（计算机、网络设备）配置情况、节点之间的连接方式、采用何种通信协议、网络带宽。另外还要包括各进程到物理节点的映射；

4）

5）

系统的整体性能、安全性、可用性、可扩展性、异常与错误处理等非功能特性设计；

定义该产品的各个设计人员应该遵循的设计原则以及设计指南，各个编程人员应该遵循的编码规范。

]

[建议架构设计工程师与组件设计工程师共同完成此文档。]

[架构设计说明书的引言应提供整个文档的概述。它应包括此文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。]

1.1 目的

[简要描述体系结构文档的目的。]

1.2 范围

[简要说明此文档的范围：它的相关项目以及受到此文档影响的任何其它事物]

1.3 预期的读者和阅读建议

[说明此文档的阅读对象，简要说明此文档中其它章节包含的内容与文档组织方式，对于不同读者的阅读方式建议。

如：

目标读者是系统最终用户、系统分析员、项目经理、产品经理、市场人员等。

此文档的第2章描述…..]

本项目的组织架构和参与人员如下：

A． 项目负责人：

参与开发策划，负责批准项目开发计划书；

安排项目组成人员

从技术和业务上总体把握；

确定项目进度及检验标准

了解开发中存在问题，并及时制定相应对策。

B． 技术总协调：

负责制订软件标准。

负责支撑软件的维护。

评估将在其中部署项目最终产品的目标组织的情况。

协调目标组织的建模工作。

在必要时对业务工程工作进行讨论和协调。

对目标组织中所建议的任何变更进行成本效益分析。

C． 系统分析、设计：

负责获取用户最终需求，概括系统的功能和界定系统来领导和协调需求获取及用例建模，编写《XXX新版本软件详细设计》，制订命名规范。

软件构架设计，划分子模块并详细描述各模块功能、要求,和测试要点。

对软件架构中重要的类做详细说明，描述其属性、方法、和相互之间的关系。

数据库设计，包括定义表、索引、视图、约束条件、触发器、存储过程等。

D． 软件开发：

严格按照软件详细设计说明，负责自己开发的模块的资料、软件的备份及保管工作。

在软件开发中如发现系统分析设计时漏洞提出异议，提交问题报告至项目负责人。

对各自编写的内容相互交换作单元测试。

负责《用户使用手册》的编写。

E． 文档编写：

负责编写软件《详细设计说明书》、《数据库设计说明书》、《测试方案文档》。

F． 软件测试：

负责对各模块的集成测试，和软件的整体评估测试，在测试完后负责编写《测试报告》。

1.4 术语、首字母缩写

序号

1

2

3

4

5

6

7

8

缩写

ACC

ACL

ACPI

AFC

AGM

ALDT

ALU

ASA

英文说明

AFC Clearing Center

Access Control List

Advanced Configuration and

Power Interface

Automatic Fare Collection

Automatic Gate Machine

Administrative and Logistics

Down Time

Arithmetic Logic Unit

Adaptive Security Algorithm

中文说明

AFC清算管理中心

访问控制列表

先进的配置和电源接口

自动售检票

自动检票机

行政和后勤响应时间

算术逻辑部件

适应的安全算法

序号

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

缩写

AVM

BCD

BIOS

MAC

BOM

CPU

CRC

DAT

DB

DBA

DDL

DDS

DES

Default

Gateway

DMZ

DoS

DRP

DSCP

E/S

EB

ECC

英文说明

Add Value Machine

Binary Code Decimal

Basic Input-Output System

Municiple Administration &

Communication Card Co.

Booking Office Machine

Central Processing Unit

Cyclic Redundancy Check

Digital Audio Tape

Database

Database Administrator

Data Definition Language

Digital Data Storage

Data Encryption Standard

Default Gateway

De-militarised zone

Denial of Service

Dynamic Routing Protocol

Differentiated Services Code

Point

Encoder/Sorter Machine

Emergency Button

Error Checking and Correcting

中文说明

自动充值机

BCD码指每位十进制数用4位二进制数编码表示的方法

微机的基本输入输出系统

市政交通一卡通

半自动售票机

中央处理器

循环冗余校验

数字音频磁带

数据库

数据库管理员

数据定义语言

数字数据存储

数据加密标准

默认网关

非军事区

拒绝服务

动态路由协议

区分服务代码

车票编码分拣机

紧急按钮

错误检查校正

序号

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

缩写

ECU

EEPROM

EMC

EnG

ExG

Fail-Over

FC-AL

FCSW

FDD

GUI

H/W

HA

HD

HDD

Hot Standby

Unit

I/O

ID

IDE

ISA

Kbps

KMS

LAN

英文说明

Equipment Control Unit

Electrically Erasable

Programmable Read-Only Memory

Electromagnetic Campatibility

Entry Gate

Exit Gate

Fail-Over

Fibre Channel Arbitrated Loop

Fiber Channel Switch

Floppy Disk

Graphical User Interface

Hardware

High Availability

Hard Disk

Hard Disk Drive

Hot Standby Unit

Input/Output

Identification

Integrated Drive Electronics

Industry Standard Architecture

Kilo (thousand) bits per

second

Key Management System

Local Area Network

中文说明

设备的主要控制单元

电可擦除只读内存

电磁兼容性

进站自动检票机

出站自动检票机

容错

光纤通道仲裁环

光纤通道交换机

软盘

图形用户接口

硬件

高可用性

硬盘

硬盘驱动器

热备份单元

输入/输出

身份

IDE 接口

工业标准结构总线

千比特/秒（速率）

密钥管理系统

局域网

序号

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

缩写

LCD

LC

LCS

LED

LTO

MAC

MAK

Mbps

MCBF

MCU

MHz

MTBF

MTTR

N/W

NIC

NMS

NTP

OA

OT

PCI

PCI-X

Peer

QA

RAID

英文说明

Liquid Crystal Display

Line Center

Line Computer System

Low Emitting Diode

Linear Tape Open

Message Authentication Code

Memory Access Key

Mega (Million) bits per second

Mean-Cycles Between Failure

Main Control Unit

Mega Hertz

Mean-Time Between Failure

Mean Time To Repair

Network

Network Interface Card

Network Management System

Network Time Protocol

Office Automation

Total Operating Time

Protocol Control Information

Peripheral Component

Interconnect Extended

Peer

Quality – Assurance

Random Array of Inexpensive

中文说明

液晶显示器

线路中央计算机系统

线路计算机系统

发光二极管

线性磁带开放协议

消息认证码

内存存取密钥

兆比特/秒（速率）

平均无故障时间

主控单元

兆赫兹（频率）

平均无故障时间

平均故障恢复维修时间

网络

网络接口卡

网络管理系统

网络时间协议

办公自动化

总运营时间

一种局部总线

扩展的PCI

端

质量保证

磁盘阵列

序号 缩写 英文说明

Disks

中文说明

76

77

78

79

80

81

82

83

84

85

86

87

88

89

RDBMS

RF

RMON

RSE

S/W

SLE

SAM

SAN

SNMP

SC

SCSI

ST

TCM

TCP/IP

Database Management System

Radio Frequency

Remote Monitoring

Routing Switching Engine

Software

Station Level Equipment

Secure Access Module

storage area network

Simple Network Management

Protocol

Station Computer system

Small Computer System

Interface

Total Standby Time

Ticket Checking Machine

Transmission Control

Protocol/Internet Protocol

Thin Film Transistor-Liquid

Crystal Display

Transactions Per Minute

Ticket Vending Machine

Un-interruptible Power Supply

Universal Serial Bus

Virtual Local Area Network

数据库管理系统

射频

远程监控

路由交换引擎

软件

车站现场设备

安全存取模块

存储网络

简单网络管理协议

车站计算机系统

小型计算机接口

总待机时间

自动查询机

传输控制协议/网际协议

90

91

92

93

94

95

TFT-LCD

Tom

TVM

UPS

USB

VLAN

薄膜晶体管液晶显示器

每分钟内系统处理的交易个数

自动售票机

不间断电源

通用串行总线

虚拟局域网

序号

96

缩写

VRRP

10/100

英文说明

Virtual Router Redundancy

Protocol (IETF)

10/100Base-FX

中文说明

虚拟路由器冗余协议

97

Base-FX

98

99

100

101

102

Usecase view

Implementation

view

Activity view

Class view

UML

10/100Base－FX标准

Usecase view

Implementation view

Activity view

Class view

Unified Modeling Language

1.5 参考资料

此软件架构文档引用文件如下：

《计算机软件开发规范》 GB8566-88

《计算机软件产品开发文件编制指南》 GB/T 8567-2003

《计算机软件需求说明编制指南》 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.1 总体结构

[本节定义系统的总体逻辑结构，定义组件划分以及组件之间的依赖关系。

为了能够使系统具有较好的可重用性以及能够控制对第三方系统的依赖性（如第三方系统软件、中间件等），在结构设计时可以采用分层方法。系统可以分为专用应用层、通用应用层、中间件层、系统软件层。

为了统一与便于理解，当用图形化表示组件（子系统）、组件之间的依赖关系时，要求采用UML的符号与表示方法。

]

2.2 系统功能实现

[针对《产品需求说明书》中定义的功能特性，在此描述它们在相关组件（子系统）之间是如何实现的，系统功能实现描述是定义组件之间的接口以及组件功能的基础，选择若干代表性的用例来说明。在此要求用两种方式来描述功能实现：

1） UML的顺序图；

2） 对顺序图的文字解释

需要注意的是UML顺序图中的生命线代表组件（子系统）。《产品需求说明书》中各个功能特性的数据流图或顺序图描述是此处设计的基础。]

2.3 组件接口

[本节明确定义：各个组件之间的接口（系统内部接口）。如果组件之间采用通信协议作为接口，则需要详细定义应用层协议以及低层通信方式。如果采用API作为接口，则需要详细定义API接口函数（包括参数定义）。]

[系统的所有对外接口在《产品需求说明书》中明确定义。]

2.4 组件功能

[本节明确定义各个组件的软件功能，其依据是《产品需求说明书》以及系统功能实现描述。本节通常按照组件进行组织。

2.4.1 组件1

]

2.5 数据库关系模型

[ 本节在逻辑层面上定义系统所包含的主体数据库模型，以及主要的实体关系，通常以E-R图形式来表现。]

3. 系统物理实现

[本章明确定义各个组件的可执行程序名与库名、可执行程序与库的运行环境。可以采用如下表的方式来描述（一个组件包含一个可执行程序与多个库）。这是下一步设计与开发的分工依据。

组件名 可执行程序/库名 运行环境

组件1

定义系统包含的所有进程、每个进程包含的可执行程序名与库名、可执行程序与库的运行环境。。可以采用如下表的方式来描述（一个进程包含一个可执行程序与多个库，与组件不同的是，进程间可以包含相同的库）。这是实际环境运行反映，也是系统部署的依据。

进程名 进程运行方式

[说明进程是以控制台、Windows服务程序、Unix后台进程或者其它方式运行]

可执行程序/库名 运行环境

进程1

]

4. 系统部署

[本章描述系统部署，说明用来部署并运行该系统的一种或多种物理网络（硬件）配置。对于每种配置，应该指出执行该系统的物理节点（计算机、网络设备）配置情况（包括硬件、操作系统、支撑软件）、节点之间的连接方式、采用何种通信协议、网络带宽。另外还要包括各进程到物理节点的映射。]

5. 系统其它考虑

[本章描述系统的整体性能、安全性、可用性、可扩展性、异常与错误处理等非功能特性设计。]

5.1 系统可扩展性

[描述系统可扩展性设计与实现方案。需要对性能、功能、网管/审计、报表的可扩展性进行描述。]

5.2 系统可靠性

[描述系统可靠性设计与实现方案，包括系统的可靠性设计，有硬件可用性与软件可用性两个方面。]

5.3 系统性能

[描述系统性能设计与实现方案。]

5.4 系统维护性

[描述系统可维护性设计与实现方案。]

5.5 系统安全

[描述系统安全性设计与实现方案。系统安全性包括网络安全、系统安全、数据安全、交易安全等。]

5.6 系统异常处理

[给出系统中的错误类别，以及各类错误的处理要求。同时对系统中的各个组件的错误异常的处理提出具体的要求。]

6. 约束

[本章给出设计人员与编码人员必须遵循的设计要求与编码要求，包括各种代码的命名、配置文件、日志文件格式定义。可以通过引用的方式来写本章节。研开中心将会提供几种主要语言的编码规范，在此可以引用。]

6.1 设计指南

[规定在组件设计中的各种约定与标准。]

6.2 编码规范

[规定在系统实现中必须遵循的编码规定，包括编码风格、变量与函数命名、注释等。]

6.3 配置文件约定

[规定系统的所有配置文件命名方式与格式。]

6.4 日志文件约定

[规定系统的所有日志文件命名方式与格式。]

6.5 运行目录约定

[规定系统的运行目录结构。]

7. 需求矩阵

序号

1

2

需求来源

Requirement

设计 Priority

3