はじめに
※本記事は、2024年5月に社内SNSへ投稿したPlantUMLの利用レポートをベースに、内容を整理・加筆したものです。
業務でアクティビティ図やユースケース図などのUMLを作成する機会があり、今回初めてPlantUMLを利用しました。
約1か月半ほど実際に使ってみたところ、多くのメリットがある一方で、コードベースならではの課題も見えてきました。本記事では、PlantUMLの概要や実際に利用した感想、メリット・デメリットについて紹介します。
UML作成ツールを探している方や、PlantUMLが気になっている方の参考になれば幸いです。
PlantUMLとは？
PlantUMLとは、テキスト形式のコードを書くだけでUML図を作成できるオープンソースのUML描画ツールです。
一般的なUML作成ツールでは、図形をドラッグ&ドロップして作図しますが、PlantUMLではコードを記述することで以下のような図を作成できます。
- アクティビティ図
- ユースケース図
- シーケンス図
- クラス図
- ER図
- コンポーネント図
また、Visual Studio Code（VSCode）などのエディタと連携することで、リアルタイムプレビューも可能です。
PlantUMLを使い始めたきっかけ
アクティビティ図を作成する必要があり、「無料で使える良いUML作成ツールはないか」と探していたところ、社内SNS内でPlantUMLを知りました。
調べていくうちに、
- コードでUMLを書ける
- Gitで管理しやすい
- 無料で利用できる
という点に魅力を感じ、実際に利用してみることにしました。
特にGitでバージョン管理しやすい点は大きなメリットです。図の変更履歴をコードとして管理できるため、レビューや差分確認が容易になります。
PlantUMLの良かった点
実際に利用してみて、特に良いと感じたポイントは以下の通りです。
1. 作成者による品質のばらつきが少ない
PlantUMLはコードから自動で図を生成するため、手作業で配置するツールと比較すると、作成者によるデザインの差が出にくいです。
チーム内で複数人が図を作成する場合でも、一定の品質を維持しやすいと感じました。
2. Gitとの相性が良い
PlantUMLのファイルはテキストベースです。
そのため、
- Gitで差分管理できる
- コードレビューがしやすい
- ブランチ運用ができる
といった、ソフトウェア開発で当たり前に行われている運用をそのまま適用できます。
3. 作図スピードが速い
慣れてしまえば、図形を配置して線を引く作業よりも、コードを書いた方が速く作成できる場合があります。
また、マウス操作がほとんど不要なため、キーボードだけで作業を進められる点も快適でした。
4. リアルタイムプレビューが便利
VSCodeの拡張機能を利用すると、コードを書きながらリアルタイムで図を確認できます。
修正結果を即座に確認できるため、試行錯誤しながら効率よく作図できます。
5. 多様な形式で出力できる
作成した図を以下のような形式で出力できます。
- PNG
- SVG
- その他画像形式
資料作成や設計書への貼り付けも容易です。
PlantUMLのデメリット
一方で、PlantUMLならではの課題もありました。
1. 思い通りのレイアウトにならない場合がある
最も気になった点はこれです。
PlantUMLは自動レイアウトを行うため、
- 線とアクションが重なる
- ノードの位置が想定と異なる
- 図全体のバランスが崩れる
といったことがあります。
特にアクティビティ図でスイムレーンを使用した際に発生しやすい印象でした。
バランスが悪くなる例
2. 直感的な操作は難しい
GUIツールであれば図形を配置するだけで作図できますが、PlantUMLでは記法を覚える必要があります。
そのため、初めて利用する場合は学習コストが発生します。
3. 記法を調べる必要がある
簡単な図であれば問題ありませんが、複雑なアクティビティ図やシーケンス図を作成する際は、都度公式ドキュメントを確認する場面がありました。
プログラミング経験がある人であれば比較的習得しやすいですが、初心者には少しハードルがあるかもしれません。
レイアウト崩れを改善する方法
PlantUMLのレイアウト問題を改善する方法として、label 任意の名称 を利用する手法があります。
線とアクションが重なってしまう場合に、意図的に余白を作ることで、見やすいレイアウトに調整できます。
線とアクションが重なっている例
labelを利用して改善した例
labelを利用すると、実際には表示されないノードのような役割を果たし、図の配置を微調整できます。
ただし、この方法を多用するとコードが読みにくくなるため、必要な場面だけで利用するのがおすすめです。
PlantUMLのメリット・デメリットまとめ
メリット
- 誰が作成しても似た品質の図になる
- Gitでバージョン管理しやすい
- 多様な形式でエクスポートできる
- 作図速度が速い
- マウス操作が少なくて済む
- リアルタイムプレビューが可能
- VSCode環境なら共同編集もしやすい
デメリット
- レイアウトが思い通りにならない場合がある
- 直感的な作図は難しい
- 記法を覚える必要がある
まとめ｜PlantUMLはこんな人におすすめ
約1か月半PlantUMLを利用してみた結論としては、非常に良いツールでした。
確かに、GUIベースのUMLツールのように自由自在なレイアウト調整はできません。しかし、それ以上に以下のメリットが魅力的でした。
- 無料で利用できる
- Git管理との相性が良い
- 作図スピードが速い
- チーム全体で品質を統一しやすい
また、コード自体もそれほど難しくなく、プログラミング経験がある方であれば比較的スムーズに習得できると思います。
UML作成ツールを探している方は、ぜひ一度PlantUMLを試してみてください。
また、「PlantUMLより使いやすい」「こんなツールもおすすめ」というものがあれば、ぜひ教えていただけるとうれしいです。
PlantUMLサイト
PlantUMLが気になった方は、以下のサイトをご覧ください。