Mac 配置 PlantUML

PlantUML簡介

UML: Unified Modeling Language 統一建模語言,是非專利的第三代建模和規約語言。
UML是一種開放的方法，用於說明、可視化、構建和編寫一個正在開發的、面向對象的、軟件密集系統的製品的開放方法。（來自wikipedia）

PlantUML 使用簡單的可讀文本描述語句來繪製圖表。須要注意的是，它並不會阻止你繪製相互矛盾的圖表（好比，有兩個相互繼承的類），因此與其說它是一個建模工具，不如說它是一個繪圖工具。（來自PlantUML官網What's the goal of PlantUML ?）

一.所需環境

• JDK(Java SE Development Kit)
• graphviz
• Visual Studio Code(或者sublime, Chrome, eclipse, AndroidStudio, Intellij...更多)

二.配置

1.安裝JDK

• 檢測是否已安裝JDK 終端輸入

java -version
複製代碼

沒有安裝的話會彈窗

點擊更多信息，進入JDK下載頁

點擊DOWNLOAD

進入下載頁面

點擊接受條款，再點擊。dmg的連接下載

因爲某些緣故Oracle下載JDK奇慢，你能夠使用華爲JDK鏡像源，找到最新的版本下載便可
關於JDK環境變量配置能夠參照 macOS下JDK11安裝及環境變量配置總結

安裝配置完成後，終端跑一下

java -version
複製代碼

會是下圖的樣子

2.安裝graphviz

graphviz 是一個開源的額圖片渲染庫，能夠將PlantUML腳本轉換成圖片。

終端中輸入

brew install graphviz
複製代碼

有好幾個依賴包會下，因此須要一些時間，耐心等待

3.VSCode安裝plantUML插件

• 打開VSCode
• ⌘(command) + shift + X打開擴展，搜索PlantUML
• 選擇星最多的，通常就第一個

• install

4.使用

• 新建一個文件
• 輸入樣例

@startuml

title 時序圖

== 鑑權階段 ==

Alice -> Bob: 請求
Bob -> Alice: 應答

== 數據上傳 ==

Alice -> Bob: 上傳數據
note left: 這是顯示在左邊的備註

Bob --> Canny: 轉交數據
... 不超過 5 秒鐘 ...
Canny --> Bob: 狀態返回
note right: 這是顯示在右邊的備註

Bob -> Alice: 狀態返回

== 狀態顯示 ==

Alice -> Alice: 給本身發消息

@enduml
複製代碼

保存文件爲test.wsd

• alt + D右側便可渲染出UML圖

三.其餘開發工具使用PlantUML配置

• 在AndroidStudio中使用PlantUML(for Mac)

• Mac使用Sublime + PlantUML高效地畫圖

• Mac環境下，Intellij IDEA中安裝使用PlantUML畫時序圖

• PlantUML Viewer Chrome 插件 畫時序圖

• Information about the PlantUML Eclipse Plugin

• 用Atom在Mac OS X 下編輯PlantUML

END