C4-PlantUML 开源项目教程

C4-PlantUML 开源项目教程

C4-PlantUMLC4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures项目地址:https://gitcode.com/gh_mirrors/c4/C4-PlantUML

1. 项目目录结构及介绍

C4-PlantUML项目的目录结构如下：

• scripts: 包含用于处理和构建项目脚本。
• vscode: 提供Visual Studio Code相关的设置和代码片段。
• images: 存放与图表展示相关的图片资源。
• intellij: 针对IntelliJ IDEA的Live Templates配置。
• percy: 可能是用于持续集成的视觉比较工具Percy的相关内容。
• samples: 示例代码和用例。
• themes: 图表主题相关文件。
• gitattributes: Git属性文件。
• C4_puml, C4_Component_puml, C4_Container_puml, C4_Context_puml, C4_Deployment_puml, C4_Dynamic_puml, C4_Sequence_puml: 各种类型的C4模型定义文件。
• LICENSE: 许可证文件。
• LayoutOptions.md: 图形布局选项的说明文件。
• README.md: 项目简介和使用指南。

该项目提供了一组预定义的PlantUML语法，以便于创建C4模型（Context, Container, Component, Person）的软件架构图。

2. 项目的启动文件介绍

尽管这不是一个传统的执行程序项目，但要开始使用C4-PlantUML，你需要创建一个PlantUML文件并引入相关模版。例如，你可以创建一个新的.puml文件，然后引入如下的模版：

@startuml
include <c4/C4_Context.puml>
@enduml

这样可以利用C4_Context.puml中的定义来绘制上下文图。你可以根据需要选择不同的C4_*.puml文件来绘制不同类型的架构图。

3. 项目的配置文件介绍

在C4-PlantUML中，配置文件主要体现在环境设置和代码编辑器的个性化配置上：

• VSCode配置:

  • "plantuml.jarArgs": 在VSCode的settings.json中添加这个配置项，比如设置"-DRELATIVE_INCLUDE= "，可以使PlantUML使用相对路径查找包含的文件。

• IntelliJ IDEA配置:

  • 下载c4_live_template.zip，导入到IDE设置中，启用Live Templates，重启IntelliJ以使用自定义的模板。

通过这些配置，你可以方便地在各自的开发环境中进行代码补全和快捷键操作，提高绘图效率。

相关命令示例

• 使用本地PlantUML.jar文件:

  java -jar plantuml.jar -DRELATIVE_INCLUDE=" " your_file.puml
  

• 引用网络上的最新库版本：

  include <https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml>
  

以上就是C4-PlantUML项目的概览、启动文件的使用以及配置文件的解释。通过这个库，你可以更简单地绘制出软件系统的架构图。

C4-PlantUMLC4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures项目地址:https://gitcode.com/gh_mirrors/c4/C4-PlantUML