PlantUML 入門教程：像寫代碼一樣畫圖
我們都知道軟件工程中有各種 UML 圖，例如：用例圖、時序圖等等。很多時候我們都用 ProcessOn 或者 draw.io 這些畫圖工具來畫圖，但它們存在這樣一個問題：樣式多樣不標準化、需要拖拖拽拽效率低等問題。
其實這些問題和我們用 Word 時類似，于是就有了 Markdown 的誕生。于是我想：能不能像寫代碼一樣去畫圖呢？果不其然，你能想到的東西古人可能早就已經想到，甚至已經實現了！實際上有一個名為 PlantUML 的畫圖組件，它能讓你用代碼的方式畫 UML 圖。
這篇文章將簡單介紹下 PlantUML，并介紹如何用 PlantUML 進行畫圖，最后介紹如何用 PlantUML 畫幾個常見的 UML 圖。
什么是 PlantUML？
PlantUML 是一個可以讓你快速編寫 UML 圖的組件，這是官網對于 PlantUML 的介紹。它可以讓你編寫如下常見的 UML 圖：
- 順序圖
- 用例圖
- 類圖
- 對象圖
- 活動圖 (舊語法)
- 組件圖
- 部署圖
- 狀態圖
- 時序圖
除此之外，它還支持一些非 UML 圖形，如：
- JSON 數據
- YAML 數據
- 網絡圖 (nwdiag)
- 線框圖形界面或 UI 模擬（Salt）
- 架構圖
- 規范和描述語言（SDL）
- Ditaa 圖
- 甘特圖
- 思維導圖圖示
- 工作分解結構圖（WBS）
- 用 AsciiMath 或 JLaTeXMath 符號進行數學計算
- 實體關系圖 (IE/ER)
關于 PlantUML 的更多信息，可以通過查閱 PLantUML 官網來獲取。
如何使用 PlantUML？
使用 PlantUML 畫圖有兩種方式，一種是使用 PlantUML 官網的在線編輯器，另一種是使用 IDEA IntelliJ 的插件來編寫。一般來說使用 Intellij 會更方便一些，可以保存畫圖代碼，以及實時查看效果，復制生成的圖片。因此，我們這次重點介紹如何如何使用 IDEA Intellij 來畫 UML 圖。
安裝插件
使用 PlantUML 畫圖，只需要在 IDEA 中安裝 PlantUML Integration 插件即可，如下圖所示：
安裝完成后重啟 IDEA 即可。
基本語法
PlantUML 文件以 .puml 為后綴，我們只需新建一個 .puml 文件即可。對于 .puml 文件而言，其格式以 @startuml 開始，以 @enduml 結束，還可以使用 title 設置 UML 圖的標題，用 ' 單引號插入代碼注釋。一個基本的 PlantUML 圖的代碼框架如下所示：
@startuml
title: 標題
' 注釋（用一個單引號標識）
' UML 圖邏輯
@enduml
不同類型的 UML 圖語法不同，建議用到對應 UML 圖的時候去翻閱 PlantUML 官網，現學現用效率最高了，沒必要強行記住。
常用 UML 圖范例
這里列出幾個我常用到的 UML 圖，并分享一個代碼范例，可以方便大家編寫畫圖。對于我來說，我常用的是用例圖、時序圖、ER 圖。
用例圖
用例圖是用戶與系統交互的最簡表達形式，它展示了用戶和其他相關用例的關系。簡單地說，通過用例圖我們可以知道用戶與系統、系統與系統之間的功能。如下是一個博客系統管理后臺的用例圖：
其對應的代碼如下所示：
@startuml
' https://plantuml.com/use-case-diagram
title 文章管理用例圖
left to right direction
用戶 --> 文章管理
rectangle 文章管理{
(文章管理) --> (查詢文章列表):<<include>>
(文章管理) --> (新增文章):<<include>>
(文章管理) --> (查看文章內容):<<include>>
(文章管理) --> (修改文章內容):<<include>>
}
用戶 --> 分類管理
rectangle 分類管理{
(分類管理) --> (查詢分類列表):<<include>>
(分類管理) --> (分類文章):<<include>>
(分類管理) --> (查看分類):<<include>>
(分類管理) --> (修改分類):<<include>>
}
@enduml
注意在 Mac 上使用 PlantUML 需要安裝 Graphviz 軟件，如果上述代碼無法正常渲染出圖形，那有可能是本機沒裝 Graphviz 軟件，可以參考這篇文章解決：Can't render component diagram with PlantUML in IntelliJ - Stack Overflow
時序圖
時序圖用來標識某個操作的整個流程，通過時序圖可以很清晰地知道某個操作的全流程，以及相關的參與方。如下是修改文章內容接口的時序圖：
上圖對應的代碼如下所示：
@startuml
'https://plantuml.com/sequence-diagram
title 修改文章內容時序圖
autonumber
participant 用戶
participant 前端頁面
participant 管理后臺
用戶 -> 前端頁面: 點擊修改文章按鈕
前端頁面 -> 前端頁面: 修改文章內容
前端頁面 -> 管理后臺: 發出請求
管理后臺 -> 管理后臺: 業務邏輯操作
管理后臺 -> 前端頁面: 返回請求結果
@enduml
ER 圖
ER 圖是用來表示數據庫實體關系的圖形，通過 ER 圖可以快速弄清楚實體之間的關系。如下是文章、分類、標簽的 ER 圖，連線有分叉表示是 N，沒分叉則表示是 1，例如 category 與 posts 是 1:N 的關系。
上圖對應的代碼如下所示：
@startuml
title 文章、分類、標簽 ER 圖
entity category {
* id: number <<generated>>
---
* name: varchar
}
entity posts {
* id: number <<generated>>
---
* category_id <<FK>>
}
entity tags {
* id: number <<generated>>
---
* name: varchar
}
' category:posts = 1:N
category ||--|{ posts
' posts:tags = N:N
posts }|--|{ tags
@enduml
對于 ER 圖而言，比較復雜的是實體間關系的表示。實際上，PlantUML 定義了幾個標識來實現這個功能。其大致規則如下：
- 中間用 -- 隔開
- 如果對應關系是 1 的話，那么使用 || 表示。
- 如果對應關系是 N 的話，那么使用 |{或}| 表示，大括號朝向的那一邊表示 N。
- 例如：category 與 posts 是 1:N 的關系，那么久用 category ||--|{ posts 表示。
總結
對于 PlantUML 而言，一開始只需要安裝插件搭建好本地的運行環境，隨后掌握 PlantUML 的基本語法即可。接著，根據自身需要去學習對應 UML 圖的語法，活學活用即可。
