Java設計

PlantUMLでgetter・setterメソッドをもつクラスのクラス図を作成してみた

クラス図とは、システムを構成するクラスとそれらの関係を表現する図で、各クラスが保持する属性(プロパティ)や操作(メソッド)も記載することができる。システム全体の静的な構造を明らかにするために作成される。

今回は、PlantUMLで、getter/setterメソッドをもつクラスのクラス図を作成してみたので、作成したクラス図と元になるPlantUMLのソースコードを共有する。

なお、クラス図については、以下のサイトを参照のこと。
http://www.itsenka.com/contents/development/uml/class.html

また、PlantUMLのクラス図についてのマニュアルは、以下のサイトを参照のこと。
https://plantuml.com/ja/class-diagram

前提条件

下記記事の、VSCode上でPlantUMLを利用するための環境構築が完了していること。

PlantUMLをVSCode上で利用してみたPlantUMLは、VSCode(Visual Studio Code)上で編集するようにすると、ソースコードを色つきで分かりやすく表示...

クラス図作成対象のソースコード

今回の、クラス図作成対象となるソースコードの内容は、以下の通り。

作成したクラス図(1)

一般的な方法で作成したクラス図の内容は、以下の通り。
userDataClass1

また、上記クラス図のPlantUMLソースコードの内容は、以下の通り。

作成したクラス図(2)

getter/setterメソッドには、下記サイトのように、«get/set»という独自のステレオタイプを使うこともできる。
https://stackoverrun.com/ja/q/7726050

このステレオタイプを利用した場合のクラス図の内容は、以下の通り。
userDataClass2

また、上記クラス図のPlantUMLソースコードの内容は、以下の通り。

要点まとめ

  • クラス図とは、システムを構成するクラスとそれらの関係を表現する図で、各クラスが保持する属性(プロパティ)や操作(メソッド)も記載することができる。
  • PlantUMLを利用すれば、コードベースでクラス図を作成できる。
  • getter/setterメソッドは、«get/set»という独自のステレオタイプを利用すると、クラス図のメソッドの記述を省略できる。