event-sourcing

イベントソーシング

目次

• 概要
• 使用する場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

現在の状態ではなく、状態の変更をイベントのシーケンスとして保存することで、時間軸に沿ったクエリ、監査証跡、イベントの再生を可能にします。

使用する場面

• 監査証跡が必要な場合
• 時間軸に沿ったクエリ（任意の時点での状態）
• イベント駆動型マイクロサービス
• CQRS の実装
• 金融システム
• 複雑なドメインモデル
• デバッグと分析
• コンプライアンスと規制

クイックスタート

最小限の実行可能な例：

interface DomainEvent {
  id: string;
  aggregateId: string;
  aggregateType: string;
  eventType: string;
  data: any;
  metadata: {
    userId?: string;
    timestamp: number;
    version: number;
  };
}

interface Aggregate {
  id: string;
  version: number;
}

class EventStore {
  private events: DomainEvent[] = [];

  async appendEvents(
    aggregateId: string,
    expectedVersion: number,
    events: Omit<DomainEvent, "id" | "metadata">[],
// ... (see reference guides for full implementation)

リファレンスガイド

詳細な実装については、references/ ディレクトリを参照してください。

ガイド	内容
イベントストア（TypeScript）	イベントストア（TypeScript）
プロジェクション（読み取りモデル）	プロジェクション（読み取りモデル）
PostgreSQL を使用したイベントストア	PostgreSQL を使用したイベントストア
パフォーマンス向上のためのスナップショット	パフォーマンス向上のためのスナップショット

ベストプラクティス

✅ 推奨事項

• イベントを不変の状態で保存する
• イベントにバージョンを付ける
• 楽観的同時実行制御を使用する
• パフォーマンス向上のためにスナップショットを作成する
• クエリにはプロジェクションを使用する
• イベントを小さく、目的に絞ったものにする
• メタデータ（タイムスタンプ、ユーザーなど）を含める
• イベントのバージョン管理と移行に対応する

❌ 避けるべき事項

• 過去のイベントを変更する
• 現在の状態だけを保存する
• 同時実行チェックを省略する
• 読み取りにイベントストアをクエリする
• イベントを大きくしすぎる
• イベントスキーマの進化を考慮しない