コンテンツにスキップ

PlantUMLセットアップ

PlantUMLは、テキストベースの図表作成ツールです。テキストファイルに記述した図表の記述を元に、画像ファイルを生成します。

PlantUMLを使うことで、ソースコードの中に図表を記述することができるため、ソースコードと図表を一元管理することができます。

PlantUMLは、Javaで実装されているため、Javaがインストールされている環境であれば、どのOSでも利用することができます。

PlantUMLのインストール

PlantUMLは、以下の手順でインストールすることができます。

  1. Javaのインストール
  2. Graphvizのインストール

Graphvizは、PlantUMLの図表を描画するためのツールです。

Javaのインストール

Windowsの場合

AdoptOpenJDKからJavaをダウンロードしてインストールします。

Ubuntuの場合

jdkのバージョンは、11以上を推奨します。インストール可能なバージョン一覧はapt-cache search openjdkで確認できます。

1
2
sudo apt update
sudo apt install openjdk-21-jdk

Graphvizのインストール

jdk11以降の場合は、Graphvizのインストールは必須ではありません。 ただし、PlantUMLの図表を描画するためには、Graphvizが必要です。 そのため、Graphvizをインストールすることをおすすめします。

Windowsの場合

Graphvizからインストーラをダウンロードしてインストールします。

Ubuntuの場合

1
2
sudo apt update
sudo apt install graphviz

PlantUMLの使い方

vscodeでPlantUMLの図を作成する例を以下に示します。

  1. vscodeを起動します。
  2. vscodeの拡張機能から「PlantUML」をインストールします。
  3. 任意のフォルダを開き、新しいファイル(例: sample.puml)を作成します。
  4. 以下のコードを記述します。
1
2
3
4
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
@enduml
  1. Alt + Dを押して、図表を表示します。

コメント