作者:井上樹
翔泳社

はじめに

ソフトウェアの仕様書、設計書の作成や管理を効率化するために、Markdown + PlantUMLによる作成方法を日々模索しています。
しかしながら、そもそもUML図の正式な書き方というものをちゃんと分かっていないというのが正直なところなので、PlantUMLを通じてUMLの各種図の書き方を勉強していきます。

本稿のテーマは、「UMLによるドメインモデル図の書き方」です。
本稿におけるUML図の作成は、Markdown + PlantUMLがベースであることを前提とします。

プロジェクトの開始時にやるべきこと

設計対象であるシステムが取り扱うものの概念について、チーム内で共通認識を築く
それらの概念の繋がりを表現したのがドメインモデル図である。

ドメインモデル図とは

ユーザの視点で見た、システムに登場する「もの」の概念(ドメインクラス)を集めた図である。
プロジェクトの用語集をクラス図風に表現した図ということにもなる。
自然言語で構成するため、要件定義や仕様の把握に有効である。

ドメインモデル図を描く手順

例として、通販サイトの要件からドメインモデル図を描く場合を考える。

1. 「名詞」の抽出

通販サイトの要件から下記のような名詞が抽出されたとする。

「商品、型番、価格、カテゴリ、カート、注文、レビュー、ウィッシュリスト、ユーザ、登録情報、メールアドレス」

これらの名詞を図に並べてみる。

f:id:sy4310:20181229144517p:plain

名詞は「ドメインクラス、ドメインクラスの属性、アクタ」の３種類に分けられ、判別方法は下記のようになる。

アクタ: ユーザや外部システム
ドメインクラスの属性: 商品の型番や値段など、○○の△△という形で書けるもの
ドメインクラス: 上記以外の名詞

2. モデル同士の関係を線と矢印で表す

線の種類は、「has-one, has-many, is-a-kind-of」の３種類とする。

f:id:sy4310:20181229144644p:plain

さらに、商品に「予約商品、在庫商品」の２種類があるとすれば下記のようになる。

f:id:sy4310:20181229144712p:plain

3. 中心となるモデルに色を付ける

f:id:sy4310:20181229144902p:plain

最終的な上記の図を描くPlantUMLのコードは下記の通り。

left to right direction

hide circle
hide method

package DomainModel {
    class 商品 #F5A9BC
    class 予約商品 #F5A9BC
    class 在庫商品 #F5A9BC
    class カテゴリ
    class レビュー
    class カート
    class 注文 #CEF6F5
    class ウィッシュリスト
    class 登録情報 #A9C6F6
    mix_actor ユーザ

    商品 : 型番
    商品 : 価格
    登録情報 : メールアドレス

    ユーザ -> 登録情報 : has-one
    ユーザ --> カート
    カート o--> 商品 : has-many
    商品 <--o カテゴリ
    ユーザ o--> 注文
    注文 o--> 商品
    ユーザ --> ウィッシュリスト
    ウィッシュリスト o--> 商品
    ユーザ o--> レビュー
    レビュー <--o 商品

    商品 <|-- 予約商品 : is-a-kind-of
    商品 <|-- 在庫商品 : is-a-kind-of
}