Install-Software "PlantUML"

Windows上にネットワーク図描画ソフトウェア"PlantUML"をインストール。

Getting Started
翻訳: EN
目次

はじめに

Windows上にネットワーク図描画ツール「PlantUML 」をインストールする。当記事ではCLI（コマンドラインインターフェース）から実行するための環境構築について説明する。VS Code 拡張機能としてのPlantUML については説明しない。

前提条件

インストール

PlantUML のインストール方法を示す。 最終的に以下のようなコマンドを実行できるように環境を整える：

  • java -jar plantuml.jar -verbose sequenceDiagram.txt

環境構築の手順は以下のとおり：

  1. Java 8 (JRE8: Oracle.JavaRuntimeEnvironment)のインストール
  2. Graphviz のインストール
  3. plantuml.jarファイルのダウンロード

1. Java 8 (JRE 8) のインストール

PowerShellを管理者権限で起動する：

  1. START MENU → pwshと入力
  2. 「管理者として実行」をクリック

最新バージョンの確認：

winget search --id Oracle.JavaRuntimeEnvironment -e

Name    Id                             Version      Source
------- ------------------------------ ------------ -------
Java 8  Oracle.JavaRuntimeEnvironment  8.0.4510.10  winget

インストール。確認したIDとソースを以下のように指定する：

winget install --id Oracle.JavaRuntimeEnvironment --source winget -e

システム環境変数PATHに以下のパスを通す（ディレクトリ名はインストールしたJavaのバージョンによって変わる点に注意）。

"C:\Program Files\Java\jre1.8.0_451\bin"

検証。PowerShellをいったん閉じ、管理者権限で再起動する。 以下のコマンドでシステム環境変数にパスがとおっていることを確認する：

java -version

出力例：

java version "1.8.0_451"
Java(TM) SE Runtime Environment (build 1.8.0_451-b10)
Java HotSpot(TM) 64-Bit Server VM (build 25.451-b10, mixed mode)

2. Graphvizのインストール

以下の記事にしたがいGraphviz をインストールしシステム環境変数"PATH“に実行ファイルの場所を登録する：

3. “plantuml.jar"ファイルのダウンロード

以下のサイト（SourceForge ）からplantuml.jarファイルをダウンロードする：

デフォルトで「Downloads」ディレクトリにファイルがダウンロードされる。

Get-ChildItem -Path ~/Downloads/plantuml/

    Directory: C:\Users\WDAGUtilityAccount\Downloads\plantuml

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           3/17/2025  9:46 PM       11196866 plantuml.jar

任意の場所にplantuml.jarファイルを移動する。たとえば、以下はユーザのホームディレクトリにbin/plantumlディレクトリを作成し、その中に格納する例：

New-Item -Path ~/bin/plantuml -ItemType Directory
Copy-Item -Path ~/Downloads/plantuml/plantuml.jar -Destination ~/bin/plantuml/
Unblock-File -Path ~/bin/plantuml/plantuml.jar
Remove-Item -Path ~/Downloads/plantuml -Recurse -Force
# test path
Get-Item -Path ~/bin/plantuml/plantuml.jar

    Directory: C:\Users\<username>\bin\plantuml

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           3/17/2025  9:46 PM       11196866 plantuml.jar

インストール完了。

サンプルコード

基本的なグラフ（シーケンス図）を生成して視覚化してみる。

1. PlantUML型式のテキストファイルの作成

最初に、PlantUML形式のテキストファイル「sequenceDiagram.txt」を作成する：

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml

このファイルは基本的なシーケンス図を定義したものだ。

2. javaコマンドを用いたグラフの生成

次に、javaコマンドでグラフを生成する。 テキストファイルの場所に移動して以下のコマンドを実行する：

# change directory
Set-Location -Path path/to/the/sequenceDiagram.txt
# execute plantuml command
java -jar C:\Users\<username>\bin\plantuml\plantuml.jar -verbose sequenceDiagram.txt
## <username>にはあなたのユーザ名を入力する。
## ~/bin/plantuml/plantuml.jar<TAB>とすると自動補完される

このコマンドはsequenceDiagram.txtを入力として、PNG形式の画像ファイル（sequenceDiagram.png）を生成する。 -verboseフラグを指定すると、ログが生成される。もし画像が出力されないときは、ログの内容を解析してみよう。

3. 生成されたグラフの確認

コマンド実行後、生成されたsequenceDiagram.pngファイルを開いてグラフが正しく描画されていることを確認する。

Get-Item -Path sequenceDiagram.png

    Directory: C:\Users\WDAGUtilityAccount

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           4/20/2025  8:08 PM           1861 sequenceDiagram.png

Invoke-Item -Path sequenceDiagram.png
sequenceDiagram.txtの出力：シーケンス図。

用語

グラフ（ネットワーク図）

グラフとはここでは「囲み」を「矢印」や「線」でつないだ関係図のことをいう。いわゆるチャート（棒グラフや折れ線グラフなど）とは区別する。

PlantUML

オープンソースのグラフ可視化ソフトウェア。テキスト記法によりグラフを描画する点でGraphviz と似ている。違いは、記法と出力される図の種類。PlantUML はGraphviz よりも多くの図に対応する。