開発環境またはテスト環境の RabbitMQ でイベント バスを実装する

  • [アーティクル]

ヒント

このコンテンツは eBook の「コンテナー化された .NET アプリケーションの .NET マイクロサービス アーキテクチャ」からの抜粋です。.NET Docs で閲覧できるほか、PDF として無料ダウンロードすると、オンラインで閲覧できます。

PDF のダウンロード

eBook の「コンテナー化された .NET アプリケーションの .NET マイクロサービス アーキテクチャ」のカバー サムネイル。

eShopOnContainers アプリケーションの場合のようにコンテナーで実行される RabbitMQ に基づいてカスタム イベント バスを作成した場合、その使用は開発環境およびテスト環境に限定する必要があるということを述べることから始めます。 以下の「その他のリソース」セクションで説明されているように、運用に対応したサービス バスの一部として構築する場合を除き、運用環境には使用しないでください。 単純なカスタム イベント バスには、商用サービス バスが備えている重要な実働可能機能の多くが不足している可能性があります。

eShopOnContainers でのイベント バスのカスタム実装の 1 つは、基本的に、RabbitMQ API を使用するライブラリです。 (Azure Service Bus に基づく別の実装もあります)。

図 6-21 に示すように、RabbitMQ でのイベント バスの実装により、マイクロサービスはイベントのサブスクライブ、イベントの発行、およびイベントの受け取りを行うことができます。

メッセージ送信者とメッセージ受信者の間の RabbitMQ を示す図。

図 6-21 イベント バスの RabbitMQ 実装

RabbitMQ は、配布を処理するためにメッセージ パブリッシャーとサブスクライバーの間の媒介として機能します。 コードの中で、EventBusRabbitMQ クラスは汎用的な IEventBus インターフェイスを実装します。 この実装は、この開発/テスト バージョンから運用環境バージョンに切り替えられるように、依存関係挿入に基づいています。

public class EventBusRabbitMQ : IEventBus, IDisposable
{
    // Implementation using RabbitMQ API
    //...
}

サンプルの開発/テスト イベント バスの RabbitMQ 実装は定型的なコードです。 これは、RabbitMQ サーバーへの接続を処理し、メッセージ イベントをキューに発行するためのコードを提供します。 また、イベントの種類ごとに統合イベント ハンドラーのコレクションから成る辞書を実装する必要があります。このようなイベントの種類では、図 6-21 に示すように、受信側のマイクロサービスごとに、インスタンス化したものが異なり、さまざまなサブスクリプションが存在する場合があります。

RabbitMQ で単純な発行方法を実装する

次のコードは、全体のシナリオを紹介する RabbitMQ のイベント バス実装の "簡略化された" バージョンです。 実際にこの方法で接続を処理することはありません。 完全な実装を確認するには、dotnet-architecture/eShopOnContainers リポジトリで実際のコードを参照してください。

public class EventBusRabbitMQ : IEventBus, IDisposable
{
    // Member objects and other methods ...
    // ...

    public void Publish(IntegrationEvent @event)
    {
        var eventName = @event.GetType().Name;
        var factory = new ConnectionFactory() { HostName = _connectionString };
        using (var connection = factory.CreateConnection())
        using (var channel = connection.CreateModel())
        {
            channel.ExchangeDeclare(exchange: _brokerName,
                type: "direct");
            string message = JsonConvert.SerializeObject(@event);
            var body = Encoding.UTF8.GetBytes(message);
            channel.BasicPublish(exchange: _brokerName,
                routingKey: eventName,
                basicProperties: null,
                body: body);
       }
    }
}

eShopOnContainers アプリケーションの Publish メソッドの実際のコードは、Polly 再試行ポリシーを使用して機能強化されています。これにより、RabbitMQ コンテナーが準備完了状態にない場合にタスクが数回試行されます。 このシナリオは docker-compose でコンテナーを起動するときに発生する可能性があります。たとえば、RabbitMQ コンテナーの起動は他のコンテナーよりも遅くなる場合があります。

前述したように、RabbitMQ には可能な構成が多数存在するため、このコードは開発環境およびテスト環境でのみの使用に限定する必要があります。

RabbitMQ API でサブスクリプション コードを実装する

発行コードの場合と同様に、次のコードも RabbitMQ 用のイベント バス実装の一部を簡略化したものです。 繰り返しますが、機能強化を行うのでなければ、これを変更する必要はありません。

public class EventBusRabbitMQ : IEventBus, IDisposable
{
    // Member objects and other methods ...
    // ...

    public void Subscribe<T, TH>()
        where T : IntegrationEvent
        where TH : IIntegrationEventHandler<T>
    {
        var eventName = _subsManager.GetEventKey<T>();

        var containsKey = _subsManager.HasSubscriptionsForEvent(eventName);
        if (!containsKey)
        {
            if (!_persistentConnection.IsConnected)
            {
                _persistentConnection.TryConnect();
            }

            using (var channel = _persistentConnection.CreateModel())
            {
                channel.QueueBind(queue: _queueName,
                                    exchange: BROKER_NAME,
                                    routingKey: eventName);
            }
        }

        _subsManager.AddSubscription<T, TH>();
    }
}

各種のイベントには、RabbitMQ からイベントを取得ための関連チャネルがあります。 チャネルとイベントの種類ごとにイベント ハンドラーを必要な数だけ使用することができます。

Subscribe メソッドは IIntegrationEventHandler オブジェクト (現在のマイクロサービスでのコールバック メソッドに似ている) に加えて、それに関連する IntegrationEvent オブジェクトを受け入れます。 コードは次にそのイベント ハンドラーを、各種の統合イベントがクライアント マイクロサービスごとに保持できるイベント ハンドラーの一覧に追加します。 クライアント コードがまだサブスクライブしていないイベントがある場合、コードは該当するイベントの種類に対してチャネルを作成します。これにより、そのイベントが他のサービスから発行されたときに RabbitMQ からプッシュ スタイルでイベントを受け取ることができます。

前述のように、eShopOnContainers に実装されているイベント バスはメイン シナリオのみに対処するもので、実稼働の準備はできていないため、教育的な目的しかありません。

実稼働シナリオの場合は、以下の RabbitMQ に特化した追加のリソースと、「マイクロサービス間でイベント ベースの通信を実装する」のセクションを確認してください。

その他の技術情報

RabbitMQ に対応した実働可能なソリューション。

前へ次へ