RUP软件文档模板-设计指南.doc

设计指南版本 注：以下提供的模板用于 Rational Unified Process。其中包括用方括号括起来并以蓝色斜体（样式=InfoBlue）显示的文本，它们用于向作者提供指导，在发布此文档之前应该将其删除。按此样式输入的段落将被自动设置为普通样式（样式=Body Text）。要定制 Microsoft Word 中的自动字段（选中时显示灰色背景），请选择 File Properties，然后将 Title、Subject 和 Company 等字段替换为此文档的相应信息。关闭该对话框后，通过选择 Edit Select All（或 Ctrl-A）并按 F9，或只是在字段上单击并按 F9，可以在整个文档中更新自动字段。对于页眉和页脚，这一操作必须单独进行。按 Alt-F9，将在显示字段名称和字段内容之间切换。有关字段处理的详细信息，请参见 Word 帮助。 Version: 设计指南 Date: 修订历史记录日期版本说明作者目录1.简介41.1目的41.2范围41.3定义、首字母缩写词和缩略语41.4参考资料41.5概述42.通用设计和实施指南43.数据库设计指南64.构架设计指南65.机制指南6设计指南1. 简介设计指南的简介应提供整个文档的概述。它应包括此设计指南的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。1.1 目的本文档的目的是说明将在设计系统时使用的设计标准、约定和代码模式。输入对设计指南目标的任何其他说明。1.2 范围简要说明此设计指南的适用对象；此文档所影响的对象。1.3 定义、首字母缩写词和缩略语本小节应提供正确理解此设计指南所需的全部术语、首字母缩写词和缩略语的定义。这些信息可以通过引用项目词汇表来提供。1.4 参考资料本小节应完整地列出此设计指南中其他部分所引用的任何文档。每个文档应标有标题、报告号（如果适用）、日期和出版单位。本节最终可能会分为若干个小节：外部文档与内部文档，或政府文档与非政府文档等。列出可从中获取这些参考资料的来源。这些信息可以通过引用附录或其他文档来提供。1.5 概述本小节应说明此设计指南中其他部分所包含的内容，并解释文档的组织方式。2. 通用设计和实施指南本节说明在设计和实施系统时所利用的原理与策略。在多数情况下，您将需要以下方面的策略： 从设计到实施的映射您必须在包和类这两个级别上指定如何将设计映射到实施。 指定子系统接口如果您是以自顶向下的方式开发系统，则务必要缩小子系统的可视接口。这使得开发人员能够更改子系统中那些无法从外部看到的部分。 记录操作务必要确定一种说明操作的标准方式。操作由名称、实参、简要说明和实施规约组成。记录操作时应考虑以下问题： -是否应该记录所有（形式）参数？尽管经验证明它们可能难以维护，但由于它们具有大量的代码，所以最好将它们记录下来。 -是否应该记录实参类型？一般情况下，最好将实参类型记录下来。 -是否应该将名称约定用于类中的操作？例如在 C+ 中，您可能会通过不同的方式来为私有操作和公共操作添加前缀。这使得操作更易于理解。 记录消息最好不要记录消息中的所有实参。实参具有大量的代码，可能会难于维护。 检测、处理和报告故障您必须制定故障管理的策略。该策略在很大程度上取决于您所选用的编程语言。许多编程语言都具有故障管理支持，例如 Ada 的“exceptions”（异常事件）。您所选用的故障管理策略将影响设计对象的行为。例如，您必须决定是在每次操作中都使用能表示该操作是否成功的状态参数，还是象在 Ada 中一样，让对象产生“异常事件”。 如有必要，您可对系统的不同部分应用不同的故障管理策略。重要的是，您至少要有一个策略，并且对于所有可能的策略，您都应该知道何时使用它们。 内存管理内存管理的目的是确保始终有内存可用。这意味着您要删除未被其他任何对象引用的对象，这样它们所占用的内存就可以供新的对象使用。具体的解决方法取决于实施语言。在有些系统中，这一问题将自动得以解决（例如通过垃圾收集器来解决）；但在其他系统中，您必须用编程语言亲自进行内存管理。也就是说，您将要指定在何时、以何种方式来清理未引用对象所占用的任何内存。 软件分布如果您的系统将分布在多个物理节点上，那么其对象也必须分布在这些节点上。在开始设计之前，您就应该为软件分布进行准备：即指定一般性的策略，用于指导如何分布对象，以及如何使用当前的进程间通信技术。如果对目标环境不熟悉，那么建立解决方案的原型可能会很有所帮助。 如何表示可复用的构件在开始设计之前，您必须决定将使用哪些可复用的构件、可复用的构件系统、库或“市售”(COTS) 产品。您还必须决定是否在设计中对它们进行建模以及建模的方式。 设计永久类理想情况下，您所选择的数据库管理系统（无论是关系型还是基于对象的数据库管理系统）不应该对设计模型造成很大的影响。永久性应该由能使永久性尽可能明显的框架来提供。大部分永久性设计工作都侧重于确定并解决性能问题。为了便于这种工作的进行，应确定以下内容：-确定各永久对象的生命周期，即它何时在用例实现中被创建、读取、更新和删除。 -确定用例实现中的事务边界。 在数据库设计和永久类设计之间存在某种迭代：视数据库而定，设计类之间的某些关联或是不便于在该数据库中支持，或是造成严重的性能问题，以致必须对设计模型进行一些修改。 故障管理 事务管理本节应讨论用来管理事务的策略，其中需包括实现事务管理的方式。还应讨论事务管理和故障管理之间的相互作用，包括系统如何从事务故障或异常终止的事务中恢复。如果存在由事务管理机制施加的特殊限制（例如 MTS 就需要“无状态”的对象），而且这些限制会影响系统的构架，则应在此处对它们进行讨论。 语言特性的特殊用法 程序结构 算法指南本节应该说明选择来供构架设计师在系统中使用的特定算法。本节还应说明这种算法的适用条件。本节不应记录某种算法在系统中的特定应用（这是在软件构架文档和设计模型中记录的内容），它的目的只是指导并约束设计员的选择。 硬件接口 系统修改和构建指南本节应该说明软件修改指南、所需的特殊支持硬件或软件，以及编辑、编译和集成等方面的指南。本节还可包括在“配置管理计划”中详细说明的配置与变更控制指南。 系统诊断指南本节应说明如何根据所采用的故障检测与管理策略来设置系统诊断问题的有关指南。本节将说明如何调用追踪，收集诊断数据，并说明可能要使用的所有特殊的诊断硬件和软件。3. 数据库设计指南本节提供数据库设计方面的规则和建议。应讨论以下主题： 从永久类到数据库结构的映射，包括如何处理潜在的冲突，例如设计模型中的多对多关联关系和继承关系。 从设计类属性到数据库原始数据类型的映射。 如何使用“进程 图”来说明数据在各节点上的物理分布。 数据库结构的命名约定（例如，表、已存储、已存储过程、触发器、表空间等）4. 构架设计指南本节提供在软件构架设计方面的规则和建议。它们按照不同的构架视图来组织，这些视图包括用例视图、逻辑视图、实施视图、进程视图和部署视图。这里的规则主要是分解操作的规则。例如，“实施视图”指南指定了将模块打包为子系统、将子系统分层等分解