最新系统架构设计说明书模板汇编
- 格式:doc
- 大小:732.00 KB
- 文档页数:14
架构设计说明书xxx银行核心业务项目系统架构设计说明书架构设计说明书文档修订记录目录1简介 (5)1.1目的 (5)1.2范围 (5)1.3术语和缩写词 (5)1.4参考资料 (6)2项目概述 (7)2.1项目目标 (7)3现状分析 (9)3.1渠道与前置系统 (9)3.1.1系统现状描述 (9)3.1.2系统现状分析 (10)3.2后台管理系统 (11)4架构设计方案 (12)4.1架构设计原则 (12)4.2系统架构与范围 (13)4.3系统中长期规划 (14)4.4核心系统和老前置系统接口改造方案 (15)4.5数据整合平台改造方案 (18)4.6关键架构问题说明 (20)4.6.1历史数据中心改造方案....................................................错误!未定义书签。
4.6.2分行特色业务平台系统接入方案 (21)5产品技术架构 (23)5.1柜面系统技术架构 (23)5.2ESB技术架构 (24)5.3中间业务系统技术架构 (27)5.4核心业务系统技术架构 (27)5.5数据整合平台技术架构 (30)6系统部署方案 (30)6.1物理架构 (30)6.2硬件环境 (32)6.3软件环境 (35)6.4网络架构 (37)7架构风险 (38)7.1接口改造涉及的系统多、范围广、接口数量多 (38)7.2柜面系统界面开发量大 (38)附件: (39)1简介1.1目的本文档对新的核心系统整体架构进行综合概述,其中会使用多种不同的构架视图来描述系统的各个方面。
它用于记录并表述已经对系统的构架方面作出的重要应用决策。
本文档的另外一个作用是作为概要设计和详细设计的参考文档,通过对系统涉及到的各技术层面的阐述,来屏蔽概要设计和详细设计阶段遇到的各种技术难点,通过对架构中各个机制的实现的说明,使概要设计和详细设计集中于系统的功能性需求的设计,非功能需求通过架构中的各项机制得到有效的解决。
系统架构设计说明书书模板软件研发部项目名称:Xx系统版本号:QR-RD-035(V1.0)密级:商密A架构设计说明书内部资料请勿外传)编写:审核:批准:日期:日期:日期:___内部使用第1页共15页版权所有不得复制文档变更记录序号变更(+/-)说明作者版本号日期批准目录1、引言1.1 背景1.2 术语和缩略语引言背景:本文档旨在介绍Xx系统的架构设计,为项目开发提供指导。
术语和缩略语:本文档中使用的术语和缩略语请参考附录。
1.1 背景Xx系统是___研发的一款软件系统,旨在解决企业内部管理和业务处理的问题。
该系统涉及多个模块和功能,包括但不限于人力资源管理、财务管理、客户关系管理等。
系统采用先进的技术和架构,具有高效、稳定、安全等特点,能够满足企业的各种需求。
1.2 术语和缩略语本文档中使用的术语和缩略语请参考附录。
1.3 参考资料本项目的参考资料包括但不限于以下内容:技术文档、相关书籍、互联网资源等。
2.1 需求规定在本阶段,我们需要明确项目的需求,包括但不限于功能需求、性能需求、安全需求等。
2.2 架构设计目标和约束在设计系统架构时,我们需要考虑以下目标和约束:2.2.1 运行环境系统需要能够在多种不同的运行环境下正常运行,包括但不限于操作系统、硬件平台等。
2.2.2 开发环境为了保证开发效率和代码质量,系统需要在开发环境中能够顺利运行,包括但不限于集成开发环境、版本控制工具等。
4.1 进程/任务的设计在本节中,我们将讨论系统中使用的进程和任务的设计。
这些进程和任务在系统中发挥着不同的作用,包括前台RCP 客户端和后台系统。
4.1.1 前台RCP客户端前台RCP客户端是用户与系统交互的主要方式。
在设计该客户端时,我们考虑了用户体验和界面设计。
我们使用了Eclipse RCP框架,该框架提供了丰富的插件和工具,使得开发过程更加高效和灵活。
4.1.2 后台系统后台系统是系统的核心,负责处理数据和业务逻辑。
XXX有限公司XX项目总体架构设计说明书总体架构设计说明书文档修订记录*变化状态:A——增加,M——修改,D——删除目录1引言 (5)1.1目的 (5)1.2读者对象 (5)1.3引用文件 (5)1.4术语表 (5)2相关框架介绍 (5)2.1XX框架简介 (5)2.2XX框架简介 (5)3系统架构 (6)4总体设计 (6)4.1约定 (6)4.2设计原则 (6)4.3设计实现 (6)4.4构件实现 (6)4.5通用业务处理 (7)4.6配置文件 (7)4.7辅助工具介绍 (7)1引言1.1目的[在此对文档的目的进行说明。
]1.2读者对象[在此对预期读者的角色进行罗列说明。
]1.3引用文件✧[《XXXXXXXX》文件编号:XXXX_XXX_XXX]✧[《XXXXXXXX》文件编号:XXXX _XXX_XXX]1.4术语表2相关框架介绍[对项目中使用到的框架进行介绍。
]2.1X X框架简介[在此进行相关框架的产生背景、主要解决的问题、为什么要在项目中引入此框架进行介绍。
] 2.2X X框架简介[在此进行相关框架的产生背景、主要解决的问题、为什么要在项目中引入此框架进行介绍。
]3系统架构[在此结合架构图概括的描述系统整体结构,特别注意接口的表述。
]4总体设计4.1约定4.1.1X X约定[在此对设计过程中要遵循的约定进行说明。
]4.1.2X X约定[在此对设计过程中要遵循的约定进行说明。
]4.2设计原则4.2.1X X设计原则[在此对设计过程中要遵循的原则进行说明。
]4.2.2X X设计原则[在此对设计过程中要遵循的原则进行说明。
]4.3设计实现4.3.1X X设计实现[在此对设计思路进行详细说明,确保软件设计师和软件开发工程师能够读懂。
]4.3.2X X设计实现[在此对设计思路进行详细说明,确保软件设计师和软件开发工程师能够读懂。
]4.4构件实现[我们通常会把在一个或多个项目中用到的界面元素或功能抽象为控件或组件,以达到代码和外观重用的目的。
内部使用注意保密办公信息系统V2.0项目系统架构设计说明书2012年1月目录第1章架构设计概述 (1)1.1定义、缩写词和缩略语 (1)1.2主要设计目标和设计原则 (2)1.2.1档案管理子系统的主要目标 (2)1.2.2人力资源管理子系统的主要目标 (2)1.2.3资产管理子系统的主要目标 (3)1.2.4采购管理子系统的主要目标 (3)1.2.5网上报销模块的主要目标 (3)1.3参考资料 (4)第2章业务场景 (4)2.1主要需求和约束 (4)2.1.1档案管理子系统的主要需求 (4)2.1.2人力资源管理子系统的主要需求 (5)2.1.3资产管理子系统的主要需求 (5)2.1.4采购管理子系统的主要需求 (5)2.1.5网上报销子系统的主要需求 (5)2.2业务功能需求场景 (6)2.2.1档案管理子系统业务流程图 (6)2.2.2人力资源管理子系统业务流程图 (6)2.2.3资产管理子系统业务流程图 (6)2.2.4采购管理子系统业务流程图 (7)2.2.5网上报销模块业务流程图 (7)2.3非功能性需求场景 (8)2.3.1系统整体架构 (8)2.3.2系统性能 (8)2.3.3易用性 (8)2.3.4安全性 (8)2.3.5可用性 (9)2.3.6开放性和可扩展性 (9)2.3.7可管理性、易于维护性、容错性、兼容性 (9)第3章逻辑架构 (10)3.1职责划分与职责确定 (10)3.1.1从信息集成方式层面划分 (10)3.1.2从业务层面上划分 (11)3.2接口设计与协作机制 (12)3.2.1用户账号同步接口 (12)3.2.2文件处理接口 (13)3.2.3招聘接口 (14)3.2.4财务接口 (15)3.2.5档案接口 (16)3.2.6其它接口 (16)第4章数据设计 (16)4.1关键数据流定义 (16)4.1.1招聘数据流 (17)4.1.2员工异动数据流 (17)4.1.3OA文件归档数据流 (18)4.1.4网上报销数据流 (18)4.1.5资产与财务台账数据流 (19)4.1.6项目管理数据流 (19)4.1.7采购管理数据流 (20)4.1.8合同管理数据流 (21)4.2关键数据的转换关系 (22)4.3持久化存储方案 (22)4.4数据同步与复制策略 (23)第5章物理架构 (24)5.1物理设施及软件映射 (24)5.2物理部署及拓扑结构 (26)第6章运行架构 (27)进程说明 (27)6.1.1IIS5 的 请求处理过程 (27)6.1.2IIS6 的 请求处理过程 (29)6.1.3IIS7 的 请求处理过程 (30)6.1.4IIS6以及IIS7经典模式的托管管道的架构 (31)6.1.5IIS7 应用程序池的托管管道模式集成模式 (32)连接池描述 (32)6.3运行约束 (33)第7章开发架构 (34)7.1开发结构 (34)7.1.1整体开发架构 (34)7.1.2流程待办数据分表优化 (35)7.2关联开发包 (36)第8章关键质量属性设计原理及解决方案 (36)8.1容量及性能 (36)8.1.1OA门户子系统容量估算 (36)8.1.2人力资源管理子系统容量估算 (37)8.1.3资产管理子系统容量估算 (38)8.1.4采购管理子系统容量估算 (38)8.1.5历史数据清理策略 (38)8.1.6日志的分库处理与清理策略 (39)8.2安全性 (39)8.2.1访问控制 (39)8.2.2数据传输保密性与完整性设计 (42)8.2.3统一登录安全性 (44)8.2.4审计日志 (45)8.2.5数据输入常见风险 (46)8.2.6数据传输保密性与完整性设计 (47)8.2.7身份认证 (47)8.2.8数据校验 (47)8.2.9错误与异常处理 (48)8.2.10会话与cookie安全 (48)8.3可扩展性 (49)8.4可靠性 (50)第9章技术公司OA部署对整体架构的影响 (50)9.1附件一:一期子系统用于技术公司的OA实现方案-分布部署 (50)9.2附件二:二期各个子系统用户技术公司OA的初步方案 (50)第1章架构设计概述1.1 定义、缩写词和缩略语✓办公信息系统:简称OA、OA系统,本项目即为OA系统V2.0的开发。
系统架构设计说明书三篇篇一:系统架构设计说明书Xx系统架构设计说明书编写:日期:检查:日期:审核:日期:批准:日期:文档变更记录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运行环境4.1.2开发环境4.2设计思想阐明进行架构设计的思想,可参考一些架构设计的模式,需结合当前系统的实际情况而定。
4.3架构体系根据架构分析和设计思想产生系统的架构图,并对架构图进行描述,说明分层的原因、层次的职责,并根据架构图绘制系统的物理部署图,描述系统的部署体系。
4.4重要业务流程(有多少个就写多少个流程图)流程图类型不做严格要求,只要图和描述表达设计思想即可;重要业务流程数据流向等。
4.4.1流程14.4.2流程24.4.3流程34.5模块划分根据架构图进行模块的划分并阐明模块划分的理由,绘制模块物理图以及模块依赖图。
有多少模块就写多少个模块4.5.1模块一4.5.1.1模块一描述根据模块物理图描述各模块的职责,并声明其对其他模块的接口要求。
这是本系统中的上层应用,包括提供各种功能的插件以及用户界面,主要为用户提供输入条件和输出结果,也就是查询条件的输入和数据展示,也包括基本数据的录入和管理功能,由如下的插件应用构成,子模块描述实时监控插件负责提供实时监控功能4.5.1.2模块一业务流程说明图+文字描述。
《项目名称》--设计说明小组名称:设计说明目录1 概述 (1)1.1 编写目的 (1)1.2 参考资料 (1)1.3 术语和缩写词* (1)2 需求概述 (1)3 结构设计 (1)3.1 总体设计 (1)3.2 功能分配 (1)3.3 接口设计 (1)3.4 数据结构设计 (1)3.4.1 公共数据结构设计 (1)3.4.2 数据库设计 (1)3.4.3 数据结构同程序的关系* (2)3.5 出错处理设计* (2)3.6 其它* (2)4 类的设计 (2)4.1 类1设计 (2)4.1.1 功能说明 (2)4.1.2 属性说明 (2)4.1.3 公有方法说明 (2)4.1.4 私有方法说明 (2)4.2 类2设计 (2)4.2.1 功能说明 (2)4.2.2 属性说明 (2)4.2.3 公有方法说明 (2)4.2.4 私有方法说明 (2)5 用例实现的设计 (3)5.1 用例1设计 (3)5.1.1 功能说明 (3)5.1.2 界面设计 (3)5.1.3 交互设计 (3)5.2 用例2设计 (3)5.2.1 功能说明 (3)5.2.2 界面设计 (3)5.2.3 交互设计 (3)【注】本编写指南中带有“*”标志的表示可选部分,即在文档编写过程中可以依据实际项目的具体情况进行取舍,文档完成后这些“*”标记应该去掉。
1 概述1.1 编写目的本文档的编写目的是:详细定义×××××软件的总体功能;给出系统的结构设计和过程设计,作为程序编写的依据。
1.2 参考资料包括:a. 项目来源;b. 本文档中引用到的规范和资料等;c. 列出这些规范和资料的作者、编号、标题、发表日期、出版单位或资料来源。
1.3 术语和缩写词*列出本文档中用到的专门术语的定义和缩写词,缩写词要给出中文译名和英文全称,常用的不需要定义。
2 需求概述概述系统的特性和需求,扩充软件需求说明中的信息,给出增加的细节,详尽地指出对软件需求说明中有关特性和需求作出的变更。
系统架构设计说明书公司要申请软件著作权,写了一份概要设计使用说明书,下面写了xxx架构设计说明书,XXX概要设计说明书,XXX详细设计说明书的模板XXX架构设计说明书(架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系)一. 概述描述本文的参考依据、资料以及大概内容。
二. 目的描述本文编写的目的。
三.架构设计阐明进行架构设计的总体原则,如对问题域的分析方法。
3.1.架构分析对场景以及问题域进行分析,构成系统的架构级设计,阐明对于系统的分层思想。
3.2.设计思想阐明进行架构设计的思想,可参考一些架构设计的模式,需结合当前系统的实际情况而定。
3.3.架构体系根据架构分析和设计思想产生系统的架构图,并对架构图进行描述,说明分层的原因、层次的职责,并根据架构图绘制系统的物理部署图,描述系统的部署体系。
3.4.模块划分根据架构图进行模块的划分并阐明模块划分的理由,绘制模块物理图以及模块依赖图。
3.4.1 模块描述根据模块物理图描述各模块的职责,并声明其对其他模块的接口要求。
3.4.2 模块接口设计对模块接口进行设计,并提供一定的伪代码。
XXX概要设计说明书(概要设计重点在于将模块分解为对象并阐明对象之间的关系)一.概述描述本文的参考依据、资料以及大概内容。
二.目的描述本文的编写目的。
三.模块概要设计引用架构设计说明书中的模块图,并阐述对于模块进行设计的大致思路。
3.1.设计思想阐明概要设计的思想,概要设计的思想通常是涉及设计模式的。
3.2.模块**A**3.2.1 概要设计根据该模块的职责对模块进行概要设计(分解模块为对象、描述对象的职责以及声明对象之间的接口),绘制模块的对象图、对象间的依赖图以及模块主要功能的序列图,分别加以描述并相应的描述模块异常的处理方法。
3.2.2 模块接口实现阐明对于架构设计中定义的模块接口的实现的设计。
XXX详细设计说明书(详细设计重点在于对模块进行实现,将模块的对象分解为属性和方法,并阐述如何实现)一.概述阐述本文的参考依据、资料以及大概内容。
系统架构设计说明书模版文件修改控制*变化状态:A——增加,M——修改,D——删除目录1 简介 (4)1.1 文档目的 (4)1.2 文档范围 (4)1.3 定义、缩写词和缩略语 (4)1.4 参考资料 (4)2 架构描述方式 (4)2.1 架构视图阅读指南 (4)2.2 图表与模型阅读指南 (5)3 架构设计目标 (5)3.1 关键功能 (5)3.2 关键质量属性 (5)3.3 业务需求和约束因素 (6)4 架构设计原则 (7)4.1 架构设计原则 (7)4.2 备选架构设计方案及被否原因 (7)4.3 架构设计对后续工作的限制(详设,部署等) (7)5 Make-Buy-Reuse分析 (7)5.1 识别 (7)5.2 分析 (8)5.3 知识点贡献情况 (8)6 逻辑架构视图 (8)6.1 职责划分与职责确定 (9)6.2 接口设计与协作机制 (10)6.3 重要设计包 (12)7 开发架构视图 (13)7.1 Project划分 (13)7.2 Project 1 (14)7.2.1 Project目录结构指导 (14)7.2.2 程序单元组织 (14)7.2.3 框架与应用之间的关系(可选) (14)7.3 Project 2 (16)7.4 Project n (16)8 运行架构视图 (16)8.1 控制流组织 (17)8.2 控制流的创建、销毁、通信 (17)8.3 加锁设计 (17)9 物理架构视图 (17)9.1 物理拓扑 (18)9.2 软件到硬件的映射 (19)9.3 优化部署 (19)10 数据架构视图 (20)10.1 持久化机制的选择 (20)10.2 持久化存储方案 (21)10.3 数据同步与复制策略 (21)11 关键质量属性的设计原理 (21)1 简介1.1 文档目的【简要说明编写本设计说明书的目的。
】1.2 文档范围[文档的Scope,非项目的Scope。
否则造成多个文档之间的内容重复,不利于文档维护。
系统架构设计文档范本一、概述本文档旨在对系统架构进行详细设计,包括系统的整体结构、模块划分以及模块之间的关系等内容。
通过本文档的编写,可以清晰地了解系统的架构,并为开发人员提供指导。
二、系统架构1. 总体结构系统采用三层架构,包括展示层、业务逻辑层和数据访问层。
2. 展示层展示层主要负责用户界面的呈现和交互。
采用前端技术实现,例如HTML、CSS和JavaScript。
3. 业务逻辑层业务逻辑层负责处理用户请求、业务逻辑的处理和调度。
它包括以下几个模块:- 用户管理模块:负责用户注册、登录、权限管理等功能。
- 订单管理模块:负责订单的创建、修改、查询和删除等操作。
- 商品管理模块:负责商品的添加、删除、修改和查询等功能。
4. 数据访问层数据访问层主要负责与数据库的交互,包括数据的读取、写入和更新等操作。
它包括以下几个模块:- 用户数据访问模块:提供用户信息的读取和存储接口。
- 订单数据访问模块:提供订单信息的读取和存储接口。
- 商品数据访问模块:提供商品信息的读取和存储接口。
三、模块划分在系统架构设计中,将系统划分为以下几个模块,并对各个模块的功能进行介绍。
1. 用户管理模块该模块主要负责用户的注册、登录和权限管理等功能。
具体功能如下:- 用户注册:用户可以通过该功能进行注册,输入用户名、密码和邮箱等信息。
- 用户登录:用户可以通过该功能进行登录,输入用户名和密码进行身份验证。
- 权限管理:该功能用于管理用户的权限,包括用户的角色分配和权限分配等。
2. 订单管理模块该模块主要负责订单的创建、修改和查询等功能。
具体功能如下:- 订单创建:用户可以通过该功能创建订单,选择商品和数量,并输入收货地址等信息。
- 订单修改:用户可以通过该功能修改订单的商品数量、收货地址等信息。
- 订单查询:用户可以通过该功能查询订单的详细信息,包括订单状态、支付情况等。
3. 商品管理模块该模块主要负责商品的添加、删除和修改等功能。
服务业综合业务管理系统系统架构说明书——润和软件股份有限公司 一、概要本说明书对服务业综合业务管理系统的整体框架进行分块说明,对系统的采用技术点的技术点进行阐述,通过视图与描述展示整个系统框架的结构与层次。
二、目标构建服务业综合业务管理系统J2EE应用的开发框架,注入Spring支撑,使用兼具灵活性与使用性的ibatis作为持久层,使所有系统能规范开发组件、提高开发效率,易于统一升级和维护。
三、架构设计3.1、架构分析1、服务业综合业务管理系统采用B/S模式。
B/S 模式具有分布性特点,可以随时随地进行查询、浏览等业务处理。
其业务扩展简单方便,通过增加网页即可增加服务器功能。
而且后期维护方面只需要改变网页,即可实现所有用户的同步更新2、搭建轻量级J2EE框架—Spring框架。
J2EE为搭建具有可伸缩性、灵活性、易维护性的系统提供了良好的机制。
J2EE框架使得开发的产品更加高效,更加健壮,在伸缩性和稳定性上面也有着显而易见的效果。
而Spring是一个完美的框架“黏合剂”。
它提供了一种管理对象的方法,可以把中间层对象有效地组织起来。
他的分层结构可以增量引入项目。
而非侵入性应用程序对SpringAPI的依赖可以减至最小限度。
3、使用兼具灵活性与实用性的ibatis作为系统的持久层。
Ibatis是支持普通SQL查询,存储过程和高级映射的优秀持久层框架。
Ibatis将代码和sql语句分离,sql可以写在xml中,结构清晰,灵活配置,对平台支持性大幅度提高。
3.2、设计思想1、系统技术架构采用主流的MVC模式MVC思想将一个应用分成三个基本部分:Model (模型)、View(视图)和Controller(控制器),这三个部分以最少的耦合协同工作,从而提高应用的可扩展性及可维护性。
直接向数据库发送请求并用HTML显示,开发速度往往比较快,但由于数据页面的分离不是很直接,因而很难体现出业务模型的样子或者模型的重用性。
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 模块一 (7)
2.6.2 模块二 (8)
3、接口设计 (9)
3.1 系统外部接口 (10)
3.1.1 数据库接口 (10)
3.1.2 第三方接口 (10)
3.1.3 通信接口 (10)
3.2 系统内部接口 (10)
3.2.1 系统数据流.................................................................................... 错误!未定义书签。
3.2.2 系统状态机.................................................................................... 错误!未定义书签。
3.2.3 系统部署图.................................................................................... 错误!未定义书签。
4、运行设计 (11)
4.1 进程/任务的设计 (11)
4.1.1 前台RCP客户端 (11)
4.1.2 后台系统 (11)
4.2 数据存储 (11)
4.2.1 数据库模型 (11)
4.2.2 文件 (12)
4.2.3 系统参数 (12)
4.2.4 其它数据 (12)
4.3 出错处理 (12)
5、特性设计 (12)
5.1 性能 (12)
5.1.1 规模分析与实现 (12)
5.1.2 性能分析与实现 (12)
5.1.3 内存占用 (12)
5.1.4 响应速度要求 (12)
5.2 可靠性 (12)
5.3 安全性 (12)
5.4 可维护性 (13)
6、部署 (13)
6.1 部署模式 (13)
6.1.1 部署方式一 (13)
6.1.2 部署方式二 (14)
6.2 许可协议 (14)
7、附录 (14)
1、引言
描述本文的参考依据、资料以及大概内容。
1.1背景
项目产生或者开发背景,必要性等。
1.2术语和缩略语
缩略语、系统主用名词、术语等解释
1.3参考资料
编写本文和阅读本文是需要查阅的资料有关文档,注明出处、作者和版本。
(架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系) 2、
3、范围
3.1
3.2软件名称
英文名称:TopEng-CSP
中文名称:客户服务平台
3.3
3.4软件功能
请参考《XXX子系统软件需求规格说明书.doc》
3.5软件应用
请参考《系统软件需求规格说明书.doc》
3.6需求边界
明确范围边界,做什么,不做什么。
4、总体设计
4.1
4.2架构设计目标和约束
架构设计总体目标和一些有关架构方面的约束,比如技术约束或者设计上约束。
4.2.1运行环境
开发环境
4.3设计思想
阐明进行架构设计的思想,可参考一些架构设计的模式,需结合当前系统的实际情况而定。
4.4架构体系
根据架构分析和设计思想产生系统的架构图,并对架构图进行描述,说明分层的原因、层次的职责,并根据架构图绘制系统的物理部署图,描述系统的部署体系。
4.5重要业务流程(有多少个就写多少个流程图)
流程图类型不做严格要求,只要图和描述表达设计思想即可;重要业务流程数据流向等。
4.5.1流程1
4.5.2流程2
4.5.3流程3
4.6模块划分
根据架构图进行模块的划分并阐明模块划分的理由,绘制模块物理图以及模块依赖图。
有多少模块就写多少个模块
4.6.1模块一
4.6.1.1模块一描述
根据模块物理图描述各模块的职责,并声明其对其他模块的接口要求。
入条件和输出结果,也就是查询条件的输入和数据展示,也包括基本数据的录入和管理功能,由如下的插件应用构成,
4.6.1.2业务流程说明
图+文字描述。
样例;
4.6.1.3模块一接口设计
对模块接口进行设计,并提供一定的伪代码。
4.6.2模块二
4.6.2.1模块二描述
根据模块物理图描述各模块的职责,并声明其对其他模块的接口要求。
入条件和输出结果,也就是查询条件的输入和数据展示,也包括基本数据的录入和管理功能,由如下的插件应用构成,
4.6.2.2业务流程说明
图+文字描述。
样例;
4.6.2.3模块二接口设计
对模块接口进行设计,并提供一定的伪代码。
5、接口设计
对场景以及问题域进行分析,构成系统的架构级设计,阐明对于系统的分层思想。
5.1系统外部接口
5.1.1数据库接口
本系统未使用数据库连接池技术,但软件中存在Apache Dbcp 数据库连接池JAR包
●后台服务采用JDBC连接MYSQL数据库,由于本系统存在多个数据库,每活动线程最多拥
有一个数据库连接,外部请求在使用完成后不需要显式关闭。
5.1.2第三方接口
5.1.3通信接口
5.2系统内部接口
●应用子系统
这是本系统中的上层应用,包括提供各种功能的插件以及用户界面,主要为用户提供输入条件和输出结果,也就是查询条件的输入和数据展示,也包括基本数据的录入和管理功能,由如下的插件应用构成,
相对与应用插件,后台数据子系统的主要功能是接受来自插件应用的请求,并为请求提供实际操作功能。
负责对协议文本文件的索引,包括IM聊天记录文件,POST内容记录文件等的索引和查询功能
配置中心子系统负责为后台服务和客户端配置文件的配置提供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、附录。