《软件架构设计.docx》由会员分享,可在线阅读,更多相关《软件架构设计.docx(6页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、工程名称软件架构设计文档版本 工程名称软件架构设计文档版本:日期: 日期版本说明作者修订历史记录名目1.简介31.1目的31.2范围31.3定义、首字母缩写词和缩略语31.4参考资料31.5概述32.整体说明32.1简介32.2构架表示方式32.3构架目标和约束43.用例视图43.1核心用例43.2用例实现44.规律视图44.1规律视图44.2分层44.2.1应用层44.2.2业务层44.2.3中间层44.2.4系统层44.3架构模式54.4设计机制54.5公用元素及效劳55.进程视图56.部署视图57.实施视图57.1概述57.2层57.3部署58. 数据视图59. 大小和性能510.质量5
2、11.其它说明612.附录 A 指南613.附录 B 标准614.附录 C 模版615.附录 D 例如软件架构设计文档61. 简介软件构架文档的简介应供给整个软件构架文档的概述。它应包括此软件构架文档的目的、范围、定义、首 字母缩写词、缩略语、参考资料和概述1.1 目的本文档将从构架方面对系统进展综合概述,其中会使用多种不同的构架视图来描述系统的各个方面。它用 于记录并表述已对系统的构架方面作出的重要决策本节确定此软件构架文档在整个工程文档中的作用或目的,并对此文档的构造进展简要说明。应确定此文 档的特定读者,并指出他们应当如何使用此文档1.2 范围简要说明此软件构架文档适用的范围和影响的范围
3、1.3 定义、首字母缩写词和缩略语本小节应供给正确理解此软件构架文档所需的全部术语的定义、首字母缩写词和缩略语。 这些信息可以通过引用工程词汇表来供给1.4 参考资料本小节应完整地列出此软件构架文档中其他局部所引用的全部文档。每个文档应标有标题、报告号假设 适用、日期和出版单位。列出可从中猎取这些参考资料的来源。这些信息可以通过引用附录或其他文档 来供给1.5 概述本小节应说明此软件构架文档中其他局部所包含的内容,并解释此软件构架文档的组织方式2. 整体说明2.1 简介在此简洁介绍软件架构的整体状况,包括用例视图、规律视图、进程视图、实施视图和部署视图的简洁介 绍。另外,简要介绍各种视图的作用
4、和针对的用户2.2 构架表示方式本节说明当前系统所使用的软件构架及其表示方式。还会从用例视图、规律视图、进程视图、部署视图和实施视图中列出必需的那些视图,并分别说明这些视图包含哪些类型的模型元素2.3 构架目标和约束本节说明对构架具有某种重要影响的软件需求和目标,例如:安全性、保密性、市售产品的使用、可移植 性、分销和重复使用。还应记录可能适用的特别约束:设计与实施策略、开发工具、团队构造、时间表、 遗留代码等3. 用例视图本节列出用例模型中的一些用例或场景,这些用例或场景应表达最终系统中重要的、核心的功能;或是在 构架方面涉及范围很广使用了很多构架元素;或强调或说明白构架的某一具体的微小之处
5、在此可以直接引用需求中的相关文档,比方 ROSE 模型;用例描述等对于本系统和其它系统的关系,在用例图上可以清楚的看到,由于其它系统在用例图上被表示为主角 依据工程的实际状况,此节可以省略不写3.1 核心用例在此引用 ROSE 模型中的用例图即可3.2 用例实现本节通过几个精选的用例场景实现来阐述软件的实际工作方式,并解释不同的设计模型元素如何促成 其功能的实现4. 规律视图4.1 规律视图在此用图形的方式显示此软件架构的分层、子系统、包之间的关系,并且参加必要的文字说明,特别是架 构的分层、机制和模式的说明在此,还需要将和本系统有接口关系的其它系统都表示出来,这样可以清楚的看到本系统和其它系
6、统的接 口规律视图,并且还需要将在本系统中负责接口的子系统表示出来4.2 分层在此说明规律分层的每一层和每一层中的包、子系统。对于每个重要的包,都用一个小节来加以说明,其 中应包括该包的名称、简要说明以及显示该包中全部重要的类和包的图。对于该包中的每个重要类,应包括其名称、简要说明,还可选择包括对其局部主要职责、操作和属性的说 明下面预先设置应用层、业务层、中间层和系统层,实际使用中可以依据需要进展修改4.2.1 应用层在此说明软件架构子系统的高层组织,是系统面对外部主角、面对功能用例的子系统。在这一层 中的子系统,要依据中间层的商定连续分区tier4.2.2 业务层在此说明软件架构子系统的高
7、层组织,是应用层子系统公用的、为应用层子系统供给效劳的、和业务相关 的子系统。在这一层中的子系统,要依据中间层的商定连续分区4.2.3 中间层在此说明软件架构子系统的底层组织,是面对系统内部技术、面对非功能补充规约的子系统框 架、包、机制、模式。在这一层的子系统,通常包括分区、支持分区的框架、架构模式、设计机制事 务、存储等、公用元素及效劳邮件、翻页、列表控件、树控件、按钮控件等等4.2.4 系统层在此说明软件架构的操作系统、运行平台应用效劳器、数据库等、开发语言、第三方技术比方 GIS、CORBA、J2EE、COM、.net等4.3 架构模式在此说明软件架构承受的核心模式,此模式形成整个软件
8、架构的骨架,在此以一次交互为主来表达4.4 设计机制在此说明软件架构各相关设计机制的处理方案,包括 2 个局部,一是全局的设计机制,包括事务的处理、持续性的处理等;二是特别、局部的设计机制,包括权限治理、OID 生成、连接池,JSP2SB 等,初始化操作、功能表等4.5 公用元素及效劳在此说明软件架构通用的设计元素及供给的和相关效劳5. 进程视图本节说明将系统分解为轻量级进程单个掌握线程和重量级进程成组的轻量级进程的状况。本节的 内容依据各个通信或交互的进程组来进展组织。说明进程之间的主要通信模式,例如消息传递、中断和会 合依据工程的实际状况,此节可以省略不写6. 部署视图本节说明用来部署和运
9、行该软件的一种或多种物理网络硬件配置。对于每种配置,它至少应当指出执 行该软件的物理节点计算机、CPU及其互连状况总线连接、LAN 连接、点到点连接等在此还需要包括在安装部署时要留意的特别问题,可能还有和安装部署有关的设计内容在此还需要表示本系统和其它系统的在部署上的关系,比方本系统部署的物理节点和其它系统部署的物理 节点之间的连接等7. 实施视图本节说明实施模型的整体构造、软件分解为实施模型中的层和子系统的状况,以及全部在构架方面具有重 要意义的构件7.1 概述本小节指定并定义各个层及其内容、添加到指定层时要遵循的规章以及各层之间的边界。还应包括一个显 示层间关系的构件图假设使用 JAVA
10、做为实施语言,要求明确指定各层各子系统的包前缀7.2 层对于每个层,都用一个小节来加以说明,其中包括该层的名称和一个构件图,并列举位于该层的子系统 假设使用 JAVA 做为实施语言,要求明确指定各子系统内分区的包前缀7.3 部署在此说明各个部署单元、每个部署单元的实施元素。在 J2EE 中,即表示要将应用打成多少个包,每个包的名称以及每个包包含的源文件8. 数据视图从永久性数据存储方面来对系统进展说明。假设几乎或根本没有永久性数据,或者设计模型与数据模型之 间的转换并不重要,那么本节就为可选依据工程的实际状况,此节可以省略不写9. 大小和性能说明软件中会对构架产生影响的主要尺寸特征,以及目标性
11、能约束10. 质量说明软件构架如何促成诸如可扩展性、牢靠性、可移植性等全部系统力量而非功能的实现。假设这些特征具有特别的意义例如在安全性或保密性方面的意义,则应当对它们进展具体的说明11. 其它说明在此说明其它需要说明的内容12. 附录 A 指南在此包括设计指南、编程指南、部署和安装指南,其中在编程指南上不仅包括传统的诸如JAVA 编程指南,还包括指导实现人员实现特定设计机制要留意的问题在此,推举参加链接引用相关文档13. 附录 B 标准在此包括设计标准、编程标准等在此,推举参加链接引用相关文档14. 附录 C 模版在此包括各种相关模版,比方框架模版、JSP 模版、各种设计机制的模版等在此,推举参加链接引用相关文档15. 附录 D 例如在此供给例如,来演示架构如何进展交互在此,推举参加链接引用相关文档