PlantUML を使った UML の描き方 - PlantUML 言語リファレンスガイド(Version 1.2021.1)

• 语言: 日语
• 格式: .pdf
• 来源: pdf.plantuml.net

摘要

PlantUML は、さまざまな種類の UML ダイアグラムを含む、多様な図を素早く作成するためのコンポーネントです。ネットワーク図 (nwdiag) は、シンプルでわかりやすい文法を採用しており、複数のアドレスの定義やノードのグルーピングが可能です。PlantUML には前処理機能が搭載され、変数の定義や標準ライブラリの活用が可能です。また、AWS、Azure などのクラウドサービスと連携し、高度な設計図の作成が可能となっています。

AI总结

### PlantUML 言語リファレンスガイド (Version 1.2021.1) 总结

#### 1. PlantUML 概述
- **PlantUML** 是一个用于快速生成各种 UML 图示意图的工具，支持以下主要图表类型：
- **UML 图**：包括序列图、用例图、类图、对象图、活动图、组件图、部署图、状态转换图（状态机图）、时序图和协作图。
- **非 UML 图**：包括 JSON 数据图、网络图（nwd）、Wireframe 架构图、SDL 图、Ditaa 图、甘特图、思维导图、WBS 图、数学记法（支持 AsciiMath 和 JLaTeXMath）等。
- **特点**：语法简单直观，支持多种扩展库和自定义样式。

---

#### 2. 网络图 (nwd)
- **nwdig** 是由小宫健开发的网络图生成工具，语法简单，已集成到 PlantUML 中。
- **示例**：
- **简单网络图**：

    @startuml
    nwdiag {
      network dmz { address = "210.x.x.x/24"; web01 [address = "210.x.x.1"); }
      network internal { address = "172.x.x.x/24"; web01 [address = "172.x.x.1"); }
    }
    @enduml

- **多地址定义**：

    @startuml
    nwdiag {
      network dmz { address = "210.x.x.x/24"; }
      web01 [address = "210.x.x.1, 210.x.x.20");
    }
    @enduml

- **节点分组**：

    @startuml
    nwdiag {
      group web { web01 [address = ".1"]; web02 [address = ".2"]; }
      network Sample_back { address = "192.168.20.0/24"; }
    }
    @enduml

---

#### 3. 前处理功能
- **变量定义**：
- 推荐使用 `$` 开头定义变量，支持整数和字符串类型。
- 示例：

    @startuml
    !$ab = "foo1"
    !$cd = "foo2"
    !$ef = $ab + $cd
    Alice -> Bob : $ab
    @enduml

- **宏处理**：
- 旧的宏定义（如 `!define` 和 `!definelong`）已逐步弃用，建议使用新的 `!function`、`!procedure` 或变量定义。
- 新的前处理功能支持多文件包含和日期函数。

---

#### 4. 标准ライブラリ
- PlantUML 提供多个扩展库，支持以下功能：
- **AWS**：支持 AWS 架构图标和组件。
- **Azure**：支持 Microsoft Azure 的图标和组件。
- **Kubernetes**：支持 Kubernetes 相关图标。
- **Math**：支持 AsciiMath 和 JLaTeXMath 的数学公式。
- **Ditaa**：支持 ASCII 艺术图转换为矢量图。
- **SDL**：支持规格与描述语言（SDL）的图绘制。

- **使用方法**：
- 通过 `!include` 命令引入扩展库文件，例如：

    !include 
    !include 

---

#### 5. 数学记法
- **AsciiMath**：
- 使用 `@startAsciiMath` 和 `@endAsciiMath` 包裹数学公式。
- 示例：

    @startAsciiMath
    sum_{i=0}^{n-1}(a_i + b_{i^2})
    @endAsciiMath

- **JLaTeXMath**：
- 使用 `@startlatex` 和 `@endlatex` 包裹 LaTeX 公式。
- 示例：

    @startlatex
    \sum_{i=0}^{n-1}(a_i + b_i^2)
    @endlatex

---

#### 6. 皮肤参数
- **Skin Parameters**：
- 通过 `skinparam` 可以自定义图表样式，例如颜色、字体、箭头样式等。
- 参考文档：[Ashley's PlantUML Doc](https://plantuml-documentation.readthedocs.io/en/latest/formatting/all-skin-params.html)

---

#### 7. 其他注意事项
- **依赖管理**：
- 使用 GraalVM JavaScript 引擎替代 Nashorn，以避免 Java 11+ 中的警告。
- JLaTeXMath 需要额外的 JAR 文件支持。

---

### 总结
PlantUML 是一个功能强大的图表生成工具，支持多种图表类型和扩展库，语法简单直观。通过网络图、数学公式、变量定义等功能，用户可以高效地创建各种可视化图表。