# Java PlantUMLをVS Codeで利用する設定方法

## 目次

1. はじめに

2. PlantUMLとは？

3. 必要なソフトウェアと環境

   3-1. Javaのインストール

   3-2. Graphvizのインストール

   3-3. Visual Studio Codeのインストール

   3-4. PlantUML拡張機能のインストール

4. VS CodeでのPlantUML設定

   4-1. PlantUML拡張機能の基本設定

   4-2. Java環境やGraphvizのパス設定

5. PlantUMLの基本的な使用方法

   5-1. シンプルなUML図の作成

   5-2. コードからUML図の生成

6. よくある問題とトラブルシューティング

7. まとめ

## 1. はじめに

PlantUMLは、テキストベースでUMLダイアグラムを作成できるツールです。本記事では、Java環境でPlantUMLをVisual Studio Code (VS Code)上で利用するための設定方法について詳しく説明します。具体的な手順や設定事項を一つ一つ見ていきましょう。

## 2. PlantUMLとは？

PlantUMLは、シンプルなテキスト記法を使ってUMLダイアグラムを描画するツールです。UML (Unified Modeling Language)は、プログラムの設計や仕様を視覚化して表現するのに使用されます。PlantUMLはJavaで書かれており、Java実行環境が必要です。

## 3. 必要なソフトウェアと環境

### 3-1. Javaのインストール

PlantUMLはJavaで動作するため、Javaのインストールが必須です。最新版のJDKをOracleの公式サイトまたはOpenJDKからダウンロードし、インストールしてください。

- **Javaのインストール手順**:

  1. [OpenJDKの公式サイト](https://openjdk.java.net/)から最新のJavaをダウンロード。

  2. 指示に従いインストールを完了させます。

  3. インストール後、コマンドプロンプトまたはターミナルで`java -version`を実行し、インストールが正常に完了していることを確認します。

### 3-2. Graphvizのインストール

GraphvizはPlantUMLで生成されるダイアグラムの描画に必要です。以下の手順でインストールします。

- **Graphvizのインストール手順**:

  1. [Graphvizの公式サイト](https://graphviz.gitlab.io/download/)からインストーラーをダウンロード。

  2. ダウンロードしたインストーラーを使い、Graphvizをインストール。

  3. 正しくインストールされたことを確認するため、コマンドプロンプトまたはターミナルで`dot -version`を実行。

### 3-3. Visual Studio Codeのインストール

VS CodeはMicrosoftが提供する無料のエディタです。次の手順でインストールできます。

- **VS Codeのインストール手順**:

  1. [Visual Studio Codeの公式サイト](https://code.visualstudio.com/)からダウンロード。

  2. インストーラーを実行して指示に従いインストール。

### 3-4. PlantUML拡張機能のインストール

VS CodeでPlantUMLを利用するために、専用の拡張機能をインストールします。

- **拡張機能のインストール手順**:

  1. VS Codeを起動し、画面左側の「拡張機能」アイコンをクリック。

  2. 検索バーに「PlantUML」と入力。

  3. PlantUML拡張機能を見つけ、インストールボタンをクリック。

## 4. VS CodeでのPlantUML設定

### 4-1. PlantUML拡張機能の基本設定

インストールした拡張機能を設定します。まず、VS Codeの設定を開きます（`⌘,`または`Ctrl+,`）。

- **基本設定**:

  1. 「拡張機能」セクションでPlantUMLを選択。

  2. 必要に応じて、ディフォールトの生成形式(png, svgなど)を設定。

### 4-2. Java環境やGraphvizのパス設定

JavaとGraphvizが正しく認識されていることを確認します。もし認識されない場合、VS Codeの設定で環境変数を調整する必要があります。

- **パスの確認と設定**:

  - 環境変数PATHにJavaとGraphvizのインストールパスが含まれているか確認します。

  - 必要に応じて、システムのプロパティから環境変数を変更し追加します。

## 5. PlantUMLの基本的な使用方法

### 5-1. シンプルなUML図の作成

簡単なUML図を作成する例を示します。

```plantuml

@startuml

Alice -> Bob: Hello

Bob --> Alice: Hi

@enduml

```

- **コード説明**:

  - `Alice`と`Bob`という２つのエンティティがあります。

  - `Alice`から`Bob`へ「Hello」というメッセージが送られ、`Bob`から`Alice`へ「Hi」という返答があります。

### 5-2. コードからUML図の生成

プログラムコードからのUML図の生成も可能です。次に、Javaコードに基づいてクラス図を生成する例を示します。

```java

public class Person {

    private String name;

    private int age;

    public Person(String name, int age) {

        this.name = name;

        this.age = age;

    }

    public void sayHello() {

        System.out.println("Hello, my name is " + name);

    }

}

```

これをUMLに表す場合、以下のようになります。

```plantuml

@startuml

class Person {

    - String name

    - int age

    + Person(String name, int age)

    + void sayHello()

}

@enduml

```

## 6. よくある問題とトラブルシューティング

- **Java/Graphvizが認識されない**:

  - PATHにインストールされたディレクトリを正しく追加します。

- **ダイアグラムが表示されない**:

  - 拡張機能の設定で生成形式を確認。

  - 再インストールやVS Codeの再起動を試みる。

## 7. まとめ

本記事では、Java環境でPlantUMLをVS Codeで利用するための設定方法を詳細に解説しました。これにより、効率よくUMLダイアグラムを作成することが可能になります。ぜひ、プロジェクトの設計やドキュメント作成に役立ててください。

Java PlantUMLをVS Codeで利用する設定方法

目次

続きを読むには単価診断を受けてください（30秒）