依赖项关系图：指南

  • 项目

通过在 Visual Studio 中创建依赖项关系图来概要说明应用的体系结构。 若要确保你的代码与此设计保持一致，请使用依赖项关系图验证代码。 还可以在生成过程中包括层验证。

若要查看支持此功能的 Visual Studio 的版本，请参阅 体系结构和建模工具的版本支持。

注意

从 Visual Studio 2019 16.2 版开始，支持 .NET Core 项目的依赖项关系图。

依赖项关系图是什么？

类似于传统的体系结构示意图，依赖项关系图标识设计的主要组件或功能单元及其相互依赖关系。 关系图中的每个节点称为层，表示逻辑组的命名空间、项目或其他项目。 您可以绘制出您的设计中存在的依赖关系。 与传统的体系结构关系图不同的是，您可以验证源代码中的实际依赖关系符合您指定的预期依赖关系。 通过将验证作为 Team Foundation Server 上常规生成的一部分，可以确保程序代码在将来的更改中继续遵循系统的体系结构。 请参阅依赖项关系图：参考。

如何用依赖项关系图设计或更新应用

以下步骤概述了如何使用开发过程中的依赖项关系图。 本主题中的后面几节描述了有关每个步骤的更多详细信息。 如果你正在开发新的设计，请忽略引用现有代码的步骤。

注意

这些步骤按大致顺序显示。 您可能需要重叠任务、重新排序它们以符合您自己的具体情况，并在项目中的每个迭代开始时重新访问它们。

  1. 为整个应用程序或其中的一个层创建依赖项关系图。

  2. 定义层以表示应用程序的主功能区或组件。 按其功能命名这些层，例如“演示文稿”或“服务”。 如果你有 Visual Studio 解决方案，则可以将每个层关联到项目的集合，如项目、命名空间、文件等。

  3. 发现各层之间的当前依赖关系。

  4. 编辑层和依赖项以显示希望代码反映的更新的设计。

  5. 通过创建层以表示主要的体系结构块或组件，并定义依赖关系以显示每个层相互使用的方式，以此设计应用程序的新区域。

  6. 编辑关系图的布局和外观以帮助你与同事进行讨论。

  7. 对依赖项关系图进行代码验证以突出显示代码与你需要的体系结构之间的冲突。

  8. 更新代码以符合你的新体系结构。 以迭代方式开发和重构代码，直到此验证不再显示有冲突。

  9. 在生成过程中包括层验证以确保代码继续遵循你的设计。

创建依赖项关系图

必须在建模项目内创建依赖项关系图。 可以将新的依赖项关系图添加到现有建模项目、为依赖项关系图创建新的建模项目或在同一建模项目中复制现有依赖项关系图。

重要

不要将现有依赖项关系图从一个建模项目添加、拖动或复制到另一个建模项目或解决方案中的其他位置。 以这种方式中复制的依赖项关系图将具有与原始关系图相同的引用，即使你修改了关系图。 这将阻止层验证正常操作，并可能导致出现其他问题，例如，尝试打开该关系图时元素缺失或出现其他错误。

请参阅通过代码创建依赖项关系图。

定义表示功能区域或组件的层

层表示项目的逻辑组，如项目、代码文件、命名空间、类和方法。 可以从 Visual C# 和 Visual Basic 项目创建层，也可以通过链接文档（如 Word 文件或 PowerPoint 演示文稿）将规范或计划附加到层。 每一层显示为关系图上的一个矩形，并显示链接到它的项目数。 一个层可以包含描述更具体任务的嵌套的层。

一般原则是按其功能命名层，例如“演示文稿”或“服务”。 如果这些项目依赖关系紧密，则将它们放在同一层。 如果可以分别更新或在单独的应用程序中使用这些项目，请将它们放在不同的层中。

提示

有某些类型的可链接到层的项目，但是不支持对依赖项关系图进行验证。 要查看该项目是否支持验证，请打开“层资源管理器”检查项目链接的“支持验证”属性。 请参阅发现各层之间的现有依赖关系。

更新不熟悉的应用程序时，你也可以创建代码图。 这些关系图可以帮助你在浏览代码时发现模式和依赖项。 使用解决方案资源管理器来浏览命名空间和类，它们通常与现有层具有很好的对应关系。 通过将代码项目从解决方案资源管理器拖动至依赖项关系图来对其进行分配。 然后可以使用依赖项关系图来帮助你更新代码，并使其与你的设计保持一致。

请参阅：

发现各层之间的现有依赖关系

只要与一个层关联的项目引用与另一个层关联的项目，就存在依赖关系。 例如，一个层中的某个类声明了一个拥有其他层中的某个类的变量。 您可以对它们实施反向工程来发现现有依赖关系。

注意

无法为某些种类的项目对依赖关系进行反向工程处理。 例如，对于链接到文本文件的层，将不会对源自或指向该层的依赖关系进行反向工程处理。 若要查看哪些项目具有可进行反向工程处理的依赖项，右键单击一个或多个层，然后单击“查看链接”。 在“层资源管理器”中，检查“支持验证”列 。 对于此列显示“False”的项目，将不会对依赖关系进行反向工程处理。

