（完整word版）系统架构设计说明书模板

Xx系统

架构设计说明书

(内部资料请勿外传)

编写：⽇期：检查：⽇期：审核：⽇期：批准：⽇期：

XXXX科技有限公司

版权所有不得复制

⽂档变更记录

⽬录

1、引⾔ (5)

1.1 背景 (5)

1.2 术语和缩略语 (5)

1.3 参考资料 (5)

2、总体设计 (6)

2.1 需求规定 (5)

2.2 架构设计⽬标和约束 (6)

2.2.1 运⾏环境 (6)

2.2.2 开发环境 (6)

2.3 设计思想 (6)

2.4 架构体系 (6)

2.5 重要业务流程 (7)

2.5.1 流程1 (7)

2.5.2 流程2 (7)2.5.3 流程3 (7)

2.6 模块划分 (7)

2.6.1 模块⼀ (8)

2.6.2 模块⼆ (9)

3、接⼝设计 (9)

3.1 系统外部接⼝ (10)

3.1.1 数据库接⼝ (10)

3.1.2 第三⽅接⼝ (11)

3.1.3 通信接⼝ (11)

3.2 系统内部接⼝ (11)

3.2.1 系统数据流.................................................................................... 错误！未定义书签。

3.2.2 系统状态机.................................................................................... 错误！未定义书签。

3.2.3 系统部署图.................................................................................... 错误！未定义书签。

4、运⾏设计 (12)

4.1 进程/任务的设计 (12)

4.1.1 前台RCP客户端 (12)

4.1.2 后台系统 (12)

4.2 数据存储 (12)

4.2.1 数据库模型 (12)

4.2.2 ⽂件 (12)

4.2.3 系统参数 (13)

4.2.4 其它数据 (13)

4.3 出错处理 (13)

5、特性设计 (13)

5.1 性能 (13)

5.1.1 规模分析与实现 (13)

5.1.2 性能分析与实现 (13)

5.1.3 内存占⽤ (13)

5.1.4 响应速度要求 (13)

5.2 可靠性 (13)

5.3 安全性 (13)

5.4 可维护性 (14)

6、部署 (14)

6.1 部署模式 (14)

6.1.1 部署⽅式⼀ (14)6.1.2 部署⽅式⼆ (15)

6.2 许可协议 (15)

7、附录 (15)

1、引⾔

描述本⽂的参考依据、资料以及⼤概内容。

1.1背景

项⽬产⽣或者开发背景，必要性等。

1.2术语和缩略语

缩略语、系统主⽤名词、术语等解释

1.3参考资料

编写本⽂和阅读本⽂是需要查阅的资料有关⽂档，注明出处、作者和版本。

(架构设计重点在于将系统分层并产⽣层次内的模块、阐明模块之间的关系) 2、范围2.1软件名称

英⽂名称：TopEng-CSP

中⽂名称：客户服务平台

2.2软件功能

请参考《XXX⼦系统软件需求规格说明书.doc》

2.3软件应⽤

请参考《系统软件需求规格说明书.doc》

2.4需求边界

明确范围边界，做什么，不做什么。

3、总体设计

3.1架构设计⽬标和约束

架构设计总体⽬标和⼀些有关架构⽅⾯的约束，⽐如技术约束或者设计上约束。3.1.1运⾏环境

开发环境

3.2设计思想

阐明进⾏架构设计的思想，可参考⼀些架构设计的模式，需结合当前系统的实际情况⽽定。

3.3架构体系

根据架构分析和设计思想产⽣系统的架构图，并对架构图进⾏描述，说明分层的原因、层次的职责，并根据架构图绘制系统的物理部署图，描述系统的部署体系。

3.4重要业务流程（有多少个就写多少个流程图）

流程图类型不做严格要求，只要图和描述表达设计思想即可;重要业务流程数据流向等。

3.4.1流程1

3.4.2流程2

3.4.3流程3

3.5模块划分

根据架构图进⾏模块的划分并阐明模块划分的理由，绘制模块物理图以及模块依赖图。

有多少模块就写多少个模块

3.5.1模块⼀

3.5.1.1模块⼀描述

根据模块物理图描述各模块的职责，并声明其对其他模块的接⼝要求。

