シーケンス図を書くならテキストで書こう！PlantUMLが便利すぎる！
ソフトウェアを設計するときは、よくシーケンス図書きますよね?
ちょっと前までastahというソフトウェア使っていて、これはこれで便利だったんですが、Visual Studio Codeの拡張機能のPlantUMLを使ったら便利すぎたのでレポート。
PlantUMLをインストールしよう。
Atom版もあるようだが、私はVSCodeを普段使っているので拡張機能の検索から「PlantUML」で検索してインストールした。
機能を試してみよう。
インストールが完了したら、新規ファイルを開いて、おもむろに以下の３行を記述。
@startuml
Alice -> Bob: Authentication Request
@enduml記述したら、拡張子を.puにして保存しよう。
保存が完了したらAlt+dを押すとプレビュー画面が開いて以下のような画面が表示される。
書き方も直感的で覚えやすい。基本は対象を矢印->で繋ぐだけ。矢印を点線にしたい場合は、-->でOK。
下にもう少し複雑な例を載せる。
@startuml
Alice -> Bob: Authentication Request
Bob -> Bob: Check Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
この.puファイルをgitなどで管理しておけば、diffなどで修正点がすぐわかるのもポイント高いです。
さらにもっと複雑なシーケンス図にも対応してます。
豊富なサンプルが PlantUMLシーケンス図に乗っているので参考にしてください。
ちなみに、PlantUMLはシーケンス図だけでなくクラス図、アクティビティ図、ユースケース図もテキストで書けてしまうので今後また機会があれば紹介したいと思います。
書き方直感的で、書く機会も多いので、シーケンス図から初めてみるのがおすすめです。
よかったら「いいね」お願いします！
Text by Takashi Yoshida