为对层之间的现有依赖关系进行反向工程

选择一个或多个层，用鼠标右键单击所选的层，然后单击“生成依赖项”。

通常，您会看到一些不应存在的依赖关系。 可以编辑这些依赖关系，使它们与预期的设计对齐。

编辑层和依赖项以显示预期的设计

若要说明准备对系统或计划的体系结构进行的更改，请使用以下步骤来编辑依赖项关系图。 你还可以考虑进行一些重构的更改，以提高代码的结构，然后再扩展。 请参阅改进代码的结构。

To 执行这些步骤
删除不应存在的依赖项 单击依赖项，然后按“删除”。
更改或限制依赖项的方向 设置它的“方向”属性。
创建新的依赖项 使用“依赖项”和“双向依赖项”工具 。

若要绘制多个依赖关系，请双击该工具。 完成操作后，单击“指针”工具或按 ESC 键。
指定与层关联的项目不能依赖于指定的命名空间 在层的“Forbidden Namespace Dependencies”属性中键入命名空间。 使用分号 (;) 分隔多个命名空间。
指定与层关联的项目必须不属于指定的命名空间 在层的“Forbidden Namespaces”属性中键入命名空间。 使用分号 (;) 分隔多个命名空间。
指定与层关联的项目必须属于某个指定的命名空间 在层的“Required Namespaces”属性中键入命名空间。 使用分号 (;) 分隔多个命名空间。

改进代码的结构

重构更改的改进不会影响应用程序的行为，但有助于使代码在将来更易于更改和扩展。 结构良好的代码的设计容易抽象化为依赖项关系图。

例如，如果你为代码中的每个命名空间创建图层，然后进行反向工程处理依赖关系，各层之间应该有单向依赖项的最小集。 如果您使用类或方法创建更详细的关系图作为您的层，则结果也将具有相同的特征。

如果不是这样，代码将会更加难以在其生命周期中更改，并且将不太适用于使用依赖项关系图进行验证。

设计应用程序的新区域

当你启动开发新项目或新项目中的新区域时，你可以绘制层和依赖项，以帮助你在开始开发代码之前标识主要组件。

  • 如果有可能，在依赖项关系图中显示可识别的体系结构模式。 例如，描述桌面应用程序的依赖项关系图可能包括演示文稿、域逻辑和数据存储等层。 涵盖应用程序的单个功能的依赖项关系图，可能有模型、视图和控制器等一些层。

  • 为每一层如命名空间、类或组件创建代码项目。 这样，就更容易跟踪代码，并把代码项目链接到层。 当你创建每个项目时，将其链接到相应的层。

  • 如你已经链接到层的命名空间，无需将大多数类和其他项目链接到层，因为它们归属于较大的项目。

  • 为新功能创建新关系图。 通常情况下，将有一个或多个依赖项关系图来描述整个应用程序。 如果您正在设计应用程序的新功能，请勿添加或更改现有的关系图。 相反，创建你自己的关系图来反映代码的新部分。 新关系图中的图层可能包括演示文稿、域逻辑和新功能的数据库层。

    在生成应用程序时，将同时对整体的关系图和更详细的功能关系图验证你的代码。

编辑演示和讨论的布局

为了帮助你识别层和依赖项或与团队成员对其进行讨论，你可以按以下方式编辑关系图的外观和布局：

  • 更改图层的大小、 形状和位置。

  • 更改层的颜色和依赖项。

    • 选择一个或多个层或依赖项，单击右键，然后单击“属性”。 在“属性”窗口中，编辑“颜色”属性。

比对关系图验证代码

编辑关系图之后，可以对照代码随时手动验证关系图，也可以在每次生成时进行自动验证。

请参阅：

更新代码以符合新体系结构

通常情况下，当你将验证更新后的依赖项关系图的代码时，将出现第一次错误。 这些错误可能有几个原因：

  • 将项目指派给了错误的层。 在这种情况下，请移动项目。

  • 项目（例如类）以与你的体系结构相冲突的方式使用了其他类。 在这种情况下，请重构代码以移除依赖关系。

若要解决这些错误，请更新代码，直至验证过程中不出现其他错误为止。 这通常是一个迭代过程。 有关这些错误的详细信息，请参阅对照依赖项关系图验证代码。

注意

在开发或重构代码时，可能有新项目要链接到依赖项关系图。 但是，这可能不是必要的，例如，当你的层表示现有命名空间时，而且新代码只是向这些命名空间中添加更多的材料。

在开发过程中，你可能需要在验证期间禁止显示报告的某些冲突。 例如，你可能希望禁止显示你已解决或与特定情形不相关的错误。 抑制错误时，最好在 Team Foundation 中记录工作项。 若要执行此任务，请参阅使用依赖项关系图验证代码。

在生成过程中包括层验证

若要确保将来更改的代码符合依赖项关系图，请把层验证包含到你的解决方案的标准生成过程中。 在其他团队成员生成解决方案时，代码的依赖关系和依赖项关系图之间的差异将作为生成错误进行报告。 有关如何在生成过程中包括层验证的详细信息，请参阅对照依赖项关系图验证代码。

相关内容