はじめに

開発室のはちわれです。ナイルに転職して約3ヶ月、Scalaの経験も転職してから本格的にコードを書く様になったのでまだ3ヶ月です。普段はScala、Akkaを使って開発を行っています。今回は、Scala試用期間中の私でも出来たakka-clusterとakka-persistentを使った「Event Sourcing+CQRS」を実現する方法について書かせて頂きたいと思います。

今回やること

最初に書かせて頂きましたが、今回はakka-clusterとakka-persistentを組み合わせて
「Event Sourcing+CQRS」を実現する一例を紹介させて頂きます。
本題に移る前に、Event SourcingとCQRSについて軽く触れさせて頂きます。

Event Sourcing

ステート(状態)ではなく、イベントを中心に考えられたアークテクチャ
ステートではなく、全てのイベントを保存、再生することによってステートを表します。

CQRS(コマンドクエリ責任分離)

Command Query Responsibility Segregationの略です。
簡単に説明するとCommand(更新)とQuery(参照)を明確に分離しようという考え方です。
弊社でも取り入れているDDD(ドメイン駆動設計)と一緒に語られることが多いです。
一緒に語られるのが多いのはQuery側はドメインの影響を受けることが少なく、逆にCommand側はドメインの影響を受けることが多い為ドメインの分離により、CommandとQueryの分離が自然に行えることが多い為かと思います。
どの程度CommandとQueryの分離を行うかは、人によって認識や意見が別れることもあるかと思います。今回の記事を執筆する上で調査した限りでも、アプリケーションのレイヤーでドメイン層からQueryを出すべきという方もいればドメイン層の中で分離を行うという意見もあり、この辺は携わっているシステムのドメインによる所かと思います。

この実装によって得られるもの

今回の実装によって、Event sourcingとCQRSを実現することができます。
また、それと伴にakka-clusterとakka-persistentを組み合わせることにより、以下の効果も同時に得ることができます。

  • 耐障害性(Resilient)

ここで言う耐障害性とは、障害が起きないという意味での耐障害性ではありません。
障害が発生した際の高い回復性を指し、リアクティブ宣言で言われるResilientにあたります。この高い回復性は以下のメカニズムによって実現されています。

  • akka-clusterのfailure detector
  • akka-persistentのリカバリー機能
  • ドメインの分離による高い独立性と保守性
    CQRSの概念に基づいてCommandとQueryの分離(ドメインの分離)をすることにより、それぞれを独立したコンポーネントして扱うことができます。
    これにより、CommandとQueryが疎結合となりどちらかに修正を行った際に、もう片方にも修正を行わなければならないという事態を避けることができ
    修正の影響を気にすることなく、作業を行うことができます。
    ドメインの変更があった場合も、Command側だけに影響する内容であればCommand側だけを修正すれば良く工数の短縮と高い保守性を得ることができます。

実装例

それでは、少し前置きが長くなってしまいましたが、これからコードを交えながら
今回の実装例について説明をさせていただきます。まず構成のイメージは下記の図をご覧ください。

構成イメージ

implements_image

簡単に今回の構成について説明します。
クラスターのノードはCommad(更新)を行うノードとQuery(参照)を行うノードの2種類があります。Commandノードは更新のイベント、Queryノードは参照のイベントだけをそれぞれClusterClientから受け取ります。Commandノードはクラスターの中でシングルトンのノードして存在し、このノードが持つデータをマスターのデータとします。Commandノードにて行われたイベントをQueryノードにPublishして、Query側はそのイベントを実行することによりCommandとQueryのノードの状態が同期されます。

※先に断っておきますと、コードの中のsleepやprintln、logなどはデモの為のコードとなります。見やすくする為に、コードしては必要ない空行なども入れていますので予めご了承ください

環境情報

今回の実装例のコードは以下のバージョンを対象としています。
設定は後述しているbuild.sbtを参照して下さい。

  • Scala:2.11.8
  • akka-persistence:2.4.8
  • akka-cluster:2.4.8
  • akka-cluster-tools:2.4.8
  • akka-actor:2.4.8

Write側ノードの実装

更新処理の実装

Write側の実装について説明します。
使っている主な機能としては、以前こちらのブログでも紹介したPersistentActorとakka-cluster-toolsのDistributedPubSub、DistributedPubSubMediatorです。
receiveCommandにて更新イベントであるWriteをレシーブし、persistでイベントをjournalに永続化しています。
更新処理を行った後に、publishToReadでQuery側にイベントを送っています。
Query側へのイベントのpublishには、akka-cluster-toolsのDistributedPubSub、DistributedPubSubMediator(以下、mediator)を使っています。mediatorはクラスターのノード間でメッセージをやり取りする仕組みです。
PubSubという名称からも分かる通りPublish/Subscribeメッセージングモデルであり、Publisher側がメッセージを送りたいSubscribeを指定してメッセージを送信することになります。使い方自体は難しくなくmediatorを生成し、mediatorに対して対象となるSubscribeの名称とイベントを持ったPublishを送ることによってSubscribe側にイベントが送られます。今回の例では”read”という名称でSubscribeしているノードに対してメッセージを送信しています。

