Javaソースコードからクラス図を自動生成する方法 AmaterasUMLで業務効率化

デモでソースコードを組んだけど詳細設計書に書き起こすのが面倒くさい。そんなときに、AmaterasUMLというツールが便利だったので紹介します。

AmaterasUMLとは

AmaterasUMLは、クラス図などを作るためのEclipseプラグインです。手動で描画する機能はもちろんのこと、Javaのソースコードから自動生成することも出来ます。

インストール

AmaterasUML をeclipseで使用する上で必要なプラグインをEclipseにインストールしていきます。必要なプラグインはGEFとAmaterasUMLです。

GEFインストール

AmaterasUMLの使用に必用なGEFをインストールします。GEFは正式名称Graphical Editing Frameworkで描画編集のためのフレームワークのようです。

インストールはeclipseのOnline Update-Siteから実施します。

eclipse Help>新規ソフトウェアのインストール

Installダイアログが出てきますので、テキストエリアWork with: に <Oxygen – http://download.eclipse.org/releases/oxygen> と入力してエンター

※<>内の文字を入力

リストが表示されるので、Modeling配下のGEF(MVC)SDKにチェックを入れます。

Next > Next > I accept > Finish でeclipse再起動を求められるので、再起動してGEFインストール完了です。

AmaterasUMLインストール

私はeclipse Oxygenを使用していますが、既にインストールされていました。インストールしたexlipseはPleiades All in One 4.7.3a Java Standard Edition です。

AmaterasUMLがeclipseにインストールされているかの確認方法は次のとおりです。

eclipse File > New > Other でAmaterasUMLが選択しにあれば既にインストールされています。

インストールされていない場合には、AmaterasUMLプラグイン(AmaterasUML_1.3.4.zip)をダウンロードしてインストールしましょう。ダウンロードは公式サイトのダウンロードリンクから出来ます。

ダウンロードしたら解凍してプラグインに入れます。そして再起動したらAmaterasUMLインストール完了です。

使い方

まずはAmaterasUMLファイルを作成して領域を出します。AmaterasUMLの拡張子はcldになります。クラス図の作成方法は自分で描画していく方法と、Javaソースコードから自動生成する方法があります。今回はJavaソースコードから自動生成する方法をご紹介します。

ソースから自動生成

eclipse Package領域のJavaソースコードをeclipse AmaterasUML領域にドラッグ&ドロップします。すると、ドロップしたAmaterasUML領域にクラス図が作成されます。このとき、リレーションのあるクラスは自動でリレーションを張ってくれます。とても便利!

ライブラリからでもクラス図の自動生成が可能です。しかし、いくつか注意事項があります。jarファイル、warファイルはドラッグ&ドロップしてもクラス図は生成されません。自動生成出来るのはjavaファイル、Intefaceファイル , Classファイルです。1ファイルで複数Classを持つファイル、インナークラスのあるファイルは自動生成することが出来ました。

自動レイアウト

クラス図を自動生成できるのはとても便利なのですが、一度に複数のクラスをドラッグ&ドロップすると重なってしまいます。そんなときに便利なのが自動レイアウトです。

AmaterasUML領域を右クリック > Auto Layout

でクラス図が自動で整列してくれます。

画像に出力

作成したクラス図はJPEG形式の画像として出力することが出来ます。Excelなどのテキスト形式では出力する機能は無いようです。

AmaterasUML領域を右クリック > Save As Image

これで画像として保存できます。保存した画像がこちら。

Let's share SNS