Azure-PlantUML

项目介绍：Azure-PlantUML

Azure-PlantUML 是一个工具包，旨在帮助用户使用 PlantUML 创建包含微软 Azure 组件的图形。它包含了 PlantUML 的精灵图（sprites）、宏（macros）和形态（stereotypes），可以让用户轻松设计出既美观又实用的 Azure 系统架构图。

项目的主要功能

形象化 Azure 组件

Azure-PlantUML 利用 Microsoft 官方的 Azure 架构图标，并手动补充了一些官方缺失的 Azure 服务符号。借助该工具，用户可以为他们的 Azure 系统创建令人印象深刻的图示，提高系统架构的可视性和可读性。

与 C4-PlantUML 集成

项目不仅限于单一的架构图创建，它还支持与 C4-PlantUML 的结合，从而可以生成用于描述大型系统架构的 C4 模型。这种模型可以帮助软件开发团队以不同的细节层次向不同类型的受众展示和讲述软件架构。

如何开始

为了开始使用 Azure-PlantUML，用户需要在 .puml 文件中包含特定的 !includes。这样便可以在图示中使用 Azure 服务宏。用户既可以在本地下载必要文件，也可以使用在线资源以确保使用的是随时更新的版本。

前置条件

用户需要在 Azure-PlantUML .puml 文件的顶端包含 AzureCommon.puml 文件。用户也可以选择下载并使用本地版本。

示例代码

简单的 "Hello World" 示例展示了如何在 PlantUML 中使用 Azure-PlantUML 定义 Azure 组件，并建立组件间关系：

@startuml Hello World
!define AzurePuml https://raw.githubusercontent.com/plantuml-stdlib/Azure-PlantUML/release/2-2/dist
!includeurl AzurePuml/AzureCommon.puml
!includeurl AzurePuml/Databases/all.puml
!includeurl AzurePuml/Compute/AzureFunction.puml

actor "Person" as personAlias
AzureFunction(functionAlias, "Label", "Technology", "Optional Description")
AzureCosmosDb(cosmosDbAlias, "Label", "Technology", "Optional Description")

personAlias --> functionAlias
functionAlias --> cosmosDbAlias

@enduml

这种代码不仅仅是示例，还可以根据项目的实际需求进行扩展和修改。

高级用法与样例

Azure-PlantUML 不仅支持简单示例，还可以用于创建复杂的架构图。项目展示了多个高级案例，比如 Azure IoT 参考架构中的有状态流处理模型和高度可扩展的 Web 应用程序架构示例。这些示例都是通过结合 C4-PlantUML 进行展示，提供对 Azure 系统进行深入且全面的建模方法。