実際の更新処理は、WriteNodeActorからは切り離して別のクラスで実装しています。
こうした理由はCommandとQueryはあくまでクラスターのノードとして扱い、実際の更新のドメインとは疎結合とすることによって互いの修正が影響しあわない様にするためです。

スナップショットの保存と保存時のイベントのレシーブについて

スナップショットの保存は、SaveSnapshotEventをレシーブした後の一連処理で行われます。ポイントはcontext.becomeとunbecome、stashとunstashAllです。以下に一連の流れを示します。

スナップショット保存の流れ 

  • SaveSnapshotEventをレシーブ。
  • context.becomeで処理の実行をreceiveCommandSavingに移譲。
    • これによりスナップショットの保存が終わるまでのレシーブはreceiveCommandSavingが行う。
  • case other -> 更新のイベントが送られてきた場合、送られてきたイベントをstash。
  • case SaveSnapshotEvent -> 既にスナップショットが保存中である事をログ出力。
  • case SaveSnapshotSuccess (スナップショット保存成功)
    • 新たにスナップショットが保存されたので、それ以前のjournalはリカバリーの際に不要の為削除。
    • unstashAll()でstashしていたイベントを実行。
    • context.unbecome()で処理の実行をreceiveComanndに戻す。
  • case SaveSnapshotFailure(スナップショット保存失敗)
    • エラー情報をログに出力。
    • unstashAll()でstashしていたイベントを実行。
    • context.unbecome()で処理の実行をreceiveComanndに戻す。

cotext.becomeで処理の実行を別の処理に移すことが出来ます。上記の実装例ではスナップショット保存中のレシーブをreceiveCommandSavingに移譲しています。元の処理に戻したい時はcontext.unbecomeによって戻すことが出来ます。
stashはGitのstashと同じで、送られてきたイベントを一時退避させておくことが出来ます。
unstashAllを実行することにより、stashしていたイベントが順次実行されていきます。
また、下記のコードでjournalの削除を行っていますが、sequenceNrの値を−1しているのは最新のjournalを残す為に行っています。最新のjournalを残さなければならない理由は2つあります。

  1. journalの採番をそのまま連番で続ける為。
  2. 起動、リカバリー時にjournalを読み込める様にする為。

1つ目の理由について説明します。journalは保存される際に自動的にシーケンシャルナンバーが採番されますが、ここでjournalを全て消してしまうと次に保存されるjournalのナンバーが再び1から始まってしまいます。それを避けるため最新のjournalを残しておいて、その次の番号が振られる様にしています。新しくスナップショット保存しているんだから、また1から採番するので良いのではないか?と思われるかもしれませんが、そうしてしまうと起動、リカバリー時に問題があります。PersistentActorは起動、リカバリー時にスナップショットから状態を復元した後に、journalを読み込んでリプレイすることによって最新の状態まで自身の状態を戻しますが、この際に使用したスナップショット以降のシーケンシャルナンバーを指定してjournal読み込みます。もしこの時にナンバーがまた1から振られているとPersistentActorはスナップショットの次のナンバーを指定して読み込みに行きますが、journalは1から番号が採番されている為、指定された番号と合わず読み込むことが出来ないため最新の状態に復元が出来なくなってしまいます。これが最新のjournalを残す2つ目の理由です。

journalを削除する処理

リカバリーなどのPersistentActorの機能については以前のブログでも紹介させて頂いておりますので、今回の記事では割愛させて頂いています。PersistentActorの動作自体の詳細を知りたいという方は、PersistentActorの良いところと使い方をご覧ください。

Read側ノードの実装

Read側のノードでは情報の参照と、Write側から送られてくるイベントをレシーブする処理を実装します。上記のQuery側のノードでは、状態を更新する処理は持っていません。
状態の更新の処理は前述した通りEventImplementsに実装してあります。
これにより、更新処理の詳細とQuery側の処理を切り離しています。
更新側と同じ様に、mediatorを生成していますが更新側と違うのはSubscribe側は自分自身をmediatorのSubscribeとして登録する必要がある点です。下記のコードで自分自身をreadという名前のTopicsでSubscribeとして登録しています。
これでCommand側のノードから”read”という指定でPublishされるイベントをレシーブすることが出来る様になります。

