C4-PlantUML

项目介绍：C4-PlantUML

项目概述

C4-PlantUML 是一个开源项目，它将 PlantUML 与 C4 模型结合，提供了一种直观的方法来描述和沟通软件架构。这一工具特别适用于初期设计阶段的讨论。通过使用开源和平台无关的工具，C4-PlantUML 提供了一个简单的方式来进行软件架构设计和交流。

项目功能

C4-PlantUML 提供了宏、类型化（stereotypes）、以及其他有用的工具（如 VSCode 代码片段）来辅助创建 C4 图表。项目所支持的图表类型包括：

• 系统上下文图和系统景观图
• 容器图
• 组件图
• 动态图
• 部署图
• （C4 风格的）序列图

此外，它还支持各种关系类型、布局选项、以及自定义标签/类型化，用户可以使用这些特性创建丰富多样的软件架构图。

如何开始

要使用 C4-PlantUML，用户需在其 .puml 文件的顶部包含相关的 C4 模块文件（如 C4_Context.puml、C4_Container.puml 或 C4_Component.puml）。该项目同时支持离线和在线两种使用方式：

• 离线使用：用户可以下载相关文件并通过命令行参数 -DRELATIVE_INCLUDE="." 来使用。
• 在线使用：用户可以直接包含 GitHub 上的最新版本文件（例如 !include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml）。

创建示例图

通过包含 C4_Container.puml 文件，用户可以定义 C4 特定的元素，如 Person、Container、System 和 Relationship 等。以下是一个简单的容器图示例：

@startuml Basic Sample
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml

Person(admin, "Administrator")
System_Boundary(c1, "Sample System") {
    Container(web_app, "Web Application", "C#, ASP.NET Core 2.1 MVC", "提供用户比较多个 Twitter 时间线的功能")
}
System(twitter, "Twitter")

Rel(admin, web_app, "Uses", "HTTPS")
Rel(web_app, twitter, "Gets tweets from", "HTTPS")
@enduml

视觉元素

C4-PlantUML 允许为实体添加图标或精灵（sprites），并提供能用于设计链路和关系的装饰性标签。用户还可以通过标签解释器展示一个计算出的图例。

完善设计

为满足不同用户的需求，该项目提供了包括元素和关系的自定义属性、全局布局选项、以及 IntelliJ 和 VSCode 的代码片段支持等多种扩展功能。

版本及许可证

C4-PlantUML 是基于 MIT 许可证发布的，遵循开源原则。提供最新的版本信息和变更日志，确保用户能够及时获取项目的更新。

通过 C4-PlantUML，用户能够高效地创建设计图表，帮助开发团队更好地理解和构建软件系统。这一工具不仅提高了开发效率，还促进了团队间的沟通与协作。