如何在 PhpStorm 繪製 UML?

PlantUML 讓我們可以使用文字檔的方式描述 UML，且可以直接在 PhpStorm 內使用，非常方便。

Version

macOS 10.12.4
PhpStorm 2017.1.2
Graphviz 2.40.1
PlantUML Integration Plugin 2.5.0

安裝 Graphviz

我們必須透過 Graphviz 顯示 puml 格式檔案，因此必須先安裝 Graphviz。

1
2

$ brew update
$ brew install graphviz

透過 Homebrew 安裝 Graphviz。

安裝 PlantUML Plugin

為了在 PhpStorm 直接編輯與預覽 puml 格式檔案，須先安裝 PlantUML Integration Plugin。

PhpStorm -> Preferences -> Plugins

按 Browse repositories…。

輸入 PlantUML，選擇 PlantUML Integration，按 Install 安裝。

安裝完需按 Restart PhpStorm 重新啟動。

按熱鍵 Command + N，若出現 UML Activity 、UML Class 等圖，則表示安裝成功。

能在 PhpStorm 順利顯示 puml 格式的 UML 檔案。

Conclusion

• 由於 puml 格式基本上為文字檔，所以可以透過 Git 做版控管理。
• 為了 code review 方便，可將 puml 格式匯出成 svg 格式，放大縮小不會失真。

Reference

PlantUML in a nutshell
Install graphviz on Mac OSX