这是本系统中的上层应⽤，包括提供各种功能的插件以及⽤户界⾯，主要为⽤户提供输⼊条件和输出结果，也就是查询条件的输⼊和数据展⽰，也包括基本数据的录⼊和管理功能，由如下的插件应⽤构成，

3.5.1.2业务流程说明

图+⽂字描述。样例;

3.5.1.3模块⼀接⼝设计

对模块接⼝进⾏设计，并提供⼀定的伪代码。

3.5.2模块⼆

3.5.2.1模块⼆描述

根据模块物理图描述各模块的职责，并声明其对其他模块的接⼝要求。

这是本系统中的上层应⽤，包括提供各种功能的插件以及⽤户界⾯，主要为⽤户提供输⼊条件和输出结果，也就是查询条件的输⼊和数据展⽰，也包括基本数据的录⼊和管理功能，由如下的插件应⽤构成，

3.5.2.2业务流程说明

图+⽂字描述。样例;

3.5.2.3模块⼆接⼝设计

对模块接⼝进⾏设计，并提供⼀定的伪代码。

4、接⼝设计

对场景以及问题域进⾏分析，构成系统的架构级设计，阐明对于系统的分层思想。

4.1系统外部接⼝

4.1.1数据库接⼝

本系统未使⽤数据库连接池技术，但软件中存在Apache Dbcp 数据库连接池JAR包

后台服务采⽤JDBC连接MYSQL数据库，由于本系统存在多个数据库，每活动线程最多拥有⼀个数据库连接，外部请求在使⽤完成后不需要显式关闭。

4.1.2第三⽅接⼝

4.1.3通信接⼝

4.2系统内部接⼝

●应⽤⼦系统

这是本系统中的上层应⽤，包括提供各种功能的插件以及⽤户界⾯，主要为⽤户提供输⼊条件和输出结果，也就是查询条件的输⼊和数据展⽰，也包括基本数据的录⼊和管理功能，由如下的插件应⽤构成，

相对与应⽤插件，后台数据⼦系统的主要功能是接受来⾃插件应⽤的请求，并为请求提供实际操作功能。

负责对协议⽂本⽂件的索引，包括IM聊天记录⽂件，POST内容记录⽂件等的索引和查询功能

配置中⼼⼦系统负责为后台服务和客户端配置⽂件的配置提供GUI的配置途径

5、运⾏设计

本系统在设计时为了保证客户端的响应动态响应前台的请求⽽动态⽣成任务外，同时启动多个后台服务。

5.1进程/任务的设计

5.1.1前台RCP客户端

取客户端配置放内存（经配置可以使⽤JAR包XML配置⽂件⽽省略这⼀步）

删除

5.1.2后台系统

对于多表查询，使⽤任务⽅式委托JDK线程池对不同表进⾏查询。

整个后台服务初始完成以后，将⽣成以下任务（或线程），此任务为单⼀线程，并未做线程池并发处理，任务线程串⾏处理任务

5.2数据存储

5.2.1数据库模型重要数据模型

5.2.2⽂件

系统⽤⽂件系统结果、接⼝等。

5.2.3系统参数

配置参数、环境参数等

datasource.config 数据源列表

serverlist.config 报警的服务器列表

system-id ⾃识别的城市ID

5.2.4其它数据

内存等

5.3出错处理

本章节应列出出错原因及提⽰信息

6、特性设计

特性设计可以根据产品⽤途、⾏业标准等实际情况对章节进⾏调整。

6.1性能

描述系统常态下系统要求，重要有代表业务性能指标。以及在架构设计中保证性能，⽅案和设计要求6.1.1规模分析与实现

6.1.2性能分析与实现

6.1.3内存占⽤

6.1.4响应速度要求

6.2可靠性

标准是72⼩时⽆故障。例如为保证72⼩时，在故障处理设计实现⽅式、要求等。还有异常处理

6.3安全性

⽤户和权限管理、数据范围权限的控制、通讯是否加密，加密⽅式强度和要求，防⽌数据篡改、攻击等6.4可维护性

实施、系统升级等，包括可移植性、可修改性、可扩充性7、部署

7.1部署模式

7.1.1部署⽅式⼀

部署硬件、⽹络等详细要求，提供部署图。

7.1.2部署⽅式⼆

7.2许可协议

许可协议⽅式和版权加密控制⽅式。

8、附录