[テキストで簡単作図]PlantUMLでオブジェクト図を簡単に作成！

PlantUML

2024.11.27

この記事は約4分で読めます。

PlantUMLを使えば、テキストベースでオブジェクト図を簡単に作成できます。この記事では、オブジェクト図の各要素の記述方法を詳しく解説していきます。

PlantUMLとは？
オブジェクトの定義方法
フィールドの設定
オブジェクト間の関連
関連の種類
マップテーブルの定義
まとめ
参考情報

PlantUMLとは？

PlantUMLは、シンプルなテキスト記述でUMLダイアグラムやフローチャートを作成できるツールです。専用の構文を覚える必要はありますが、一度慣れてしまえば、GUIツールよりも素早く、そして美しくフローチャートを描けるようになります。バージョン管理システムとの相性も抜群で、テキストベースなので変更履歴の追跡も簡単です。

UML・PlantUMLや、VSCode環境への導入方法等は以下にまとめていますので、こちらを参照ください。

オブジェクトの定義方法

オブジェクトを定義するには、objectキーワードを使用します。定義方法は3つあります：

@startuml
object "太郎 : ユーザーアカウント" as tarou
object "太郎" as tarou_object_name
object ": ユーザーアカウント" as tarou_class_name
@enduml

フィールドの設定

オブジェクトにフィールドを設定する方法は2種類あります：

@startuml
'個別にフィールドを設定
object "太郎 : ユーザーアカウント" as tarou
tarou : id = 1
tarou : age = 23
tarou : profile = "料理好き"

'まとめて設定
object "花子 : ユーザーアカウント" as hanako {
    id = 2
    age = 20
    profile = "音楽好き"
}
@enduml

オブジェクト間の関連

オブジェクト間の関連を表現するには、以下の記号を使用します：

@startuml
'基本的な関連
object "太郎 : ユーザー" as user
object "カレーの作り方 : 記事" as article
user -- article

'関連に名前をつける
object "花子 : ユーザー" as user2
object "ピアノ演奏のコツ : 記事" as article2
user2 "作成者" -- "コンテンツ" article2
@enduml

マップテーブルの定義

連想配列を表現するためのマップテーブルも定義できます：

@startuml
map ユーザー情報 {
    id => 1
    name => "太郎"
    age => 23
    email => "taro@example.com"
}

map システム設定 {
    version => "1.0.0"
    language => "ja"
    theme => "dark"
}
@enduml