mcpField
A
aggregate-design

aggregate-design

github.com/j5ik2oDevelopment8039 installsUpdated 27w ago
Repository

About aggregate-design

A guide for developers practicing DDD on defining aggregates and preserving their invariants. It covers access through aggregate roots, references to other aggregates by ID, and eventual consistency across boundaries.

Key features

  1. 01Define boundaries around invariants
  2. 02Access internals through aggregate roots
  3. 03Reference other aggregates by ID
  4. 04Keep aggregates small
  5. 05Coordinate with domain events and eventual consistency

Use cases

  1. 01Assess whether an aggregate boundary is too broad
  2. 02Check that access goes through aggregate roots
  3. 03Review cross-aggregate transaction design

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/j5ik2o/okite-ai --skill aggregate-design

After installing, type/aggregate-designin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

evals/
evals.json
trigger-eval.json
references/
python.md
rust.md
scala.md
typescript.md

Details

From the project README

集約設計ガイド

DDDにおける集約(Aggregate)設計の原則。

集約とは

集約 = 整合性の境界

  • 集約はオブジェクトのグラフであり、そのグラフを一単位として扱う
  • 集約内で真の不変条件（常に満たすべき制約）が維持される
  • 集約ルート（ルートエンティティ）が集約全体の唯一のエントリーポイント
境界の例：Car集約
┌─────────────────────────────────────┐
│           Car集約                    │
│  ┌──────────────────────────────┐  │
│  │   Car (集約ルート)            │  │
│  │   - carId: CarId             │  │
│  │   - tires: List[Tire]        │  │
│  │   - engine: Engine           │  │
│  └──────────────────────────────┘  │
│         ↓ 所有               ↓ 所有  │
│  ┌──────────┐         ┌─────────┐ │
│  │  Tire    │ × 4     │ Engine  │ │
│  │ (VoかEnt)│         │ (VoかEnt)│ │
│  └──────────┘         └─────────┘ │
└─────────────────────────────────────┘
  • TireとEngineはCar集約の境界内にある
  • 外部からTireやEngineへ直接アクセスは不可
  • Carを経由してのみ操作可能

Design by Contract (DbC)

集約は契約に基づいて設計する。

契約説明責任
事前条件 (Precondition)メソッド呼び出し前に満たすべき条件呼び出し側
事後条件 (Postcondition)メソッド実行後に満たされる条件実装側
不変条件 (Invariant)常に満たすべき条件実装側

詳細な言語別実装パターンは references/typescript.md、references/scala.md、references/rust.md、references/python.md を参照。

基本原則

1. 不変性(Immutability)推奨

現代においては不変(Immutable)を推奨する。特に理由がなければ不変。 状態更新時は既存値を引き継ぎ、変更するフィールドだけを上書きする。 これにより、フィールド追加時の修正漏れを防ぎ、更新意図が明確になる。

言語不変更新パターン
TypeScriptProps型 + ...this.props スプレッド構文
Scalacase class + copy()
Ruststruct + ..self 構造体更新構文
Pythondataclass(frozen=True) + replace()
2. 強い整合性境界

集約は一つの強い整合性境界。集約内部の状態はすべてその集約の管理下に置く。

3. 他集約への間接参照

集約内部に別の集約の参照を保持しない。他の集約と関連を持つ場合はIDで間接参照する。

4. 完全コンストラクタ

基本コンストラクタですべての状態を初期化する。オーバーロードする場合も必ず基本コンストラクタを利用する補助コンストラクタとして設計する。

5. 防御的コピー

可変オブジェクトを保持する場合、外部に返す際は必ずコピーを返すか不変オブジェクトに変換する。

6. 不変条件の維持

どのような操作をされても不正な状態に陥ってはならない。不変な集約では基本コンストラクタで保護する。

構造原則

7. 集約ルート経由のアクセス

集約内部のエンティティや値オブジェクトへの直接アクセスは、必ず集約ルートを経由する。

8. 1トランザクション = 1集約

単一のトランザクションで複数の集約を更新しない。集約間の整合性は結果整合性で担保する。

9. 集約を小さく保つ

大きすぎる集約は並行性の問題(ロック競合)を引き起こす。真に一貫性が必要な範囲のみを含める。

連携原則

10. ドメインイベントによる連携

集約の状態変更時にドメインイベントを発行し、他の集約や外部システムはそれを購読して反応する。

11. 楽観的ロック（要件がある場合のみ）

