コードで学ぶエンティティと値オブジェクト〜DDD実践のためのきほん〜

はじめに

今回はポイント管理システムをテーマに

DDD×クリーンアーキテクチャでサンプルコードを作ったので、

それを使いながら、

エンティティと値オブジェクトとは？？

どう使い分けるか？？についてまとめました。

動画も作ったのでご覧ください。

エンティティと値オブジェクトのサンプルコード

今回テーマにしているポイントシステムでは、

店舗からレシート情報とカード、ポイント利用などを連携され、

付与ポイントの加算、ポイント利用の減算などの

ポイント管理ができるシステムを想定しています。

ポイント管理システムのイメージ図

まずは値オブジェクトのサンプルコードを見てみましょう。

「支払日」値オブジェクト

data class PaymentDate(val value: LocalDate) {
    init {
        val today = LocalDate.now()
        if (value.isAfter(today) || value.isBefore(today.minusMonths(1))) throw IllegalArgumentException("支払日が不正です(当日〜過去1ヶ月以内である必要があります)")
    }
}

ポイント管理システムにおいて支払日には以下のような仕様としています。

店舗で商品を購入した日が支払日となるため未来日になることはない
購入時にポイントカードを忘れた場合1ヶ月以内にレシートを持参すればその日を支払日としてポイント付与する

そのため、initで上記仕様を表現しており、

ポイントシステムで取り扱うべき支払日の範囲外の場合は、

値オブジェクトを生成できないようにガード節を設けています。

次にエンティティのサンプルコードを見ていきましょう。

「支払会員」エンティティ

class PaymentMember(
    val memberCode: MemberCode,
    private val remainingPoints: Point
) {

    fun usePoints(point: Point): PaymentMember {
        if (remainingPoints.value < point.value) throw IllegalArgumentException("ポイントが不足しています")
        return PaymentMember(memberCode, Point(remainingPoints.value - point.value))
    }
}

こちらはmemberCodeで支払メンバーが一意に特定できます。

ちょっとおまけのコード解説

remainingPointsを不変とし、

副作用が意図せず発生しないように

動作を安定させる工夫をしています。

そのため支払メンバーがポイント利用した際は

新たにエンティティを生成しなおす必要があります。

支払という文脈におけるメンバーを「支払会員」エンティティでは表現しており、

支払に関係のないメンバーの名称や住所、生年月日などはインスタンス変数から排除しています。

もし、

新規会員を登録する場合は支払会員とは別のエンティティを用意し、

そちらにはメンバーの名称や住所、生年月日、残ポイント(0ポイント)を