デザインパターン:リストに基づく公開/定期受信

[アーティクル]
05/10/2023

ListBasedPublishSubscribe サンプルでは、Windows Communication Foundation (WCF) プログラムとして実装されているリストベースのパブリッシュ/サブスクライブパターンを示します。

Note

このサンプルのセットアップ手順とビルド手順については、このトピックの最後を参照してください。

リストベースのパブリッシュ/サブスクライブデザインパターンについては、Microsoft Patterns & Practices の出版物である『統合パターン』で説明されています。公開/定期受信パターンは、情報トピックを定期受信する受信者のコレクションに情報を渡します。リストに基づく公開/定期受信では、サブスクライバのリストが保持されます。共有情報が存在する場合は、コピーがリスト上の各サブスクライバに送信されます。このサンプルでは、動的なリストに基づく公開/定期受信パターンを示します。これにより、クライアントは必要に応じて何度でも定期受信または定期受信の解除ができます。

リストに基づく公開/定期受信のサンプルは、クライアント、サービス、およびデータソースプログラムで構成されています。クライアントとデータソースプログラムは、複数を実行できます。クライアントはサービスを定期受信し、通知を受信して、定期受信を解除します。データソースプログラムはサービスに情報を送信し、現在のすべてのサブスクライバでその情報が共有されるようにします。

このサンプルでは、クライアントとデータソースはコンソールプログラム (.exe ファイル) で、サービスはインターネットインフォメーションサービス (IIS) でホストされるライブラリ (.dll) です。クライアントとデータソースのアクティビティは、デスクトップに表示されます。

サービスは、双方向通信を使用します。 ISampleContract サービスコントラクトは ISampleClientCallback コールバックコントラクトと対になっています。サービスは Subscribe および Unsubscribe サービス操作を実装します。クライアントはこれらのサービス操作を使用してサブスクライバのリストに参加またはリストへの参加を解除します。サービスは、さらに PublishPriceChange サービス操作も実装します。データソースプログラムはこれを呼び出して、新しい情報をサービスに提供します。クライアントプログラムは PriceChange サービス操作を実装します。サービスはこれを呼び出して、すべてのサブスクライバに価格の変更を通知します。

// Create a service contract and define the service operations.
// NOTE: The service operations must be declared explicitly.
[ServiceContract(SessionMode=SessionMode.Required,
      CallbackContract=typeof(ISampleClientContract))]
public interface ISampleContract
{
    [OperationContract(IsOneWay = false, IsInitiating=true)]
    void Subscribe();
    [OperationContract(IsOneWay = false, IsTerminating=true)]
    void Unsubscribe();
    [OperationContract(IsOneWay = true)]
    void PublishPriceChange(string item, double price,
                                     double change);
}

public interface ISampleClientContract
{
    [OperationContract(IsOneWay = true)]
    void PriceChange(string item, double price, double change);
}

サービスは、すべてのサブスクライバに新しい情報を通知する機構として、.NET Framework イベントを使用します。クライアントが Subscribe を呼び出してサービスに参加すると、イベントハンドラが提供されます。クライアントがサービスへの参加を解除すると、イベントからイベントハンドラの定期受信が解除されます。データソースが価格の変更を報告するサービスを呼び出すと、サービスはイベントを発生させます。これにより、サービスの各インスタンスが呼び出されます。このサービスは定期受信した各クライアントのサービスで、この呼び出しによって各インスタンスのイベントハンドラが実行されます。各イベントハンドラは、コールバック関数を使用してクライアントに情報を渡します。

public class PriceChangeEventArgs : EventArgs
    {
        public string Item;
        public double Price;
        public double Change;
    }

    // The Service implementation implements your service contract.
    [ServiceBehavior(InstanceContextMode=InstanceContextMode.PerSession)]
    public class SampleService : ISampleContract
    {
        public static event PriceChangeEventHandler PriceChangeEvent;
        public delegate void PriceChangeEventHandler(object sender, PriceChangeEventArgs e);

        ISampleClientContract callback = null;

        PriceChangeEventHandler priceChangeHandler = null;

        //Clients call this service operation to subscribe.
        //A price change event handler is registered for this client instance.

        public void Subscribe()
        {
            callback = OperationContext.Current.GetCallbackChannel<ISampleClientContract>();
            priceChangeHandler = new PriceChangeEventHandler(PriceChangeHandler);
            PriceChangeEvent += priceChangeHandler;
        }

        //Clients call this service operation to unsubscribe.
        //The previous price change event handler is unregistered.

        public void Unsubscribe()
        {
            PriceChangeEvent -= priceChangeHandler;
        }

        //Information source clients call this service operation to report a price change.
        //A price change event is raised. The price change event handlers for each subscriber will execute.

        public void PublishPriceChange(string item, double price, double change)
        {
            PriceChangeEventArgs e = new PriceChangeEventArgs();
            e.Item = item;
            e.Price = price;
            e.Change = change;
            PriceChangeEvent(this, e);
        }

        //This event handler runs when a PriceChange event is raised.
        //The client's PriceChange service operation is invoked to provide notification about the price change.

        public void PriceChangeHandler(object sender, PriceChangeEventArgs e)
        {
            callback.PriceChange(e.Item, e.Price, e.Change);
        }

    }