参照のイベントであるGetをレシーブした際は、Getイベントのkeyを使って自身のステートであるMapからkeyのvalueを取得しています。Writeイベントのレシーブがありますが、これはWrite側からPublishされてくるWriteイベントをレシーブして自身のステートを更新する為です。今回の実装例では更新のイベントを送ってくるのは、あくまでWrite側のノードだけでありClient側から更新のイベントが送られてくることはありません。

実装例では、Command側とQuery側は同じデータソース、今回の場合はmutable.Mapでステートを保持していますが、もっと突き詰めたCQRSのアーキテクチャの例では、Command側とQuery側のデータソースを別々の物にすることが推奨されていたりしますので、Query側はjournalなどからイベントを読み込んで、リプレイすることによりステートを更新する様にした方が良いかもしれません。

akka-persistentのPersistentQueryを使えば、その様な実装も可能かと思います。今回PersistentQueryを使わず、PubSubMediatorを使う実装を選択したのは、その方が処理のステップが少なく済むからです。
PersistentQueryとPubSubMediatorを使った場合のステップを比較すると、以下の様に違いが出ます。

  • PersistentQueryの場合
    • Command側が更新のイベントがあったことを伝えるメッセージを送信。
    • Query側がメッセージを受け取る。
    • Query側がjournalからイベントを取得。
    • 取得したイベントをリプレイ。
  • PubSubMediatorの場合
    • Commad側が自身で行われたイベント自体を送信。
    • Query側がイベントを受け取る。
    • 取得したイベントをリプレイ。

上記の様に、PubSubMediatorの方が処理のステップが少なくても済む為今回の例では、PubSubMediatorを採用しました。
また上記はあくまで私の理解なので、もしかしたらPersistentQueryでも、もっと処理のステップを少なく済ませる方法があるのかもしれません。

ClusterPackage

上記のClusterPackageはakka-persistent、akka-clusterとは関係ありません。
今回の実装例で使っているWriteやGetなどのイベントをcase classとしてまとめて定義しておき、WriteNodeActor、ReadNodeActorの両方で使える様にしてあるだけです。
良ければ、こういうやり方もあるとの参考にして頂ければと思います。

ClusterClientReceptionistのListenerを実装

後々クラスターの起動の所で説明しますが、クラスターのノードへメッセージを送る際に今回の例ではClusterClientを使っています。ClusterClientからメッセージを受け取る為にはClusterClientReceptionistにクラスターのノードとなるActorを登録するのと、ClusterClientReceptionistのリスナーとなるActorも必要となり上記はそのActorの実装になります。

ClusterClientの実装

