双方向通信

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

双方向のサンプルでは、MSMQ を介して、トランザクション化された双方向のキュー通信を実行する方法を示します。このサンプルでは、netMsmqBinding バインディングを使用します。このサンプルのサービスは自己ホスト型コンソールアプリケーションであるので、サンプルを実行すると、キューに置かれたメッセージをサービスが受信するようすを観察できます。

Note

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

このサンプルは、「トランザクション MSMQ バインディング」に基づいています。

キュー通信では、クライアントはサービスとの通信にキューを使用します。クライアントはメッセージをキューに送信し、サービスはメッセージをキューから受信します。したがって、キューを使用する通信では、サービスとクライアントが同時に実行されていなくてもかまいません。

このサンプルでは、キューを使用する双方向通信の例を示します。クライアントは、トランザクションのスコープ内から発注書をキューに送信します。サービスは、注文を受信して処理し、注文ステータスをキューからクライアントに返信します。これらの処理を、トランザクションのスコープ内で実行します。双方向通信を使用するには、クライアントとサービスの両方がキューを使用して、発注書や注文ステータスをキューに追加する必要があります。

サービスコントラクト IOrderProcessor は、キューの使用に合わせた一方向サービス操作を定義します。サービス操作には、注文ステータスの送信に使用される応答エンドポイントが含まれます。応答エンドポイントは、注文ステータスをクライアントに返信するためのキューの URI です。注文処理アプリケーションは、このコントラクトを実装します。

