イベントソーシング

例：船の追跡（C＃）

ここでは、基本的なアイデアを伝えるための非常にシンプルなイベントソーシングの例を示します。この例では、開始点として機能するように意図的に非常にシンプルにしています。その後、より複雑な問題をいくつか探求するために、さらに例を使用します。

ドメインモデルは、貨物を輸送し、港間を移動する船のシンプルなモデルです。

モデルに影響を与えるイベントには、4種類あります。

• 到着：船が港に到着する
• 出発：船が港を出発する
• 積み込み：貨物が船に積み込まれる
• 積み下ろし：貨物が船から積み下ろされる

船を移動させる簡単な例を見てみましょう。

class Tester...

  Ship kr;
  Port sfo, la, yyv;
  Cargo refact;
  EventProcessor eProc;

  [SetUp]
  public void SetUp() {
    eProc = new EventProcessor(); 
    refact = new Cargo ("Refactoring");
    kr = new Ship("King Roy");
    sfo = new Port("San Francisco", Country.US);
    la = new Port("Los Angeles", Country.US);
    yyv = new Port("Vancouver", Country.CANADA) ;
  }

[Test]
public void ArrivalSetsShipsLocation() {
  ArrivalEvent ev = new ArrivalEvent(new DateTime(2005,11,1), sfo, kr);
  eProc.Process(ev);
  Assert.AreEqual(sfo, kr.Port);
}
[Test]
public void DeparturePutsShipOutToSea() {
  eProc.Process(new ArrivalEvent(new DateTime(2005,10,1), la, kr));
  eProc.Process(new ArrivalEvent(new DateTime(2005,11,1), sfo, kr));
  eProc.Process(new DepartureEvent(new DateTime(2005,11,1), sfo, kr));
  Assert.AreEqual(Port.AT_SEA, kr.Port);    
}

これらのテストを機能させるには、到着と出発のイベントだけが必要です。イベントプロセッサは非常にシンプルです。

class EventProcessor...

  IList log = new ArrayList();  
  public void Process(DomainEvent e) {
    e.Process();
    log.Add(e);
  }

各イベントには、processメソッドがあります。

class DomainEvent...

  DateTime _recorded, _occurred;
  internal DomainEvent (DateTime occurred) {
    this._occurred = occurred;
    this._recorded = DateTime.Now;
  }
  abstract internal void Process();

到着イベントは単にデータをキャプチャし、適切なドメインオブジェクトにイベントを転送するだけのprocessメソッドを持っています。

class DepartureEvent...

  Port _port;
  Ship _ship;
  internal Port Port  {get { return _port; }}
  internal Ship Ship  {get { return _ship; }}
  internal DepartureEvent(DateTime time, Port port, Ship ship) : base (time)  {
    this._port = port;
    this._ship = ship;
  }
  internal override void Process() {
    Ship.HandleDeparture(this);
  }

したがって、ここではイベントが処理選択ロジックを実行します。処理ドメインロジックは、船によって実行されます。

class Ship...

  public Port Port;
  public void HandleDeparture(DepartureEvent ev) {
    Port = Port.AT_SEA;
  }

出発イベントは、単にShipの港を特殊なケースに設定します。私はイベントをドメインオブジェクトに渡していることに気づくでしょう。ここには、イベントがドメインオブジェクトが処理に必要なデータだけを渡すのか、イベント自体を渡すのかという選択があります。イベントを渡すことで、イベントはドメインロジックが必要とするデータを正確に知る必要がなくなります。イベントが後で追加のデータを取得した場合、署名を更新する必要はありません。イベントを渡すことの欠点は、ドメインロジックがイベント自体を認識することです。

そのシンプルなテストは、基本的なイベント処理がどのように機能するかを示しているだけです。次に、ドメインロジックがどのように機能するかを示す小さな例を示します。私たちの船は、私の本を世界中に移動させるための輸送ライン全体を持つという私のファンタジーを満たすために本を輸送しています。ご存じのとおり、カナダを経由して本を送ることは非常に危険です。それは、本が大量の「ええ」で汚染されるリスクがあるためです。ほとんどすべての文にええがある本を見たことがあります（長い文では2、3個になることがあります）。

