系统架构设计说明书模板

系统架构设计说明书模板 错误～未指定书签。xx系统架构设计说明书 文档编号 版本 A1 密级 商密A Xx系统 软件研发部 项目名称 项目来源 QR-RD-035(V1.0) Xx系统 架构设计说明书 (内部资料 请勿外传) 编 写: 日 期: 检 查: 日 期: 审 核: 日 期: 批 准: 日 期: 聚融鑫科科技有限公司 版权所有 不得复制 内部使用 第 1 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 文档变更记录 序号 变更(+/-)说明 作者 版本号 日期 批准 1 2 内部使用 第 2 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 目 录 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 系统数据流 .................................................................................错误～未定义书签。13 3.2.2 系统状态机 .................................................................................错误～未定义书签。15 3.2.3 系统部署图 .................................................................................错误～未定义书签。15 4、 运行设计 .......................................................................................................................................... 12 4.1 进程/任务的设计 ...................................................................................................................... 12 内部使用 第 3 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 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 内部使用 第 4 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 1、 引言 描述本文的参考依据、资料以及大概内容。 1.1 背景 项目产生或者开发背景，必要性等。 1.2 术语和缩略语 缩略语、系统主用名词、术语等解释 1.3 参考资料 编写本文和阅读本文是需要查阅的资料有关文档，注明出处、作者和版本。 (架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系) 2、 范围 2.1 软件名称 英文名称:TopEng-CSP 中文名称:客户服务平台 2.2 软件功能 请参考《XXX子系统 软件需求规格说明书.doc》 2.3 软件应用 请参考《系统 软件需求规格说明书.doc》 2.4 需求边界 明确范围边界，做什么，不做什么。 内部使用 第 5 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 3、 总体设计 3.1 架构设计目标和约束 架构设计总体目标和一些有关架构方面的约束，比如技术约束或者设计上约束。 3.1.1 运行环境 序号 项目 详细信息 后台软件环境 Linux, JRE1.6以上 Tomcat5.5容器, mysql4.0/以上 前台软件环境 Windows XP, Windows 2000， windows vista 数据库 3.1.2 开发环境 序号 项目 详细信息 1 操作系统 开发编译系统:JDK 1.6, 操作系统: windows系列 2 编程语言 JAVA、Java Javascript、HTML、CSS 3 Eclipse 3.4 编程工具 4 100M Ethernet 网络平台 3.2 设计思想 阐明进行架构设计的思想，可参考一些架构设计的模式，需结合当前系统的实际情况而定。 3.3 架构体系 根据架构分析和设计思想产生系统的架构图，并对架构图进行描述，说明分层的原因、层次 的职责，并根据架构图绘制系统的物理部署图，描述系统的部署体系。 内部使用 第 6 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 应用 客户端浏览器 数据提供层 数据记录文件 数据库文件系统 3.4 重要业务流程(有多少个就写多少个流程图) 流程图类型不做严格要求，只要图和描述表达设计思想即可;重要业务流程数据流向等。 3.4.1 流程1 3.4.2 流程2 3.4.3 流程3 3.5 模块划分 根据架构图进行模块的划分并阐明模块划分的理由，绘制模块物理图以及模块依赖图。 有多少模块就写多少个模块 内部使用 第 7 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 3.5.1 模块一 3.5.1.1 模块一描述 根据模块物理图描述各模块的职责，并声明其对其他模块的接口要求。 这是本系统中的上层应用，包括提供各种功能的插件以及用户界面，主要为用户提供输 入条件和输出结果，也就是查询条件的输入和数据展示，也包括基本数据的录入和管理功 能，由如下的插件应用构成， 子模块 描述 实时监控插件 负责提供实时监控功能 3.5.1.2 模块一业务流程说明 图+文字描述。样例; 内部使用 第 8 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 3.5.1.3 模块一接口设计 对模块接口进行设计，并提供一定的伪代码。 3.5.2 模块二 3.5.2.1 模块二描述 根据模块物理图描述各模块的职责，并声明其对其他模块的接口要求。 这是本系统中的上层应用，包括提供各种功能的插件以及用户界面，主要为用户提供输 入条件和输出结果，也就是查询条件的输入和数据展示，也包括基本数据的录入和管理功 能，由如下的插件应用构成， 子模块 描述 实时监控插件 负责提供实时监控功能 3.5.2.2 模块二业务流程说明 图+文字描述。样例; 内部使用 第 9 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 3.5.2.3 模块二接口设计 对模块接口进行设计，并提供一定的伪代码。 4、 接口设计 对场景以及问题域进行分析，构成系统的架构级设计，阐明对于系统的分层思想。 4.1 系统外部接口 4.1.1 数据库接口 本系统未使用数据库连接池技术，但软件中存在Apache Dbcp 数据库连接池JAR包 , 后台服务采用JDBC连接MYSQL数据库，由于本系统存在多个数据库，每活动线程最多拥 有一个数据库连接，外部请求在使用完成后不需要显式关闭。 内部使用 第 10 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 4.1.2 第三方接口 4.1.3 通信接口 4.2 系统内部接口 , 应用子系统 这是本系统中的上层应用，包括提供各种功能的插件以及用户界面，主要为用户提供输 入条件和输出结果，也就是查询条件的输入和数据展示，也包括基本数据的录入和管理功 能，由如下的插件应用构成， 模块 描述 实时监控插件 负责提供实时监控功能 虚拟身份插件 负责提供真实/虚拟身份的查询，轨迹查询的功能 案件管理插件 负责提供对案件的管理和报警等功能 线索分析插件 负责提供同时上下机查询，碰撞分析和CCIC库管理等功能 情报分析插件 负责提供对内容的查询和QQ好友分析等功能 实名登记插件 负责提供对实名登记查询和违规卡的管理功能 场所管理插件 负责提供对上网场所的管理和运行状态综合统计信息等功能 系统管理插件 负责完成整个系统的管理，包括用户密码，和基本数据的管理功 能 , 后台子系统 相对与应用插件，后台数据子系统的主要功能是接受来自插件应用的请求，并为请求提 供实际操作功能。 模块 描述 实时监控后台 负责提供实时监控 虚拟身份后台 负责提供真实/虚拟身份的查询，轨迹查询的功能 案件管理后台 负责提供对案件的管理和报警等功能 线索分析后台 负责提供同时上下机查询，碰撞分析和CCIC库管理等功能 实名登记后台 负责提供对实名登记查询和违规卡的管理功能 场所管理后台 负责提供对上网场所的管理和运行状态综合统计信息等功能 系统管理后台 负责完成整个系统的管理，包括用户密码，和基本数据的管理功 内部使用 第 11 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 能 , 文本分析子系统 负责对协议文本文件的索引，包括IM聊天记录文件，POST内容记录文件等的索引和查 询功能 模块 描述 文本索引模块 负责提供对文本文件的索引，采用LUCENCE技术 索引查询模块 负责提供对内容的查询和QQ好友分析等功能 , 配置中心子系统 配置中心子系统负责为后台服务和客户端配置文件的配置提供GUI的配置途径 5、 运行设计 本系统在设计时为了保证客户端的响应动态响应前台的请求而动态生成任务外，同时启动多 个后台服务。 5.1 进程/任务的设计 5.1.1 前台RCP客户端 取客户端配置放内存(经配置可以使用JAR包XML配置文件而省略这一步) 删除 5.1.2 后台系统 对于多表查询，使用任务方式委托JDK线程池对不同表进行查询。 整个后台服务初始完成以后，将生成以下任务(或线程)，此任务为单一线程，并未做线程 池并发处理，任务线程串行处理任务 5.2 数据存储 5.2.1 数据库模型 重要数据模型 5.2.2 文件 系统用文件系统结果、接口等。 内部使用 第 12 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 5.2.3 系统参数 配置参数、环境参数等 datasource.config 数据源列表 serverlist.config 报警的服务器列表 system-id 自识别的城市ID 5.2.4 其它数据 内存等 5.3 出错处理 本章节应列出出错原因及提示信息 6、 特性设计 特性设计可以根据产品用途、行业标准等实际情况对章节进行调整。 6.1 性能 描述系统常态下系统要求，重要有代表业务性能指标。以及在架构设计中保证性能， 方案 气瓶 现场处置方案 .pdf气瓶 现场处置方案 .doc见习基地管理方案.doc关于群访事件的化解方案建筑工地扬尘治理专项方案下载 和 设计要求 6.1.1 规模分析与实现 6.1.2 性能分析与实现 6.1.3 内存占用 6.1.4 响应速度要求 6.2 可靠性 标准是72小时无故障。例如为保证72小时，在故障处理设计实现方式、要求等。还有异常 处理 6.3 安全性 用户和权限管理、数据范围权限的控制、通讯是否加密，加密方式强度和要求，防止数据篡 改、攻击等 内部使用 第 13 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 6.4 可维护性 实施、系统升级等，包括可移植性、可修改性、可扩充性 7、 部署 7.1 部署模式 7.1.1 部署方式一 部署硬件、网络等详细要求，提供部署图。 数据库服务器1-3 配置中心内容服务器p2p服务器后台服务器 内部使用 第 14 页 共 15 页 错误～未指定书签。xx系统架构设计说明书 7.1.2 部署方式二 7.2 许可协议 许可协议方式和版权加密控制方式。 8、 附录 内部使用 第 15 页 共 15 页