架构设计说明书.docx

《架构设计说明书.docx》由会员分享，可在线阅读，更多相关《架构设计说明书.docx（10页珍藏版）》请在第一文库网上搜索。

1、K看一疙吊B月信息技JK殷份有限公司Changchun FAW Qiming Info. Tech. Co” Ltdxxx产品架构设计说明书文件编号：生效日期：年 月日版本号：A修改状态：0受控状态：口受控非受控总页数：附录：0密级：机密编制：年月 日审核：年月 日批准：年月 日文档修订摘要日期版本号/状态描述著者批阅者批准人/日期2005年5月28日1.0杨晓辉初始创建杨晓辉年月 日年月 日年月 日年月日年月日年月 日年月 日年月日年月 日年月口年月日年月日年月 日年月日年月日年月 日年月 日年月日年月 日年月口年月 日名目1 .简介51.1 1目的51.2 范围51.3 定义、首字母缩写词

2、和缩略语51.4 参考资料51.5 概述52 .整体说明52. 1简介53. 2构架表示方式54. 3构架目标和约束53 .用例视图63.1 核心用例63.2 用例实现64 .规律视图64.1 规律视图64.2 分层6应用层6业务层6中间层7系统层74. 3架构模式75. 4设计机制76. 5公用元素及服务75 .进程视图76 .部署视图77 .实施视图71.1 1概述71.2 层81.3 部署88. 数据视图89. 大小和性能810. 质量811. 其它说明812. 附录A指南813. 附录B法律规范14. 附录C模版15. 附录D示例1简介软件构架文档的简介应供应整个软件构架文档的概述。它

3、应包括此软件构架文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述1.1 目的本文档将从构架方面对系统进行综合概述，其中会使用多种不同的构架视图来描述系统的各个方面。它用于纪录并表述已对系统的构架方面作出的重要决策本节确定此软件构架文档在整个项目文档中的作用或目的，并对此文档的结构进行简要说明。应确定此文档的特定读者，并指出他们应当如何使用此文档1.2 范围简要说明此软件构架文档适用的范围和影响的范围1.3 定义、首字母缩写词和缩略语本小节应供应正确理解此软件构架文档所需的全部术语的定义、首字母缩写词和缩略语。这些信息可以通过引用项目词汇表来供应1.4 参考资料本小节应完整地列出此软

4、件构架文档中其他部分所引用的全部文档。每个文档应标有标题、报告号（假如适用）、日期和出版单位。列出可从中猎取这些参考资料的来源。这些信息可以通过引用附录或其他文档来供应1.5 概述本小节应说明此软件构架文档中其他部分所包含的内容，并解释此软件构架文档的组织方式2 .整体说明2.1 简介在此简洁介绍软件架构的整体状况，包括用例视图、规律视图、进程视图、实施视图和部署视图的简洁介绍。此外，简要介绍各种视图的作用和针对的用户2.2 2构架表示方式本节说明当前系统所使用的软件构架及其表示方式。还会从用例视图、规律视图、进程视图、部署视图和实施视图中列出必需的那些视图，并分别说明这些视图包含哪些类型的模

5、型元素2.3 构架目标和约束本节说明对构架具有某种重要影响的软件需求和目标，例如：平安性、保密性、市售产品的使用、可移植性、分销和重复使用。还应纪录可能适用的特殊约束：设计与实施策略、开发工具、团队结构、时间表、遗留代码等3 .用例视图本节列出用例模型中的一些用例或场景，这些用例或场景应体现最终系统中重要的、核心的功能；或是在构架方面涉及范围很广（使用了很多构架元素）；或强调或阐明白构架的某一具体的微小之处在此可以直接引用需求中的相关文档，比如ROSE模型；用例描述等对于本系统和其它系统的关系，在用例图上可以清晰的看到，由于其它系统在用例图上被表示为主角依据项目的实际状况，此节可以省略不写3.

6、1 核心用例在此引用ROSE模型中的用例图即可3.2 用例实现本节通过几个精选的用例（场景）实现来阐述软件的实际工作方式，并解释不同的设计模型元素如何促成其功能的实现4 .规律视图4.1 规律视图在此用图形的方式显示此软件架构的分层、子系统、包之间的关系，并且加入必要的文字说明，特殊是架构的分层、机制和模式的说明在此，还需要将和本系统有接口关系的其它系统都表示出来，这样可以清晰的看到本系统和其它系统的接口规律视图，并且还需要将在本系统中负责接口的子系统表示出来4.2 分层在此说明规律分层的每一层和每一层中的包、子系统。对于每个重要的包，都用一个小节来加以说明，其中应包括该包的名称、简要说明以及

