PlanutUMLとは
PlantUMLはオープンソースのUML描画ツールです。ドメインモデル図やER図など様々なUMLを書くことができるツールで、コードベースで記述できることが特徴です。もちろん無料。
ずっとPlantUMLを使っていたのですが、最近プロジェクトの関係で少しLucidCartでUMLを作成していました。
ただ、Lucidだと
- ドキュメントをバージョン管理できない（履歴機能はあるけど重すぎて使い物にならない）
- 図の一部を消してしまったり、不注意によるミスが起こりやすい
- 動作が重い
などの問題があり、再びPlantUMLに戻ってきました。笑
最近サブスクで登録したGoLandにもPlantUMLを導入したかったので、その手順を解説していきます。
導入手順
それでは早速手順を解説していきます。
まずGoLandを開き、「GoLand」→「Settings...」をクリックします。
さらに「Plugin」をクリックし、検索欄で「PLantUML」と入力すると、下記添付写真のようにPLantUML Integrationというプラグインが表示されます。
Installをクリックし、実行します。
続いて、Homebrewを用いてgraphvizをインストールしていきます。こちらのインストールはしばらく時間がかかるため一旦待機します。
$ brew install graphviz
Homebrewでインストールできたら、dotのパスをGoLandに設定していきます。
再び「GoLand」→「Settings...」から設定を開き、左上の検索欄で「PlantUML」と検索し、PlantUMLの設定画面を表示します。
添付写真内に赤枠で囲っている「Graphviz executable:」に「/opt/homebrew/bin/dot」を入力します。
「OK」ボタンをクリックして、最後にGoLandを再起動させれば完了です。
動作確認
いつも通り右クリックをして、「New」にカーソルを当てると、下記写真のように「PlantUML File」というものが新たに作成されているので、こちらをクリックします。
ファイル名を尋ねられるので、適当名前をつけて作成します。
最後に作成したファイルをクリックし、画面右半分にUMLが表示されていることを確認できれば成功です。
あとはドキュメントを見ながら適宜UMLを作成していきましょう。