セキュア・バイ・デザインという本を最近読んでいて、その中で紹介されるドメイン・プリミティブという設計手法が印象に残ったのでDartでどのように実装できるか試してみた。

ドメイン・プリミティブとは、簡単に言うと、その値が常に有効であることが保証された値オブジェクトのことを指していて、Stringやintのような汎用的なデータ型に代わって使われる。

実装例

以下の例では税を含む金額の計算をDartを使ってモデリングしている。

まず、金額を表すために単なるintの代わりにMoneyというドメイン・プリミティブを定義する。-1000円といった負の値は有効ではないのでファクトリーコンストラクタで事前条件を検証し、デフォルトコンストラクタを非公開にすることで有効な値のみで初期化できるようにしている。

class Money {
  final int value;

  Money._internal(this.value);

  factory Money(int value) {
    if (value < 0) {
      throw ArgumentError.value(value, 'value', 'must be >= 0');
    }

    return Money._internal(value);
  }
}

次に、税を表すTaxというドメイン・プリミティブを定義する。ここでは通常税率と軽減税率の2種類を定義した。Dartのenhanced enumsを使い、定数コンストラクタを定義すれば、コンパイル時には値が決定するためコンストラクタの引数を検証する必要がない。

enum Tax {
  regular(rate: 0.1),
  reduced(rate: 0.08);

  final double rate;

  const Tax({required this.rate});
}

次に、税抜価格をMoney型を利用して定義する。Money型を利用しているので、自動的に負の値になることは実行時に保証されている。

class TaxExcludedPrice {
  final Money money;

  TaxExcludedPrice(this.money);
}

最後に、これらを利用して税込価格を定義する。コンストラクタにて税抜価格と税から生成するようにしているため、任意の数値から税込価格を直接生成することができない。

class TaxIncludedPrice {
  final Money money;

  TaxIncludedPrice({
    required TaxExcludedPrice taxExcludedPrice,
    required Tax tax,
  }) : money = Money((taxExcludedPrice.money.value * (1 + tax.rate)).round());
}

これらを使って軽減税率の商品の税込価格を計算してみる（紙幅の関係でtoString()の実装は省略してある）。

void main() {
  final taxExcludedPrice = TaxExcludedPrice(Money(1000));
  final taxIncludedPrice = TaxIncludedPrice(
    taxExcludedPrice: taxExcludedPrice,
    tax: Tax.reduced,
  );

  print('tax included price is $taxIncludedPrice.');
  //=> tax included price is 1080.
}

何が良いのか

こうした金額を実装する際、intやdoubleといった基本データ型を直接使って表すことが多いが、Money型を導入することで「負の値は許容しない」といったドメインルールを内包することができる。

また、TaxIncludedPrice型がTaxExcludedPrice型とTax型からでないと生成できないようにしていることで「税込価格は税抜価格に税を加えた値である」といったドメインロジックを型システムによって強制できるため、単体テストなどによる保証よりもさらにfail-fastな設計となり、より堅牢なコードになる。