GoLandでPlantUMLを使って図を描く

はじめに

プロジェクトの構造やフロー図を視覚的に表現することは、システムを理解しやすくするのに有効です。 PlantUMLは、テキストベースで記述し、それを図にするツールです。 IDEでPlantUMLをインストールして設定する方法を紹介します。 環境はMacです。

必要な前提条件

前提条件として、以下が準備されていることを確認してください。

  • GoLand IDE(JetBrainのIDEであればほぼ同じ設定であるはず)
  • Homebrew(Graphvizのインストールに使用します)

PlantUML のインストール

プラグインの検索とインストール

GoLandを開き、「GoLand」→「Preferences」に進みます。

GoLandを開き、「GoLand」→「Preferences」に進みます。

「Plugins」セクションを開き、「Marketplace」タブを選択します。

「Plugins」セクションを開き、「Marketplace」タブを選択します。

検索バーに「PlantUML Integration」と入力し、検索結果からプラグインを見つけます。

検索バーに「PlantUML Integration」と入力し、検索結果からプラグインを見つけます。

「Install」ボタンをクリックしてプラグインをインストールし、完了したらIDEを再起動します。

「Install」ボタンをクリックしてプラグインをインストールし、完了したらIDEを再起動します。

Graphvizのインストール

Terminalを開き、以下のコマンドを実行してGraphvizをインストールします。

brew install graphviz

インストールが成功したことを確認するために、dot -v コマンドを実行してみます。

PlantUMLでの図の作成

新しい.pumlファイルをプロジェクトに追加します。 以下は簡単なシーケンス図の例です。

@startuml
Alice -> Bob: Hello Bob, how are you?
Bob --> Alice: I am fine, thanks!
@enduml

GoLandが図をリアルタイムでレンダリングし始めます。

GoLandが図をリアルタイムでレンダリングし始めます。

まとめ

PlantUML ライフを楽しみましょう!