[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public interface IOrderProcessor
{
    [OperationContract(IsOneWay = true)]
    void SubmitPurchaseOrder(PurchaseOrder po, string
                                  reportOrderStatusTo);
}

注文ステータスを送信する応答コントラクトは、クライアントが指定します。クライアントは注文ステータスコントラクトを実装します。サービスは、このコントラクトについて生成されたプロキシを使用して、注文ステータスをクライアントに返信します。

[ServiceContract]
public interface IOrderStatus
{
    [OperationContract(IsOneWay = true)]
    void OrderStatus(string poNumber, string status);
}

サービス操作は、送信された発注書を処理します。サービス操作に適用される OperationBehaviorAttribute では、キューからのメッセージ受信に使用されるトランザクションに自動的に帰属することと、サービス操作の完了時にトランザクションを自動的に完了させることが指定されています。 Orders クラスは、注文処理機能をカプセル化します。この例では、発注書をディクショナリに追加します。このサービス操作が帰属するしているトランザクションは、Orders クラス内の操作で使用できます。

サービス操作は、送信された発注書を処理するだけでなく、注文ステータスをクライアントに戻します。

[OperationBehavior(TransactionScopeRequired = true, TransactionAutoComplete = true)]
public void SubmitPurchaseOrder(PurchaseOrder po, string reportOrderStatusTo)
{
    Orders.Add(po);
    Console.WriteLine("Processing {0} ", po);
    Console.WriteLine("Sending back order status information");
    NetMsmqBinding msmqCallbackBinding = new NetMsmqBinding("ClientCallbackBinding");
    OrderStatusClient client = new OrderStatusClient(msmqCallbackBinding, new EndpointAddress(reportOrderStatusTo));

    // Please note that the same transaction that is used to dequeue the purchase order is used
    // to send back order status.
    using (TransactionScope scope = new TransactionScope(TransactionScopeOption.Required))
    {
        client.OrderStatus(po.PONumber, po.Status);
        scope.Complete();
    }
    //Close the client.
    client.Close();
}

MSMQ キュー名は、構成ファイルの appSettings セクションで指定されます。サービスのエンドポイントは、構成ファイルの System.ServiceModel セクションで定義されます。

Note

MSMQ のキュー名とエンドポイントアドレスでは、若干異なるアドレス表記が使用されています。 MSMQ のキュー名では、ドット (.) を使用してローカルコンピューターを表し、バックスラッシュを使用してパスを区切ります。 Windows Communication Foundation (WCF) エンドポイントアドレスでは、net.msmq: スキームを指定し、ローカルコンピューターを表すのに "localhost" を使用し、そのパスにはスラッシュを使用します。リモートコンピューターでホストされているキューからの読み出しを行うには、"." や "localhost" をリモートコンピューター名に置き換えます。

サービスは自己ホスト型です。 MSMQ トランスポートを使用する場合、使用するキューをあらかじめ作成しておく必要があります。手動で作成することもコードで作成することもできます。このサンプルでは、サービスがキューの存在を確認し、必要な場合はキューを作成します。キュー名は構成ファイルから読み込まれます。このベースアドレスは、ServiceModel メタデータユーティリティツール (Svcutil.exe) によってサービスへのプロキシを生成するために使用されます。

// Host the service within this EXE console application.
public static void Main()
{
    // Get MSMQ queue name from appSettings in configuration.
    string queueName = ConfigurationManager.AppSettings["queueName"];

    // Create the transacted MSMQ queue if necessary.
    if (!MessageQueue.Exists(queueName))
        MessageQueue.Create(queueName, true);

    // Create a ServiceHost for the OrderProcessorService type.
    using (ServiceHost serviceHost = new ServiceHost(typeof(OrderProcessorService)))
    {
        // Open the ServiceHost to create listeners and start listening for messages.
        serviceHost.Open();

        // The service can now be accessed.
        Console.WriteLine("The service is ready.");
        Console.WriteLine("Press <ENTER> to terminate service.");
        Console.WriteLine();
        Console.ReadLine();
    }
}

クライアントはトランザクションを作成します。キューとの通信はトランザクションのスコープ内で実行されるので、全体が 1 つのアトミックな単位として扱われ、すべてのメッセージが成功するか、すべてのメッセージが失敗するかのいずれかになります。

// Create a ServiceHost for the OrderStatus service type.
using (ServiceHost serviceHost = new ServiceHost(typeof(OrderStatusService)))
{

    // Open the ServiceHostBase to create listeners and start listening for order status messages.
    serviceHost.Open();

    // Create the purchase order.
    ...

    // Create a client with given client endpoint configuration.
    OrderProcessorClient client = new OrderProcessorClient("OrderProcessorEndpoint");

    //Create a transaction scope.
    using (TransactionScope scope = new TransactionScope(TransactionScopeOption.Required))
    {
        string hostName = Dns.GetHostName();

        // Make a queued call to submit the purchase order.
        client.SubmitPurchaseOrder(po, "net.msmq://" + hostName + "/private/ServiceModelSamplesTwo-way/OrderStatus");

        // Complete the transaction.
        scope.Complete();
    }

    //Close down the client.
    client.Close();

    Console.WriteLine();
    Console.WriteLine("Press <ENTER> to terminate client.");
    Console.ReadLine();

    // Close the ServiceHost to shutdown the service.
    serviceHost.Close();
}

クライアントコードは IOrderStatus コントラクトを実装して、サービスからの注文ステータスを受信します。この場合は、注文ステータスを出力します。

[ServiceBehavior]
public class OrderStatusService : IOrderStatus
{
    [OperationBehavior(TransactionAutoComplete = true,
                        TransactionScopeRequired = true)]
    public void OrderStatus(string poNumber, string status)
    {
        Console.WriteLine("Status of order {0}:{1} ", poNumber ,
                                                           status);
    }
}

注文ステータスキューは Main メソッド内で作成します。クライアント構成には、注文ステータスサービスをホストするための注文ステータスサービス構成が含まれています。次のサンプル構成を参照してください。

<appSettings>
  <!-- Use appSetting to configure MSMQ queue name. -->
  <add key="queueName" value=".\private$\ServiceModelSamplesTwo-way/OrderStatus" />
</appSettings>

<system.serviceModel>

  <services>
    <service
       name="Microsoft.ServiceModel.Samples.OrderStatusService">
      <!-- Define NetMsmqEndpoint -->
      <endpoint address="net.msmq://localhost/private/ServiceModelSamplesTwo-way/OrderStatus"
                binding="netMsmqBinding"
                contract="Microsoft.ServiceModel.Samples.IOrderStatus" />
    </service>
  </services>

  <client>
    <!-- Define NetMsmqEndpoint -->
    <endpoint name="OrderProcessorEndpoint"
              address="net.msmq://localhost/private/ServiceModelSamplesTwo-way/OrderProcessor"
              binding="netMsmqBinding"
              contract="Microsoft.ServiceModel.Samples.IOrderProcessor" />
  </client>

</system.serviceModel>

サンプルを実行すると、クライアントとサービスのアクティビティがサービスとクライアントの両方のコンソールウィンドウに表示されます。サービスがクライアントから受信したメッセージを表示できます。どちらかのコンソールで Enter キーを押すと、サービスとクライアントがどちらもシャットダウンされます。

サービスによって発注書の情報が表示され、注文ステータスがサービスから注文ステータスキューに返信されることも表示されます。

The service is ready.
Press <ENTER> to terminate service.

Processing Purchase Order: 124a1f69-3699-4b16-9bcc-43147a8756fc
        Customer: somecustomer.com
        OrderDetails
                Order LineItem: 54 of Blue Widget @unit price: $29.99
                Order LineItem: 890 of Red Widget @unit price: $45.89
        Total cost of this order: $42461.56
        Order status: Pending

Sending back order status information

クライアントには、サービスから送信された注文ステータス情報が表示されます。

Press <ENTER> to terminate client.
Status of order 124a1f69-3699-4b16-9bcc-43147a8756fc:Pending

サンプルをセットアップ、ビルド、および実行するには

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

Note

Svcutil.exe を使用してこのサンプルの構成を再生成した場合は、クライアントコードに一致するように、クライアント構成内のエンドポイント名を変更してください。

NetMsmqBinding を使用する場合の既定では、トランスポートセキュリティが有効です。 MSMQ トランスポートセキュリティには、MsmqAuthenticationMode と MsmqProtectionLevel. の 2 つの関連プロパティがあります。既定では、認証モードは Windows に設定され、保護レベルは Sign に設定されます。 MSMQ の認証機能と署名機能を利用するには、ドメインに MSMQ があることと、MSMQ に関する Active Directory の統合オプションがインストールされていることが必要です。この条件を満たしていないコンピューターでこのサンプルを実行すると、エラーになります。

ワークグループに属しているコンピューターまたは Active Directory 統合のないコンピューターでこのサンプルを実行するには

ドメインに属していないコンピュータ、または Active Directory 統合がインストールされていないコンピュータを使用する場合は、トランスポートセキュリティをオフにします。オフにするには、認証モードと保護レベルを None にします。この構成の例を次に示します。

<configuration>

  <appSettings>
    <!-- Use appSetting to configure MSMQ queue name. -->
    <add key="queueName" value=".\private$\ServiceModelSamplesTwo-way/OrderProcessor" />
  </appSettings>

  <system.serviceModel>
    <services>
      <service
          name="Microsoft.ServiceModel.Samples.OrderProcessorService">
        <!-- Define NetMsmqEndpoint -->
        <endpoint address="net.msmq://localhost/private/ServiceModelSamplesTwo-way/OrderProcessor"
                  binding="netMsmqBinding"
                  bindingConfiguration="TransactedBinding"
                  contract="Microsoft.ServiceModel.Samples.IOrderProcessor" />
      </service>
    </services>

    <bindings>
      <netMsmqBinding>
        <binding name="TransactedBinding" >
         <security mode="None" />
        </binding>
      </netMsmqBinding>
    </bindings>

  </system.serviceModel>

</configuration>

クライアント構成のセキュリティをオフにすると、次のコードが生成されます。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <!-- Use appSetting to configure MSMQ queue name. -->
    <add key="queueName" value=".\private$\ServiceModelSamplesTwo-way/OrderStatus" />
  </appSettings>

  <system.serviceModel>

    <services>
      <service
         name="Microsoft.ServiceModel.Samples.OrderStatusService">
        <!-- Define NetMsmqEndpoint -->
        <endpoint address="net.msmq://localhost/private/ServiceModelSamplesTwo-way/OrderStatus"
                  binding="netMsmqBinding"
                  bindingConfiguration="TransactedBinding" contract="Microsoft.ServiceModel.Samples.IOrderStatus" />
      </service>
    </services>

    <client>
      <!-- Define NetMsmqEndpoint -->
      <endpoint name="OrderProcessorEndpoint"
                address="net.msmq://localhost/private/ServiceModelSamplesTwo-way/OrderProcessor"
                binding="netMsmqBinding"
                bindingConfiguration="TransactedBinding"
                contract="Microsoft.ServiceModel.Samples.IOrderProcessor" />
    </client>

    <bindings>
      <netMsmqBinding>
        <binding name="TransactedBinding" >
         <security mode="None" />
        </binding>
      </netMsmqBinding>
    </bindings>

  </system.serviceModel>

</configuration>

このサンプルのサービスは、OrderProcessorService でバインディングを作成します。このバインディングをインスタンス化した後に、コード行を 1 行追加して、セキュリティモードを None に設定します。
```
NetMsmqBinding msmqCallbackBinding = new NetMsmqBinding();
msmqCallbackBinding.Security.Mode = NetMsmqSecurityMode.None;
```
サーバーとクライアントの両方の構成を変更したことを確認してから、サンプルを実行します。

Note

security mode を None に設定することは、MsmqAuthenticationMode、MsmqProtectionLevel、または Message のセキュリティを None に設定することに相当します。

双方向通信

サンプルをセットアップ、ビルド、および実行するには

ワークグループに属しているコンピューターまたは Active Directory 統合のないコンピューターでこのサンプルを実行するには

その他のリソース