したがって、私の完璧な書籍輸送システムは、貨物がカナダを通過したかどうかを検出できる必要があります。

class Tester...

  [Test]
  public void VisitingCanadaMarksCargo() {
    eProc.Process(new LoadEvent(new DateTime(2005,11,1), refact, kr));
    eProc.Process(new ArrivalEvent(new DateTime(2005,11,2), yyv, kr));
    eProc.Process(new DepartureEvent(new DateTime(2005,11,3), yyv, kr ));
    eProc.Process(new ArrivalEvent(new DateTime(2005,11,4), sfo, kr));
    eProc.Process(new UnloadEvent(new DateTime(2005,11,5), refact, kr));
    Assert.IsTrue(refact.HasBeenInCanada);
  }

貨物は船間を移動したり、降ろしたりする可能性があるため、これらの北部の危険にさらされたかどうかを知る責任は貨物にあります。幸いなことに、リスクは実際に港にいる場合にのみ発生し、水中にいるだけでは安全です。したがって、到着イベントはこれを追跡する必要があります。

class ArrivalEvent...

  Port _port;
  Ship _ship; 
  internal ArrivalEvent (DateTime occurred, Port port, Ship ship) : base (occurred) {
    this._port = port;
    this._ship = ship;
  } 
  internal Port Port {get {return _port;}}
  internal Ship Ship {get{return _ship;}}
  
  internal override void Process() {
    Ship.HandleArrival(this);
  }

ここでも、ハンドラーはShipオブジェクトです。

class Ship...

  IList cargo;
  public void HandleArrival (ArrivalEvent ev) {
    Port = ev.Port;
    foreach (Cargo c in cargo) c.HandleArrival(ev);
  }

船はカナダへの訪問を追跡する責任がないため、到着通知を貨物に渡します。

class Cargo...

  public bool HasBeenInCanada = false;
  public void HandleArrival(ArrivalEvent ev) {
    if (Country.CANADA == ev.Port.Country) 
      HasBeenInCanada = true;
  }

イベントprocessメソッドがドメインロジックを保持する場合の代替案を考えてみましょう。ドメインロジックが複雑になるにつれて、ドメインモデルに関する多くの知識が必要になります。このアプローチでは、ドメインオブジェクトはイベントを関連オブジェクトに渡して、応答で必要な処理を実行できるようにします。

例：外部システムの更新（C＃）

イベントソーシングの優れた機能の1つは、イベントを好きなだけ再処理できることです。ただし、イベントを処理すると外部システムとのインタラクションが発生する場合は、これは悪いことです。最良の事態は、それらがあなたのすべてのスパムイベントに飽きてしまうことです。

この問題を解決する簡単な方法は、システムが外部システムを呼び出す際に、イベントを「実際に」処理している場合を除いてメッセージが送信されないように構成できるゲートウェイを介して呼び出すようにすることです。

今回は船と港（今回は貨物なし）を使用した簡単な例でこれを説明します。船が港に入るたびに、地元の税関当局に通知する必要があるとしましょう。これは、イベント処理ドメインロジックで実現できます。

class Port...

  public void HandleArrival (ArrivalEvent ev) {
    ev.Ship.Port = this;
    Registry.CustomsNotificationGateway.Notify(ev.Occurred, ev.Ship, ev.Port);
  }

このコードは、ゲートウェイオブジェクトで通知を呼び出すだけで、これが実際の処理であるか、何らかの再生であるかを気にしないことに注意してください。ここでの一般的な原則は、ドメインロジックはイベントの実行のコンテキストを決して気にするべきではないということです。

実際にメッセージを送信するかどうかを判断するのは、ゲートウェイの責任です。この場合は非常に単純なので、イベントプロセッサへのリンクを持ち、プロセッサがアクティブかどうかを確認するだけでこれを行います。

class CustomsEventGateway...

  EventProcessor processor;
  public void Notify (DateTime arrivalDate, Ship ship, Port port) {
    if (processor.isActive) 
      SendToCustoms(BuildArrivalMessage(arrivalDate, ship, port));
  }

イベントプロセッサは、通常の処理を実行するときに、自身をアクティブにするだけです。

class EventProcessor...

  public void Process(DomainEvent e) {
    isActive = true;
    e.Process();
    isActive = false;
    log.Add(e);
  }

