コンテンツにスキップ
検索語を入力してください

    ドメインモデリング

    意味の異なる値を同じ StringLong のまま置くと、コンパイラは区別できず、境界をすり抜けた値がドメイン深部まで届く。Kamaeではopaque types、value class、sealed trait、明示的なコンストラクタで意図を型に刻む。

    ライフサイクル上の変化は 状態遷移、外部データの取り込みは 境界防御、保存単位は 永続化、集約、イベント と揃える。

    ドメイン概念を明示的に表現する

    Section titled “ドメイン概念を明示的に表現する”

    プリミティブのままだと、単位の混同やIDの取り違えはコンパイル時に検出できない。opaque typeのコストはボイラープレートより、誤った組み合わせを早く落とす効果の方が大きい。

    次の例は、空文字を拒否する RequestId による典型的なopaque typeである。

    object RequestIds:
    opaque type RequestId = String
    object RequestId:
    def apply(value: String): Either[RequestIdError, RequestId] =
    val trimmed = value.trim
    if trimmed.isEmpty then Left(RequestIdError.Empty)
    else Right(trimmed)
    extension (id: RequestId) def value: String = id
    export RequestIds.RequestId

    opaque typeはobject(またはclass)モジュール内で定義し、基底层の表現をファイル横断で抽象化する。トップレベルのopaqueエイリアスは同一ソースファイル内でのみ不透明である。

    値が意図的に透明で不変条件がない場合を除き、opaque typeの内部表現はprivateとする。

    時刻・金額・単位は明示的な概念としてモデル化する。単位・タイムゾーン・精度・丸めが暗黙の裸のプリミティブより、OccurredAtServiceDateMoneyCurrencyCodeDistanceMetersDurationSeconds を優先する。金額には Double を使わない。

    状態のバリアントには enum と sealed trait を優先する

    Section titled “状態のバリアントには enum と sealed trait を優先する”

    閉じた状態集合やドメイン上の代替にはScala 3の enum またはsealed traitを使う。各状態が異なるデータを持つなら、ケースクラス風のバリアントとする。

    enum TaxiRequest:
    case Waiting(value: WaitingRequest)
    case EnRoute(value: EnRouteRequest)
    case InTrip(value: InTripRequest)
    case Completed(value: CompletedRequest)
    case Cancelled(value: CancelledRequest)

    特定のソース状態だけが遷移を受け付けるときは、別の状態型とする(状態遷移)。

    集約は、まとめて原子的に変わる必要のある不変条件を所有する。ルールを所有する状態または集約に遷移メソッドを置き、他集約はIDで参照する。判断用に安定したスナップショットをロードするユースケースは除く。

    トランザクションスコープ・バージョニング・集約横断の調整は 永続化、集約、イベント を参照する。

    アクセス都合だけで無関係なエンティティを集めた「神」集約は避ける。2つの集約ルートをメモリ上で変更し、呼び出し側の両方のsaveに頼る遷移も避け、ユースケースと明示的なドメインイベントで集約をまたぐ変更する。

    applyfrom、検証付きファクトリで構築時に不変条件を強制する。publicな copy 経路やミュータブルフィールドを公開すると、呼び出し元が検証を迂回して無効な組み合わせを作れてしまう。

    不変条件のない単純データ、またはテスト専用のbuilderだけがcase classリテラルを許容する。本番経路と同じコンストラクタをテストでも使う方針はスキルリポジトリの references/test-data.md を参照する。

    derive と振る舞いは意図的に選ぶ

    Section titled “derive と振る舞いは意図的に選ぶ”

    不変条件を持つドメイン型に、本当のドメインdefaultがない限りデフォルト値を与えない。空ID・ゼロ金額・最初のenumケースは、通常invalidまたはmisleadingなdefaultになる。

    case class は不変に保つ。広くmutableな集約は古いコピーをそのまま永続化する経路を隠しやすい。

    private不変条件があるドメイン型に無制限のJSON codec deriveを付けない。DTO・行ケースクラス、またはリーフvalue object上の検証付きデコーダでデシリアライズも検証を通す(境界防御)。

    リポジトリポートを trait で定義する

    Section titled “リポジトリポートを trait で定義する”

    永続化はドメインまたはアプリケーション層の小さなtraitの背後に置く。

    trait TaxiRequestRepository[F[_]]:
    def findWaiting(id: RequestId): F[Option[WaitingRequest]]
    def saveAssigned(state: EnRouteRequest, events: List[TaxiRequestEvent]): F[Unit]

    アダプタはdoobie、slickなどでこれらを実装する。ドメインコードはドライバ固有の型をimportしない。

    taxi.requesttaxi.drivertaxi.assignment のようなモジュール単位で概念を分け、型・コンストラクタ・メソッド・テストを同じ場所に置く。modelsdomain といったcatch-allパッケージに無関係な概念を混在させ、振る舞いだけ別モジュールに分離する構成は、変更のたびにファイルを行き来させ、不変条件のレビューも難しくする。

    kamae-scala リポジトリexamples/src/main/scala/kamae/examples/TaxiRequest.scala で、opaque ID、分離した状態型、型付き遷移を一通り追える。

    呼び出し元が不変条件を迂回できないか — High

    Section titled “呼び出し元が不変条件を迂回できないか — High”

    不変条件を持つドメイン型でpublicフィールド、publicな copy、ミュータブルフィールドがある場合は指摘する。検証付きコンストラクタを正規の経路とすること。

    複数フィールドの不変条件の一部だけを更新するミューテータ、再検証のスキップ、無効な中間状態の流出を許すミューテータを指摘する。

    正規コンストラクタ内の直接構築、非公開テストヘルパー、使用前に検証付きドメインコンストラクタへ変換されるDTO / 行構造体には指摘しない。

    意味のあるプリミティブは opaque type 等で表現されているか — High

    Section titled “意味のあるプリミティブは opaque type 等で表現されているか — High”

    ユーザー ID、注文ID、メールアドレス、金額、数量、外部参照など、異なるドメイン概念にそのまま String、整数、Double、UUID型を使っている箇所を指摘する。

    opaque typeやvalue classと検証付き apply を提案する。

    ローカル一時変数、非公開アダプタフィールド、テストリテラル、シリアライズ専用DTOフィールド、Scala型以上のドメイン不変条件を持たない値には指摘しない。

    DTO、DB 行、ドメインエンティティは分離されているか — Medium

    Section titled “DTO、DB 行、ドメインエンティティは分離されているか — Medium”

    codec deriveにより外部データが検証を迂回したり、ドメイン不変条件がストレージ形状に結合するドメインエンティティを指摘する。

    意図的なリードモデル、プロジェクション、APIレスポンスDTO、ドメイン状態へデシリアライズできない監査用エクスポート型の Serialize には指摘しない。

    状態は明示的にモデル化されているか — Medium

    Section titled “状態は明示的にモデル化されているか — Medium”

    status: String と多数のオプションフィールドを持つ単一case classで、状態ごとの型やenumバリアントの方が必須フィールドを明確にできる場合は指摘する。

    金額、時間、単位は明示的か — Medium

    Section titled “金額、時間、単位は明示的か — Medium”

    型や名前付きコンストラクタなしに単位、通貨、タイムゾーン、包含 / 排他範囲を混在させる金額、数量、期間、レート、タイムスタンプを指摘する。

    ドメインコードは概念ごとに整理されているか — Low

    Section titled “ドメインコードは概念ごとに整理されているか — Low”

    無関係な概念を集め、振る舞いとデータを分離するcatch-allの modelsdomain パッケージを指摘する。

    狭い境界づけられたコンテキスト目的のまとまったモジュール、生成スキーマモジュール、意図的に薄く保たれた互換シムには指摘しない。