7、显示该包中全部重要的类和包的图。对于该包中的每个重要类，应包括其名称、简要说明，还可选择包括对其部分主要职责、操作和属性的说明下面预先设置应用层、业务层、中间层和系统层，实际使用中可以依据需要进行修改4. 2. 1应用层在此说明软件架构子系统的高层组织，是系统面对外部（主角）、面对功能（用例）的子系统。在这一层中的子系统，要依据中间层的商定连续分区（tier）4.2.2业务层在此说明软件架构子系统的高层组织，是应用层子系统公用的、为应用层子系统供应服务的、和业务相关的子系统。在这一层中的子系统，要依据中间层的商定连续分区4. 2. 3中间层在此说明软件架构子系统的底层组织，是面对系统内部（技术

8、）、面对非功能（补充规约）的子系统（框架、包、机制、模式）。在这一层的子系统，通常包括分区、支持分区的框架、架构模式、设计机制（事务、存储等）、公用元素及服务（邮件、翻页、列表控件、树控件、按钮控件等）等4. 2. 4系统层在此说明软件架构的操作系统、运行平台（应用服务器、数据库等）、开发语言、第三方技术（比如GIS、CORBA、 J2EE、 COM. .net）等4. 3架构模式在此说明软件架构采纳的核心模式，此模式形成整个软件架构的骨架，在此以一次交互为主来表达5. 4设计机制在此说明软件架构各相关设计机制的处理方案，包括2个部分，一是全局的设计机制，包括事务的处理、持续性的处理等；二是特

9、殊、局部的设计机制，包括权限管理、0ID生成、连接池，JSP2SB等，初始化操作、功能表等6. 5公用元素及服务在此说明软件架构通用的设计元素及供应的和相关服务7. 进程视图本节说明将系统分解为轻量级进程（单个掌握线程）和重量级进程（成组的轻量级进程）的状况。本节的内容依据各个通信或交互的进程组来进行组织。说明进程之间的主要通信模式，例如消息传递、中断和会合依据项目的实际状况，此节可以省略不写8. 部署视图本节说明用来部署和运行该软件的一种或多种物理网络（硬件）配置。对每种配置，它至少应当指出执行该软件的物理节点（计算机、CPU）及其互连状况（总线连接、LAN连接、点到点连接等）在此还需要包括

10、在安装部署时要留意的特殊问题，可能还有和安装部署有关的设计内容在此还需要表示本系统和其它系统的在部署上的关系，比如本系统部署的物理节点和其它系统部署的物理节点之间的连接等9. 实施视图本节说明实施模型的整体结构、软件分解为实施模型中的层和子系统的状况，以及全部在构架方面具有重要意义的构件9.1 概述本小节指定并定义各个层及其内容、添加到指定层时要遵循的规章以及各层之间的边界。还应包括一个显示层间关系的构件图假如使用JAVA做为实施语言，要求明确指定各层各子系统的包前缀9.2 层对于每个层，都用一个小节来加以说明，其中包括该层的名称和一个构件图，并列举位于该层的子系统假如使用JAVA做为实施语言

11、，要求明确指定各子系统内分区的包前缀9.3 部署在此说明各个部署单元、每个部署单元的实施元素。在J2EE中，即表示要将应用打成多少个包，每个包的名称以及每个包包含的源文件10. 据视图从永久性数据存储方面来对系统进行说明。假如几乎或根本没有永久性数据，或者设计模型与数据模型之间的转换并不重要，那么本节就为可选依据项目的实际状况，此节可以省略不写11. 小和性能说明软件中会对构架产生影响的主要尺寸特征，以及目标性能约束12. 质量说明软件构架如何促成诸如可扩展性、牢靠性、可移植性等全部系统力量（而非功能）的实现。假如这些特征具有特殊的意义（例如在平安性或保密性方面的意义），则应当对它们进行具体的说明13. 其它说明在此说明其它需要说明的内容14. 附录A指南在此包括设计指南、编程指南、部署和安装指南，其中在编程指南上不仅包括传统的诸如JAVA编程指南，还包括指导实现人员实现特定设计机制要留意的问题在此，推举加入链接引用相关文档15. 附录B法律规范在此包括设计法律规范、编程法律规范等在此，推举加入链接引用相关文档16. 附录C模版在此包括各种相关模版，比如框架模版、jsp模版、各种设计机制的模版等在此，推举加入链接引用相关文档17. 附录D示例在此供应示例，来演示架构如何进行交互在此，推举加入链接引用相关文档