このケースは非常に単純ですが、基本的な原則は同じです。ゲートウェイは、外部メッセージを送信するかどうかを決定します。ドメインロジックではありません。ゲートウェイは、処理のコンテキストについて収集した情報に基づいてこれを決定します。この場合、プロセッサからの単純なブール状態だけで十分です。

例：イベントの反転（C＃）

ここでは、輸送の例を取り上げ、イベントを反転する方法を見てみましょう。反転に必要な最も重要なことは、イベントによって状態が変化したオブジェクトの前の状態を正確に計算できるようにすることです。

この前のデータを格納するのに適した場所はイベント自体です。これは、ドメインオブジェクト間でイベントを渡すという例のアプローチとうまく機能します。ドメインオブジェクトはイベントを保持しているため、それらのイベントに関する情報を簡単に格納できます。

読み込みイベントは簡単な例です。イベントは、次のソースデータを伝送します。

class LoadEvent...

  int _shipCode;
  string _cargoCode;
  internal LoadEvent(DateTime occurred, string cargo, int ship) : base(occurred){
    this._shipCode = ship;
    this._cargoCode = cargo;
  }
  internal Ship Ship {get { return Ship.Find(_shipCode); }}
  internal Cargo Cargo {get { return Cargo.Find(_cargoCode); }}

処理はcargoオブジェクトに渡されます。このオブジェクトは、貨物の前の場所であった港を格納する必要があります。

class LoadEvent...

  internal override void Process() {
    Cargo.HandleLoad(this);
  }

internal Port priorPort;

class Cargo...

  internal void HandleLoad(LoadEvent ev) {
    ev.priorPort = _port;
    _port = null;
    _ship = ev.Ship;
    _ship.HandleLoad(ev);
  }

イベントを反転するには、ドメインオブジェクトで反転メソッドを呼び出すprocessメソッドをミラーリングする反転メソッドを追加します。

class LoadEvent...

  internal override void Reverse() {
    Cargo.ReverseLoad(this);
  }

class Cargo...

  public void ReverseLoad(LoadEvent ev) {
    _ship.ReverseLoad(ev);
    _ship = null;
    _port = ev.priorPort;
  }

この場合、イベントは、処理データの一部である可変の以前のデータの束を受け取ります。このような場合、単純なフィールドで十分です。他のケースでは、より洗練されたデータ構造が必要になる場合があります。貨物が到着イベントを処理するとき、カナダに滞在したかどうかを追跡します。これは、単純なブールフィールドで行うことができます。イベントに以前の値を格納するには、多くの場合、到着の影響を受ける可能性があるため、単純なフィールドよりも多くのものが必要です。したがって、この場合は、貨物によってインデックスが付けられたマップを使用します。

class Cargo...

  public void HandleArrival(ArrivalEvent ev) {
    ev.priorCargoInCanada[this] = _hasBeenInCanada;
    if ("CA" == ev.Port.Country) 
      _hasBeenInCanada = true;
  }
  private bool _hasBeenInCanada = false;
  public bool HasBeenInCanada {get { return _hasBeenInCanada;}}

class ArrivalEvent...

  internal Port priorPort;
  internal IDictionary priorCargoInCanada = new Hashtable();

次に、反転します。

class Cargo...

  public void ReverseArrival(ArrivalEvent ev) {
    _hasBeenInCanada = (bool) ev.priorCargoInCanada[this];
  }

この例は、イベントのソースデータとエラー処理が反転方法にどのように影響するかをうまく示しています。ロードイベントの場合、貨物がロードされたときに貨物があった港を格納する必要があります。イベントにこれがソースデータに含まれている場合、これを行う必要はありません。少し余分なソースデータがあれば、前のデータを追加する必要がなくなります。これはどこでも機能するわけではありません。到着イベントは、貨物の以前のカナダの状態を調達することはできません。

正しいと見なされる処理も違いを生む可能性があります。このシステムでは、船の到着イベントと出発イベントの両方があります。すべてが正しく機能すると仮定すると、これらは常にインターリーブされるはずです。したがって、船は、ポートフィールドをPort.OUT_TO_SEAに設定することにより、到着イベントを反転できます。連続して2つの到着イベントが発生した場合はどうなりますか？これを反転するには、船の前の港を格納する必要があります。別の方法としては、出発を伴わない2回目の到着をエラーとして宣言することです。このストレージを行う必要はありません。