このサンプルを実行すると、複数のクライアントが起動されます。クライアントはサービスを定期受信します。次にデータソースプログラムが実行され、サービスに情報が送信されます。サービスは、すべてのサブスクライバに情報を渡します。各クライアントコンソールでアクティビティを表示し、情報が受信されたことを確認できます。クライアントをシャットダウンするには、クライアントウィンドウで Enter キーを押します。

サンプルをセットアップしてビルドするには

Windows Communication Foundation サンプルの 1 回限りのセットアップの手順を実行したことを確認します。
ソリューションの C# 版または Visual Basic .NET 版をビルドするには、「 Building the Windows Communication Foundation Samples」の手順に従います。

サンプルを同じコンピューターで実行するには

次のアドレスを入力して、ブラウザーを使用してサービスにアクセスできることをテストします: http://localhost/servicemodelsamples/service.svc。これに応答して、確認ページが表示されます。
言語固有のフォルダーの下の \client\bin\ にある Client.exe を実行します。クライアントアクティビティがクライアントコンソールウィンドウに表示されます。複数のクライアントを起動します。
言語固有のフォルダの下の \datasource\bin\ にある Datasource.exe を実行します。データソースアクティビティがコンソールウィンドウに表示されます。データソースがサービスに情報を送信すると、その情報は各クライアントに渡されます。
クライアント、データソース、サービスプログラムの間で通信できない場合は、WCF サンプルのトラブルシューティングのヒントに関するページをご覧ください。

サンプルを複数コンピューターで実行するには

サービスコンピュータを設定します。
1. サービスコンピューターで、ServiceModelSamples という仮想ディレクトリを作成します。「Windows Communication Foundation サンプルの 1 回限りのセットアップの手順」に含まれているバッチファイル Setupvroot.bat を使用して、ディスクディレクトリと仮想ディレクトリを作成できます。
2. サービスプログラムファイルを %SystemDrive%\Inetpub\wwwroot\servicemodelsamples からサービスコンピューターの ServiceModelSamples 仮想ディレクトリにコピーします。 \bin ディレクトリのファイルが含まれていることを確認してください。
3. ブラウザーを使用して、サービスにクライアントコンピューターからアクセスできるかどうかをテストします。
クライアントコンピュータを設定します。
1. クライアントプログラムファイルを、言語固有のフォルダにある \client\bin\ フォルダーからクライアントコンピュータにコピーします。
2. 各クライアントの構成ファイルで、エンドポイント定義のアドレス値をサービスの新しいアドレスに合わせて変更します。アドレスの "localhost" への参照をすべて完全修飾ドメイン名に置き換えます。
データソースコンピュータを設定します。
1. データソースプログラムファイルを、言語固有のフォルダーにある \datasource\bin\ フォルダーからデータソースコンピュータにコピーします。
2. データソースの構成ファイルで、エンドポイント定義のアドレス値をサービスの新しいアドレスに合わせて変更します。アドレスの "localhost" への参照をすべて完全修飾ドメイン名に置き換えます。
クライアントコンピュータで、コマンドプロンプトから Client.exe を起動します。
データソースコンピューターで、コマンドプロンプトから Datasource.exe を起動します。

次の方法で共有

サンプルをセットアップしてビルドするには

サンプルを同じコンピューターで実行するには

サンプルを複数コンピューターで実行するには

その他のリソース

次の方法で共有

デザイン パターン:リストに基づく公開/定期受信

サンプルをセットアップしてビルドするには

サンプルを同じコンピューターで実行するには

サンプルを複数コンピューターで実行するには

その他のリソース