IntelliJ IDEA と PlantUML プラグインを使用した UML 図の生成

IntelliJ IDEA と PlantUML プラグインを使用した UML 図の生成

岩佐 孝浩
岩佐 孝浩
3 min read
IntelliJ IDEA PlantUML

はじめに

UML 図を生成することで、ソフトウェア設計プロセスを効率的に進めることができます。IntelliJ IDEAPlantUML プラグイン を使用すれば、簡単なテキストベースの DSL を使用して効果的に図を作成・管理できます。このテキストベースのアプローチにより、Git などのバージョン管理システムと容易に統合できます。

必要条件

以下のソフトウェアをインストールし、設定してください。

ソフトウェアバージョン
IntelliJ IDEA2016.3.4
PlantUML Integration Plugin2.5.0
Graphviz2.3.8

UML の記述と可視化

まず、.puml 拡張子のファイルを作成します。UML 図のコードを記述し始めると、プラグインが IDE 内で即座に図をレンダリングします。

以下は簡単な例です。

@startuml

interface Person
abstract Employee

interface Person {
    + string getName();
}

class Employee {
    - string name;
    --
    + string getName();
    + string getEmployeeId();
}

Person <|-- Employee

@enduml

このコードは、Person インターフェースと Employee クラスを示す UML 図を生成します。 PlantUML DSL の詳細については、PlantUML 公式サイト をご参照ください。

PlantUML を使用するメリット

  • テキストベースのシンプルさ: UML 図をコードとして管理でき、追跡やバージョン管理が容易。
  • Git との統合: 変更を簡単に管理し、他の開発者と共同作業が可能。
  • 即時フィードバック: タイピング中にすぐに図を視覚化。

まとめ

PlantUML は、小規模から中規模のアプリケーションで UML 図を生成するための強力かつシンプルなツールです。そのテキストベース形式は、IntelliJ IDEAGraphviz などのツールと組み合わせることで、効率的でバージョン管理されたワークフローを実現します。

Happy Coding! 🚀

岩佐 孝浩

岩佐 孝浩

Software Developer at KAKEHASHI Inc.
AWS を活用したクラウドネイティブ・アプリケーションの要件定義・設計・開発に従事。 株式会社カケハシで、処方箋データ収集の新たな基盤の構築に携わっています。 Japan AWS Top Engineers 2020-2023