例：外部クエリ（C＃）

基本的なイベントソーシングの場合でも、外部クエリは扱いにくいものです。これは、アプリケーションの状態を再構築する場合は、過去に行われた外部クエリの応答を使用して再構築する必要があるためです。

船が港に入る際に貨物の価値を決定しなければならない場合を想像してみましょう。この評価は、外部サービスによって行われます。11月3日に船が港に入り、イベントをすぐに処理すると、11月3日時点の貨物の価値が得られます。12月5日にアプリケーションの状態を再構築する場合、その価値がその間に変化していたとしても、同じ貨物の価値が必要になります。

この例では、外部クエリの記録を保持し、イベントを再処理するときに値を提供することで、これを処理する1つの方法を示します。多くの点で、外部更新で使用するアプローチに似ています。インタラクションをシステムの境界でのイベントに変換し、イベントの記録を使用して発生したことを記憶します。

これらの例の他の場所で使用しているイベント処理と同様のスタイルを使用して、イベントをドメインオブジェクトに渡して処理します。この場合、貨物は外部システムへの呼び出しを開始し、値を保存します。（この値で実際に役立つことを行うと仮定しますが、これはこの例とは関係ありません。）

class Cargo...

  public void HandleArrival(ArrivalEvent ev) {
    declaredValue = Registry.PricingGateway.GetPrice(this);
  }
  private Money declaredValue;

私の習慣に従い、私が制御するゲートウェイを介してすべての外部システムアクセスをカプセル化します。基本的なゲートウェイは、外部インタラクションに必要なものを呼び出しに変換するだけです。イベントの再生をサポートするために、これらのクエリをログに記録するクラスでこれをラップします。

図6：イベントからの適切な再構築をサポートするために、ロギングゲートウェイでゲートウェイをラップします。

ロギングゲートウェイは、各呼び出しで、この呼び出しに一致する古いリクエストがあるかどうかを確認し、ない場合は新しいリクエストを作成します。

class LoggedPricingGateway...

  public Money GetPrice(Cargo cargo) {
    GetPriceRequest oldReq = oldRequest(cargo);
    if (null != oldReq) return (Money) oldReq.Result; 
    else return newRequest(cargo);
  }

リクエストが新しいリクエストの場合、リクエストをイベントオブジェクトに変換し、外部クエリを呼び出し、ログに保存します。

class LoggedPricingGateway...

  private Money newRequest(Cargo cargo) {
    GetPriceRequest request = new GetPriceRequest(cargo);
    request.Result = gateway.GetPrice(cargo);
    log.Store(request);
    return (Money) request.Result;
  }

private class GetPriceRequest : QueryEvent {
  private Cargo cargo;
  public GetPriceRequest(Cargo cargo) : base() {
    this.cargo = cargo;
  }

class QueryEvent...

  DomainEvent _eventBeingProcessed;
  Object result;
  public QueryEvent() {
    _eventBeingProcessed = Registry.EventProcessor.CurrentEvent;
  }
  public object Result {
    get { return result; }
    set { result = value; }
  }
  public DomainEvent EventBeingProcessed {
    get { return _eventBeingProcessed; }
  }
}

したがって、古いリクエストを見つけるために、ログを検索します。

class LoggedPricingGateway...

  private GetPriceRequest oldRequest(Cargo cargo) {
    IList candidates =
      log.FindBy(EventProcessor.CurrentEvent, typeof (GetPriceRequest));
    foreach (GetPriceRequest request in candidates) {
      if (request.Cargo.RegistrationCode == cargo.RegistrationCode)
        return request;
    }
    return null;
  }

クエリログは汎用であるため、処理されたドメインイベントとリクエストのタイプを使用して、いくつかのアイテムを取得するクエリを発行できます。これにより、ゲートウェイ固有の方法でさらに確認する必要がある小さなセットが得られます。

リクエストのログは、アプリケーションの状態を再構築するために必要なため、ドメインイベントのログが永続化されるのと同じ方法で永続化する必要があります。