この記事の目的
統合開発環境にIntelliJ IDEAを最近使い始めました。IntelliJ IDEAでソースコードからクラス図を簡単に自動生成するプラグイン「PlantUML Parser」をご紹介します。
クラス図の自動生成を扱った記事は下記の2つに引き続き3記事目です。
Javaのクラス図を自動生成する ～UMLDoclet～
この記事の目標 ライブラリのプログラムを読んでみたい。そこでUMLのクラス図を自動生成して、プログラムの構造を視覚的に理解してみる。 UMLとは「統一モデリング言語(Uniformed Modeling Language)」を指す。簡単に言...
ottfoekst.com
2021.02.01
Javaのクラス図やコールグラフを自動生成する ～Doxygen～
この記事の目標 クラス図を自動生成できるツールDoxygenをご紹介します。過去に紹介したUMLDocletとの違いは、Doxygenはコールグラフを追加で出力することができることです。 「コールグラフ」とは、各メソッドが何のメソッドを呼び...
ottfoekst.com
2022.07.10
手順
プラグインをダウンロード
IntelliJ IDEAを開き、「ファイル」 > 「設定」をクリックすると、下記の設定画面が表示されます。
次に「プラグイン」を選択し、検索ボックスに「plantuml」と入力します。
下記2つのプラグインが表示されるのでインストールします。
- PlantUML Parser
- PlantUML Integration ※PlantUML Parserで出力したファイルの閲覧、編集に使用
本記事で使用したIntelliJ IDEA、PlantUML Parser、PlantUML Integrationのバージョンはそれぞれ2022.2.3 (Community Edition)、0.0.4、5.22.0です。
クラス図を出力
出力手順
Apache Commons CSVのクラス図を出力してみます。
クラス図を出力したいクラスまたはパッケージを選択して右クリックし、「PlantUML Parser」をクリックします。
下記の画面が表示されます。
クラス図の出力ファイル名を入力し、privateメソッドの出力をOFFに変更し、最後に「generate」をクリックします。
privateメソッドの出力OFFは、UMLDocletの記事と出力設定を揃えるためのもので必須ではありません。
出力結果
生成したクラス図のファイルがプラグイン「PlantUML Integration」を使って開かれます。左側のテキストエディタでクラス図を編集して右側で編集結果を確認する使い方もできます。
出力したクラス図は下記です。改造後のUMLDocletで出力したクラス図よりクラス間の線の数が少なく、他のクラスと結ばれていない孤立したクラスがちらほらあります。
まとめ
IntelliJ IDEAでクラス図を簡単に自動生成する方法を紹介しました。クラス間の線(関連)の数は少なめですが、自動生成の手軽さはUMLDoclet、Doxygenより勝ると思います。
コメント