並行更新の衝突検出が必要な場合にのみ、バージョン番号を持たせる。要件がなければ不要。

12. 永続化の無知

集約はドメインロジックに集中し、どう保存されるかは関知しない(リポジトリの責務)。

Evans Rules（エリック・エヴァンス）

DDDの原典からの集約ルール。

Evans Rule 1: ルートエンティティの責任

集約ルートだけがリポジトリから直接取得できる。

  • 外部オブジェクトは集約内部への参照を持てない
  • 集約ルートは内部エンティティの識別子を渡すことができるが、それは一時的な利用に限る
  • 集約ルートは集約全体の不変条件を維持する責任を持つ
Evans Rule 2: 内部オブジェクトへのアクセス制限

境界内のエンティティはローカルな識別子を持つ。それは集約内でのみ一意であればよい。

  • 外部から直接アクセス不可
  • 内部エンティティの識別子はグローバルに一意である必要はない

Vernon's 4 Rules（ヴォーン・ヴァーノン）

「実践ドメイン駆動設計」からの設計ルール。

Rule 1: 真の不変条件を整合性境界に

Design aggregates based on true invariants (整合性境界の中で真の不変条件を担保)

良い例：Order集約
- 注文合計 = 各明細の小計の合計（真の不変条件）
- この計算は即座に正しくなければならない

悪い例：結果整合性で十分な場合
- 在庫数の更新は別の集約で結果整合性
Rule 2: 小さな集約

Keep aggregates small（集約は小さく）

大きな集約の問題：

  • ロック競合が増加
  • 並行性が低下
  • トランザクション失敗率が上昇
❌ Bad: 大きな集約
Product集約
├── productId
├── name
├── backlogItems: List[BacklogItem]  ← 数百件になる可能性
└── ...

✅ Good: 分割した集約
Product集約              BacklogItem集約
├── productId           ├── backlogItemId
├── name                ├── productId（IDで参照）
└── ...                 └── ...
Rule 3: 他の集約はIDで参照

Reference other aggregates by ID only（他の集約はIDで参照）

前述の「他集約への間接参照」と同じ原則。

Rule 4: 結果整合性

Use eventual consistency outside the boundary（境界外は結果整合性）

  • 集約間の整合性はドメインイベント + 結果整合性で担保
  • 単一トランザクションで複数集約を更新しない

レビューチェックリスト

既存の集約をレビューする際に使用する。

Design by Contract
  • 事前条件が明確に定義されているか（require）
  • 事後条件が満たされているか（ensuring）
  • 不変条件がコンストラクタ・各操作後に維持されているか
基本原則
  • 集約は不変(Immutable)か、または不変にできない明確な理由があるか
  • 他の集約への直接参照を保持していないか（IDのみか）
  • 完全コンストラクタを提供しているか
  • 補助コンストラクタは基本コンストラクタを利用しているか
  • 可変オブジェクトを返す場合、防御的コピーをしているか
  • 不変条件がコンストラクタで検証されているか
Evans Rules
  • 集約ルートのみがリポジトリから直接取得されるか
  • 外部から集約内部への直接参照がないか
  • 内部エンティティの識別子は一時的な利用に限られているか
Vernon's Rules
  • 真の不変条件のみが集約境界内にあるか（過剰な含有がないか）
  • 集約は十分に小さいか（数百件のコレクションを含んでいないか）
  • 他の集約はIDのみで参照しているか
  • 集約間の整合性は結果整合性で担保されているか
構造原則
  • 外部からのアクセスは集約ルート経由のみか
  • 内部エンティティを直接操作できる穴がないか
  • 集約のサイズは適切か（大きすぎないか）
連携原則
  • 状態変更時にドメインイベントを発行しているか
  • 楽観的ロックの要件がある場合、バージョン番号を実装しているか
  • 楽観的ロックの要件がないのに、不要なバージョン番号を持っていないか
  • 永続化ロジックが集約内に漏れていないか

関連スキル（併読推奨）

このスキルを使用する際は、以下のスキルも併せて参照すること：

  • domain-building-blocks: 集約を構成する要素（値オブジェクト、エンティティ、ドメインサービス）の設計
  • aggregate-transaction-boundary: 集約とトランザクション境界の関係（1トランザクション=1集約ルール）
  • cross-aggregate-constraints: 集約間の制約チェックと結果整合性の設計
  • repository-placement: 集約のリポジトリインターフェースの配置場所

Comments

Markdown supported