ClusterClientを生成してメッセージを送っています。sendEventに渡されたeventの型からメッセージの送り先のノードを切り替えています。Writeの場合はCommad側ノード、Getの場合はQuery側ノードにメッセージが送られる様になっています。
今回の例や公式ドキュメントを見ると、上記の様に 「ClusterClientのActor ! ClusterClient.Send(…」となっていますがクラスターからの結果を受け取りたい場合は、「!」でメッセージを送ると結果が取得できないので注意して下さい。結果を受け取りたい場合は、「ClusterClient.Send(…」とすれば良いです。(※もちろんノード側に実装もちゃんと結果を返す様になっている必要があります、)

設定ファイル

build.sbt

application.conf

client.conf

クラスターの起動とデモ

起動

実行

それでは、クラスターの起動について説明します。
まずはQuery側のノードの起動から説明していきます。startReadNodeという処理の中で起動を行っています。
行っているのは以下の3つです。

  • QueryのノードとなるActorの生成。
  • 生成したActorをClusterClientReceptionistに登録。
  • QueryノードのActorを子ActorとしてClusterClientReceptionistのリスナーのActorを生成。

Query側のノードなるActorを生成する所までは普通にActorを生成すれば良いですが、ClusterClientからのメッセージを受け取る為には生成したActorをClusterClientReceptionistに登録する必要があります。ClusterClientReceptionistのregisterServiceに生成したActorを渡すことで登録されます。更にClusterClientReceptionistのリスナーが必要となるので、生成したQueryノードのActorを子ActorとしてリスナーのActorを生成しています。

次にCommand側のノードについて説明します。startUpdateNodeという処理の中で起動を行っています。行っているのは以下の4つです。

  • Commadのノードをシングルトンのノードして生成。
  • シングルトンのノードのProxyとなるActorを生成。
  • ProxyのActorをClusterClientReceptionistに登録。
  • ProxyのActorを子ActorとしてClusterClientReceptionistのリスナーのActorを生成。

Actorsystemを起動する所まではQuery側と同じですが、今回Command側のノードはシングルトンのノードなる様に生成します。こうした理由はCommandが持つ状態をmasterの状態として一意の存在にしておきたかったからです。
シングルトンのノードの生成には、ClusterSingletonManager.propsを使います。propsの各引数に値を渡して返されるPropsからActorを生成します。シングルトンのノードはこれで生成出来ましたが、このノードには直接メッセージを送る事は出来ません。ProxyとなるActorを生成し、そのActorを介してメッセージを送る形になります。Proxyとして生成したActorはクラスター上のどこかに在る、シングルトンノードの位置情報を持っておりシングルトンノードへのアクセスを行ってくれます。
ProxyとなるActorは上記のコードの通りClusterSingletonProxy.props関数の引数にシングルトンノードのActorのパス、ロールを設定して返されるPropsからActorを生成します。あと行っているのはQuery側と同じ様にClusterClientReceptionistへの登録と、ClusterClientReceptionistのリスナーの生成です。Query側と違うのはClusterClientReceptionistに登録するのと、リスナーの子ActorとなるActorはProxyのActorとなる点です。

mainメソッドの中で、上記の起動処理2つを呼び出してクラスターの起動を行っています。
Query側のノードは今回の例では2つノードを用意したかったので、それぞれportを2552、2553に指定して起動しています。ノードをもっと増やしたい場合は、ここで指定するポートを増やせばその数の分起動できます。ポートはノード毎に一意でなければならず、同じポートを指定することは出来ません。

Command側はシングルトンのノードなのでportをひとつ指定して起動しています。
そしてClusterClientのsendEventでメッセージ(イベント)を送っています。まずCommandノードに更新のイベントを送ります。Commandノードは受け取ったイベントから自身の状態を更新し、その後Query側にイベントをPublishします。
Query側の2つのノードは、それぞれイベントを受け取ると自分たちの状態を更新します。
コードの中で行っているsleepは起動したActorがクラスターに入ってアクセス可能な状態になるまでタイムラグがあり、その間にメッセージを送ってもアクセスできずdead_letterとなる為、アクセス出来る状態となるまでに待つ為にsleepさせています。通常クラスターを起動する時には、この様なsleepは不要です。
それでは実際に動かした結果を見てみたいと思います。

※クラスターの起動のログは長いので必要な箇所を抜粋して載せてあります。

JOININGやUpなど出ていますが、これはクラスターのメンバーシップ(ノード)のライフサイクルを示しています。詳細はAkkaの公式ドキュメントをご覧頂ければと思いますが、簡単なライフサイクルを示すと以下の様になります。

ライフサイクルの流れ

  1. JOINING -> クラスターに入ろうとしている
  2. Up -> クラスターに入ってアクセス可能になった状態
  3. Leaving -> クラスターから正常ぬに抜けようとしている状態
  4. Down −> ノードがおち落ちてしまった状態
  5. removed ->クラスターから削除された状態

これらの各ノードの状態の遷移や管理はクラスターのLeaderという機能が行っています。上のログでも「Leader is moving node」という様にLeaderがノードを遷移させているのが分かると思います。

実行結果として以下の流れになりイベントが伝播され、ノード間で状態が同期されているのが分かると思います。

  1. Commandのノードが起動してクラスタに入り、Upの状態となる。
  2. CommandにClusterClientからイベントを送る。
  3. Commandがイベントをレシーブ。
  4. Commandが自身の状態を更新。
  5. Query側にイベントPublish
  6. Query側がイベントをSubscribe
  7. Query側の2つのノードの状態が更新される
  8. Query側に状態を取得するイベントを送る。
  9. 更新された状態が取得される。

まとめ

以上で、akka-clusterとPersistentActorの組み合わせによってEvent SourcingとCQRSを実現する実装例の紹介とさせて頂きます。今回紹介したのは、あくまで一例でありakka-clusterやakka-persistentの他の機能を使ったりノードの起動する数や、どの様なノードとして起動するかで柔軟に構成を変更してシステムを構築する事が出来ます。最後に今回の実装例の要点をまとめます。

  • akka-clusterとakka-persistentを組み合わせることによってEvent SourcingとCQRSを実現するシステムを構築する事が出来る。
  • akka-persistentのリカバリー機能等によって耐障害性の高いシステムを構築できる。
  • クラスターのノードの実装や実際の更新処理を明確に分離することによって、ドメインの分離とCQRSを実現でき保守性も高くなる。
  • クラスターのノードを起動の仕方によって様々な構成のクラスター構成を実現することが出来る。