系统架构设计说明书三篇.docx
- 文档编号:8643217
- 上传时间:2023-02-01
- 格式:DOCX
- 页数:20
- 大小:506.18KB
系统架构设计说明书三篇.docx
《系统架构设计说明书三篇.docx》由会员分享,可在线阅读,更多相关《系统架构设计说明书三篇.docx(20页珍藏版)》请在冰豆网上搜索。
系统架构设计说明书三篇
系统架构设计说明书三篇
篇一:
系统架构设计说明书
软件研发部
文档编号
版本
A1
密级
商密A
项目名称
Xx系统
项目来源
Xx系统
架构设计说明书
编写:
日期:
检查:
日期:
审核:
日期:
批准:
日期:
文档变更记录
序号
变更(+/-)说明
作者
版本号
日期
批准
1
2
1、引言
描述本文的参考依据、资料以及大概内容。
1.1背景
项目产生或者开发背景,必要性等。
1.2术语和缩略语
缩略语、系统主用名词、术语等解释
1.3参考资料
编写本文和阅读本文是需要查阅的资料有关文档,注明出处、作者和版本。
(架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系)
2、范围
2.1软件名称
英文名称:
TopEng-CSP
中文名称:
客户服务平台
2.2软件功能
请参考《XXX子系统软件需求规格说明书.doc》
2.3软件应用
请参考《系统软件需求规格说明书.doc》
2.4需求边界
3、明确范围边界,做什么,不做什么。
4、总体设计
4.1架构设计目标和约束
架构设计总体目标和一些有关架构方面的约束,比如技术约束或者设计上约束。
4.1.1运行环境
序号
项目
详细信息
后台软件环境
Linux,JRE1.6以上Tomcat5.5容器,mysql4.0/以上
前台软件环境
WindowsXP,Windows2000,windowsvista
数据库
4.1.2开发环境
序号
项目
详细信息
1
操作系统
开发编译系统:
JDK1.6,
操作系统:
windows系列
2
编程语言
JAVA、JavaJavascript、HTML、CSS
3
编程工具
Eclipse3.4
4
网络平台
100MEthernet
4.2设计思想
阐明进行架构设计的思想,可参考一些架构设计的模式,需结合当前系统的实际情况而定。
4.3架构体系
根据架构分析和设计思想产生系统的架构图,并对架构图进行描述,说明分层的原因、层次的职责,并根据架构图绘制系统的物理部署图,描述系统的部署体系。
4.4重要业务流程(有多少个就写多少个流程图)
流程图类型不做严格要求,只要图和描述表达设计思想即可;重要业务流程数据流向等。
4.4.1流程1
4.4.2流程2
4.4.3流程3
4.5模块划分
根据架构图进行模块的划分并阐明模块划分的理由,绘制模块物理图以及模块依赖图。
有多少模块就写多少个模块
4.5.1模块一
4.5.1.1模块一描述
根据模块物理图描述各模块的职责,并声明其对其他模块的接口要求。
这是本系统中的上层应用,包括提供各种功能的插件以及用户界面,主要为用户提供输入条件和输出结果,也就是查询条件的输入和数据展示,也包括基本数据的录入和管理功能,由如下的插件应用构成,
子模块
描述
实时监控插件
负责提供实时监控功能
4.5.1.2模块一业务流程说明
图+文字描述。
样例;
4.5.1.3模块一接口设计
对模块接口进行设计,并提供一定的伪代码。
4.5.2模块二
4.5.2.1模块二描述
根据模块物理图描述各模块的职责,并声明其对其他模块的接口要求。
这是本系统中的上层应用,包括提供各种功能的插件以及用户界面,主要为用户提供输入条件和输出结果,也就是查询条件的输入和数据展示,也包括基本数据的录入和管理功能,由如下的插件应用构成,
子模块
描述
实时监控插件
负责提供实时监控功能
4.5.2.2模块二业务流程说明
图+文字描述。
样例;
4.5.2.3模块二接口设计
对模块接口进行设计,并提供一定的伪代码。
5、接口设计
对场景以及问题域进行分析,构成系统的架构级设计,阐明对于系统的分层思想。
5.1系统外部接口
5.1.1数据库接口
本系统未使用数据库连接池技术,但软件中存在ApacheDbcp数据库连接池JAR包
●后台服务采用JDBC连接MYSQL数据库,由于本系统存在多个数据库,每活动线程最多拥有一个数据库连接,外部请求在使用完成后不需要显式关闭。
5.1.2第三方接口
5.1.3通信接口
5.2系统内部接口
●应用子系统
这是本系统中的上层应用,包括提供各种功能的插件以及用户界面,主要为用户提供输入条件和输出结果,也就是查询条件的输入和数据展示,也包括基本数据的录入和管理功能,由如下的插件应用构成,
模块
描述
实时监控插件
负责提供实时监控功能
虚拟身份插件
负责提供真实/虚拟身份的查询,轨迹查询的功能
案件管理插件
负责提供对案件的管理和报警等功能
线索分析插件
负责提供同时上下机查询,碰撞分析和CCIC库管理等功能
情报分析插件
负责提供对内容的查询和QQ好友分析等功能
实名登记插件
负责提供对实名登记查询和违规卡的管理功能
场所管理插件
负责提供对上网场所的管理和运行状态综合统计信息等功能
系统管理插件
负责完成整个系统的管理,包括用户密码,和基本数据的管理功能
●后台子系统
相对与应用插件,后台数据子系统的主要功能是接受来自插件应用的请求,并为请求提供实际操作功能。
模块
描述
实时监控后台
负责提供实时监控
虚拟身份后台
负责提供真实/虚拟身份的查询,轨迹查询的功能
案件管理后台
负责提供对案件的管理和报警等功能
线索分析后台
负责提供同时上下机查询,碰撞分析和CCIC库管理等功能
实名登记后台
负责提供对实名登记查询和违规卡的管理功能
场所管理后台
负责提供对上网场所的管理和运行状态综合统计信息等功能
系统管理后台
负责完成整个系统的管理,包括用户密码,和基本数据的管理功能
●文本分析子系统
负责对协议文本文件的索引,包括IM聊天记录文件,POST内容记录文件等的索引和查询功能
模块
描述
文本索引模块
负责提供对文本文件的索引,采用LUCENCE技术
索引查询模块
负责提供对内容的查询和QQ好友分析等功能
●配置中心子系统
配置中心子系统负责为后台服务和客户端配置文件的配置提供GUI的配置途径
6、运行设计
本系统在设计时为了保证客户端的响应动态响应前台的请求而动态生成任务外,同时启动多个后台服务。
6.1进程/任务的设计
6.1.1前台RCP客户端
取客户端配置放内存(经配置可以使用JAR包XML配置文件而省略这一步)
删除
6.1.2后台系统
对于多表查询,使用任务方式委托JDK线程池对不同表进行查询。
整个后台服务初始完成以后,将生成以下任务(或线程),此任务为单一线程,并未做线程池并发处理,任务线程串行处理任务
6.2数据存储
6.2.1数据库模型
重要数据模型
6.2.2文件
系统用文件系统结果、接口等。
6.2.3系统参数
配置参数、环境参数等
datasource.config数据源列表
serverlist.config报警的服务器列表
system-id自识别的城市ID
6.2.4其它数据
内存等
6.3出错处理
本章节应列出出错原因及提示信息
7、特性设计
特性设计可以根据产品用途、行业标准等实际情况对章节进行调整。
7.1性能
描述系统常态下系统要求,重要有代表业务性能指标。
以及在架构设计中保证性能,方案和设计要求
7.1.1规模分析与实现
7.1.2性能分析与实现
7.1.3内存占用
7.1.4响应速度要求
7.2可靠性
标准是72小时无故障。
例如为保证72小时,在故障处理设计实现方式、要求等。
还有异常处理
7.3安全性
用户和权限管理、数据范围权限的控制、通讯是否加密,加密方式强度和要求,防止数据篡改、攻击等
7.4可维护性
实施、系统升级等,包括可移植性、可修改性、可扩充性
8、部署
8.1部署模式
8.1.1部署方式一
部署硬件、网络等详细要求,提供部署图。
8.1.2部署方式二
8.2许可协议
许可协议方式和版权加密控制方式。
9、附录
篇二:
系统架构设计说明书
编写人:
审核人:
批准人:
修订记录:
修订日期
版本
描述
编写人
引言
编写目的
给项目组提供高层的架构设计,给编写系统概要设计的相关人员提供指导,使项目组按照既定的系统架构和技术开发出符合预定需求的产品。
背景
项目背景。
系统需求提出者:
系统开发者:
系统最终用户:
定义
系统设计中所用的一些专有或缩写词的解释。
参考资料
列出有关的参考文件,包括文件的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源
系统概述
给出对该程序的简要描述,主要说明开发本程序的目的意义,并且,还要说明本程序的特点等。
系统架构设计
系统总架构图
用一系列图表列出本程序系统所采用的技术框架,以及系统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间的层次结构关系。
系统逻辑结构
分层描述每一层所采用的具体的技术,以及每一层的功能模块设计。
系统数据模型
根据用户需求说明文档,列举系统存在的主要数据模型,以及各数据对象之间的关系等。
系统数据流程
用一系列图表和文字描述系统内各层以及各模块之间主要的数据流程。
包括数据的输入
输出以及各种事件等。
系统物理架构
描述系统各层,各功能模块以及系统所需的外部的服务(包括webserver,db等)等在物理网络上的部署分布。
开发工具和环境
WebServer:
开发语言:
开发工具:
数据库:
其他:
篇三:
软件架构设计说明
文档范围
本软件架构说文档适合于航班信息查询系统的总体应用架构。
定义
SSH:
由Struts,Spring,Hibernate一起组成的3个开源框架,用于构建灵活、易于扩展的多层Web应用程序。
Mysql:
一个小型关系型数据管理系统,开发者为瑞典MysqlAB公司,属于开源软件。
JSP:
JSP(JavaServerPages)是由SunMicrosystems公司倡导、许多公司参与一起建立的一种动态网页技术标准。
Javascript:
为客户提供更流畅的浏览效果。
Myeclipse:
开发工具。
参考资料
《软件体系结构》,清华大学出版社。
《文档写作指南》,清华大学出版社。
《航班信息查询系统需求设计说明书》。
《航班信息查询系统说明书》。
架构表示方式
本软件架构设计文档以4+1视图模型来表示系统的软件构架。
最终用户:
功能需求编程人员:
软件管理
系统集成人员:
性能可扩充系统工程人员:
系统拓扑、安装、通信等
性、吞吐量等
每个视图拥有一个或多个模型(Model)。
并围绕相关视图来描述系统的基本结构、组成机制与工作原理等。
本软件架构设计文档还将系统的构架机制描述也放在了逻辑视图之下。
本文档主要使用统一建模语言(UML)来充当相关模型的表达语言。
架构设计目标与约束
描述构架设计最主要目标就是满足关键系统功能需求和质量约束,这些功能需求和质量要求对软件构架有重大的影响,并决定了构架的设计。
本节同时还列明影响构架的其他相关因素,如软件的复用策略、使用商业构件、设计与实施的策略等。
关键功能需求
按照需求分析文档的规格要求,本航班信息查询系统的设计分成了以登录功能、信息查询功能模块以及信息管理功能模块为主的三大模块进行开发。
系统的开发主要是为了使航班信息查询更加规范化、系统化和程序化,提高信息处理的速度和准确性,提高用户体验。
其功能模块示意图如下所示:
关键质量需求
要求稳定、安全、便捷,易于管理和操作。
查询速度:
不超过10秒;
其它所有交互功能反应速度:
不超过3秒;
可靠性:
平均故障间隔时间不低于200小时。
开发策略
软件复用策略
系统中重要基础构件应当具备较高的设计与构建质量,可以在产品中复用。
用例视图
概述
用例视图从用户使用的角度描述系统构架的基本外部行为特性,通常包含业务用例模型与系统用例模型。
业务用例模型不适用于本系统,这里只关注系统用例。
这里选取了用例模型中对系统构架的内容产生重大影响的应用场景与用例集合,这些用例代表了系统主要的核心功能,决定了系统构架的基本组成元素。
有些用例强调或决定了构架的某些具体然而重要的细节,通常也可以列在本节内,总之所列的用例集合应基本覆盖系统构架的主要方面。
关键用例
关键的系统参与者
游客的用例说明
用例名称
简单描述
查询
旅客查询航班信息和个人信息
用户信息管理
旅客管理个人信息
登录
根据用户账号和密码登录
注册
旅客填写基本信息并注册成为用户后可以享受查询功能
航空公司的用例
航空的用例说明
用例名称
简单描述
登录
根据用户账号和密码登录
航班信息管理
对航班信息进行管理
公司信息管理
对公司信息进行管理
用户信息管理
对用户信息进行管理
航班信息查询
对航班信息查询进行查询
公司信息查询
对公司信息查询进行查询
用户信息查询
对用户信息查询进行查询
关键的系统用例
逻辑视图
概述
逻辑视图从系统内在逻辑结构的角度描述系统的基本结构与动态行为,通常包括分析模型(AnalysisModel)、设计模型(DesignModel)以及数据模型(DataModel)等。
设计模型说明了系统的组成元素、组织架构和关系,并描述了各组成元素的协作以及状态转换关系等(通过用例实现UseCaseRealization予以表达)。
本节将分别在系统层次结构模型中描述系统的层次组织结构;在主要的包和子系统中说明系统的具体组成。
系统层次模型
进程视图
概述
进程视图从系统运行时刻的角度,描述系统划分为进程、线程的结构,及其动态关系。
模型主要说明不同系统角色之间的创建、交互和消息通讯关系等。
搜索信息:
航空公司管理信息:
游客注册:
旅客修改个人信息:
开发视图
1.概述
本部分也称为模块视图,主要侧重于模块的组织和管理。
开发视图通过系统输入输出关系的模型图和子系统来描述。
可以在确定了软件包含的所有元素之后描述完整的开发角度,也可以在确定每个元素之前,列出开发视图原则。
物理视图
1.概述
从系统软硬件物理配置的角度,描述系统的网络逻辑拓扑结构。
模型包括各个物理节点的硬件与软件配置,网络的逻辑拓扑结构,节点间的交互和讯关系等。
同时还表达了进程视图中的各个进程具体分配到物理节点的映射关系。
三层架构
两个功能模式设计
旅客查询航班信息功能
旅客管理用户信息功能
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 系统 架构 设计 说明书
![提示](https://static.bdocx.com/images/bang_tan.gif)