目的
- MacからplantUMLを使えるようにする
- githubでUMLのバージョンを管理できるようにする
導入したい理由
- 設計時のモデリングなど、excelなどを使いがちだが、それだとバイナリのため、差分管理ができない
- リポジトリに上げると更新するたびに全部書き換えになって思い
- そもそもバージョン管理ができない管理がおろそかになりがちになってドキュメントが信用できなくなってくる
環境
- plantUML
- plantUML Viewer 0.7.1
手順
brewのトラブル対応
- brewで一発でダウンロードできる
- というが、ここで usr/local の権限でbrewが使えないという問題が発生したため、以下の方法で対処
- OSのバージョンの問題？なのか、最近この問題が発生し、対処が行われたらしい
brew update: /usr/local 権限周りの問題＝更新で解消
https://qiita.com/masa_36/items/a811c9335e2e985f6adc
インストールの実行
brew install graphviz
brew install plantuml
エディタ
-
Atom に PlantUML Vieweを導入する
-
パッケージからsetteing view画面を開く
-
plantumlで検索する
-
この二つのインストールを行う
-
コードを書き
@startuml
actor test
activate test
activate web
test -> web :order
activate business
web -> business : order
activate DB
business -> DB : search
DB -> DB : search recasive
business <-- DB :responce
deactivate DB
web <-- business :responce
deactivate business
test <-- web :responce
@enduml
control + opt + p
-
図の保存
-
画像ペイン上で右クリックで出力が可能
-
拡張子がデフォルトではeps担っているが、拡張子をpng等に変更すると、その形で出力が行われる
-
シーケンスずに限らず、ユースケース図、クラス図等の具体的な文法は、先行チートシートなどが参考にできる
- PlantUML Cheat Sheet
- https://qiita.com/ogomr/items/0b5c4de7f38fd1482a48
参考
PlantUMLをMac OS Xで使う
https://qiita.com/kohashi/items/1d2c6e859eeac72ed926
PlantUMLを自動変換してLiveプレビューしてくれるAtom拡張 PlantUML-Viewer がイイ！
http://pierre3.hatenablog.com/entry/2015/08/23/220217
PlantUML Cheat Sheet
https://qiita.com/ogomr/items/0b5c4de7f38fd1482a48