MSMQ アクティベーション

[アーティクル]
02/24/2011

このサンプルでは、メッセージキューから読み取ったアプリケーションを、Windows プロセスアクティブ化サービス (WAS) でホストする方法を示します。このサンプルは netMsmqBinding を使用しており、「双方向通信」のサンプルに基づいています。この場合、サービスは Web ホストアプリケーションの 1 つであり、クライアントは自己ホスト型です。クライアントはコンソールに出力して、送信された発注書のステータスを確認します。

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

注 :
サンプルは、既にコンピューターにインストールされている場合があります。続行する前に、次の (既定の) ディレクトリを確認してください。 <InstallDrive>:\WF_WCF_Samples Windows Communication Foundation (WCF) および Windows Workflow Foundation このディレクトリが存在しない場合は、「.NET Framework Version 4 向けの Windows Communication Foundation (WCF) および Windows Workflow Foundation (WF) のサンプル」に移動して、すべての WCF サンプルおよび WF サンプルをダウンロードしてください。このサンプルは、次のディレクトリに格納されます。 <InstallDrive>:\Samples\WCFWFCardSpace\WCF\Basic\Services\Hosting\WASHost\MsmqActivation

サンプルは、既にコンピューターにインストールされている場合があります。続行する前に、次の (既定の) ディレクトリを確認してください。

<InstallDrive>:\WF_WCF_Samples

Windows Communication Foundation (WCF) および Windows Workflow Foundation このディレクトリが存在しない場合は、「.NET Framework Version 4 向けの Windows Communication Foundation (WCF) および Windows Workflow Foundation (WF) のサンプル」に移動して、すべての WCF サンプルおよび WF サンプルをダウンロードしてください。このサンプルは、次のディレクトリに格納されます。

<InstallDrive>:\Samples\WCFWFCardSpace\WCF\Basic\Services\Hosting\WASHost\MsmqActivation

Windows プロセスアクティブ化サービス (WAS) は Windows Server 2008 の新しいプロセスアクティブ化機構です。WAS は、以前は HTTP ベースのアプリケーションでのみ使用できた IIS のような機能を、HTTP 以外のプロトコルを使用するアプリケーションに提供します。Windows Communication Foundation (WCF) はリスナーアダプターインターフェイスを使用し、WCF によってサポートされる HTTP 以外のプロトコル (TCP、Named Pipes、MSMQ など) を介して受信されるアクティブ化要求を伝達します。HTTP 以外のプロトコルを介して要求を受信する機能は、SMSvcHost.exe で実行されるマネージ Windows サービスによってホストされます。

Net.Msmq リスナアダプタサービス (NetMsmqActivator) は、キュー内のメッセージに基づいてキューに置かれたアプリケーションをアクティブ化します。

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

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 クラス内の操作で使用できます。

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

public class OrderProcessorService : IOrderProcessor
{
    [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();
        msmqCallbackBinding.Security.Mode = NetMsmqSecurityMode.None;
        OrderStatusClient client = new OrderStatusClient(msmqCallbackBinding, new EndpointAddress(reportOrderStatusTo));
        // please note that the same transaction that is used to dequeue purchase order is used
        // to send back order status
        using (TransactionScope scope = new TransactionScope(TransactionScopeOption.Required))
        {
            client.OrderStatus(po.PONumber, po.Status);
            scope.Complete();
        }
    }

使用するクライアントバインディングの指定には、構成ファイルを使用します。

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

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

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

クラスの名前が付いた .svc ファイルは、WAS でのサービスコードのホストに使用されます。

Service.svc ファイル自体には、OrderProcessorService を作成するディレクティブが含まれます。

<%@ServiceHost language="c#" Debug="true" Service="Microsoft.ServiceModel.Samples.OrderProcessorService"%>

さらに、Service.svc ファイルには、System.Transactions.dll を読み込むためのアセンブリディレクティブも含まれます。

<%@Assembly name="System.Transactions, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"%>

クライアントはトランザクションスコープを作成します。サービスとの通信はトランザクションのスコープ内で実行され、すべてのメッセージが成功か失敗かを示すアトミックな単位として扱われます。トランザクションは、トランザクションスコープで Complete を呼び出すことでコミットされます。

using (ServiceHost serviceHost = new ServiceHost(typeof(OrderStatusService)))
{
    // Open the ServiceHostBase to create listeners and start listening 
    // for order status messages.
    serviceHost.Open();

    // Create a proxy with given client endpoint configuration
    OrderProcessorClient client = new OrderProcessorClient();

    // Create the purchase order
    PurchaseOrder po = new PurchaseOrder();
    po.CustomerId = "somecustomer.com";
    po.PONumber = Guid.NewGuid().ToString();

    PurchaseOrderLineItem lineItem1 = new PurchaseOrderLineItem();
    lineItem1.ProductId = "Blue Widget";
    lineItem1.Quantity = 54;
    lineItem1.UnitCost = 29.99F;

    PurchaseOrderLineItem lineItem2 = new PurchaseOrderLineItem();
    lineItem2.ProductId = "Red Widget";
    lineItem2.Quantity = 890;
    lineItem2.UnitCost = 45.89F;

    po.orderLineItems = new PurchaseOrderLineItem[2];
    po.orderLineItems[0] = lineItem1;
    po.orderLineItems[1] = lineItem2;

    //Create a transaction scope.
    using (TransactionScope scope = new 
        TransactionScope(TransactionScopeOption.Required))
    {
        // Make a queued call to submit the purchase order
        client.SubmitPurchaseOrder(po, 
       "net.msmq://localhost/private/ServiceModelSamplesOrder/OrderStatus");
        // Complete the transaction.
        scope.Complete();
    }

    //Closing the client gracefully closes the connection and cleans up 
    //resources
    client.Close();

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

    // Close the ServiceHostBase 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="targetQueueName" value=".\private$\ServiceModelSamples/service.svc" />
    <add key="responseQueueName" value=".\private$\ServiceModelSamples/OrderStatus" />
  </appSettings>

<system.serviceModel>

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

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

  </system.serviceModel>

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

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

クライアントを終了するには、<Enter> キーを押します。
注文 70cf9d63-3dfa-4e69-81c2-23aa4478ebed のステータス: 保留

サンプルを設定、ビルド、および実行するには

WAS のアクティブ化に必要な IIS 7.0 がインストールされていることを確認します。
「Windows Communication Foundation サンプルの 1 回限りのセットアップの手順」が実行済みであることを確認します。さらに、HTTP 以外の WCF アクティベーションコンポーネントをインストールする必要があります。
1. [スタート] メニューの [コントロールパネル] をクリックします。
2. [プログラムと機能] をクリックします。
3. [Windows 機能の有効化または無効化] をクリックします。
4. [機能の概要] で、[機能の追加] をクリックします。
5. [Microsoft .NET Framework 3.0] ノードを展開し、[Windows Communication Foundation Non-HTTP Activation] 機能をオンにします。
ソリューションの C# 版または Visual Basic .NET 版をビルドするには、「Windows Communication Foundation サンプルのビルド」の手順に従います。
コマンドウィンドウで client.exe を実行することにより、クライアントを実行します。これによってキューが作成され、メッセージがそのキューに送信されます。クライアントを実行しながら、メッセージを読み取るサービスの結果を表示します。
MSMQ アクティベーションサービスは、既定では NETWORK SERVICE として動作します。そのため、アプリケーションのアクティブ化に使用されるキューには、NETWORK SERVICE アカウントによる受信およびピーク権限が必要です。この権限は、メッセージキュー MMC を使用して追加できます。
1. [スタート] メニューから [ファイル名を指定して実行] をクリックし、「Compmgmt.msc」と入力して Enter キーを押します。
2. [サービスとアプリケーション] で [メッセージキュー] を展開します。
3. [プライベートキュー] をクリックします。
4. キュー (servicemodelsamples/Service.svc) を右クリックし、[プロパティ] をクリックします。
5. [セキュリティ] タブの [追加] をクリックし、NETWORK SERVICE にピークと受信のアクセス許可を付与します。
MSMQ アクティブ化をサポートするよう Windows プロセスアクティブ化サービス (WAS) を設定します。

便宜上次の 2 つの手順が、サンプルディレクトリにある AddMsmqSiteBinding.cmd というバッチファイルに実装されています。
1. net.msmq アクティベーションをサポートするには、既定の Web サイトをあらかじめ net.msmq プロトコルにバインドしておく必要があります。これは、IIS 7.0 管理ツールセットと共にインストールされる appcmd.exe を使用して行います。権限のレベルが高い (管理者の) コマンドプロンプトで、次のコマンドを実行します。
```
%windir%\system32\inetsrv\appcmd.exe set site "Default Web Site" 
-+bindings.[protocol='net.msmq',bindingInformation='localhost']
```
  注 :
  
  このコマンドはテキスト 1 行です。
  
  このコマンドによって、既定の Web サイトに net.msmq サイトバインディングを追加します。
2. サイト内のすべてのアプリケーションが同じ net.msmq バインディングを共有しますが、net.msmq サポートの有効化はアプリケーションごとに指定できます。/servicemodelsamples アプリケーションで net.msmq を有効にするには、権限のレベルが高いコマンドプロンプトから、次のコマンドを実行します。
```
%windir%\system32\inetsrv\appcmd.exe set app "Default Web Site/servicemodelsamples" /enabledProtocols:http,net.msmq
```
  注 :
  
  このコマンドはテキスト 1 行です。
  
  このコマンドにより、/servicemodelsamples アプリケーションに https://localhost/servicemodelsamples と net.msmq://localhost/servicemodelsamples のどちらを使用してもアクセスできるようになります。
まだ確認していない場合は、MSMQ アクティベーションサービスが有効になっていることを確認します。[スタート] メニューの [ファイル名を指定して実行] をクリックし、「Services.msc」と入力します。Net.Msmq リスナアダプタのサービスのリストを検索します。右クリックし、[プロパティ] をクリックします。[スタートアップの種類] を [自動] に設定し、[適用] をクリックして [開始] ボタンをクリックします。この手順は、Net.Msmq リスナーアダプターサービスを初めて使用する前に 1 回だけ実行する必要があります。
サンプルを単一コンピューター構成または複数コンピューター構成で実行するには、「Running the Windows Communication Foundation Samples」の手順に従います。さらに、発注書を送信するときのキューの URI 内のコンピューター名を反映するように、発注書を送信するクライアントのコードを変更します。次のコードを使用します。
```
client.SubmitPurchaseOrder(po, "net.msmq://localhost/private/ServiceModelSamples/OrderStatus");
```
このサンプル用に追加した net.msmq サイトバインディングを削除します。

便宜上次の 2 つの手順が、サンプルディレクトリにある RemoveMsmqSiteBinding.cmd というバッチファイルに実装されています。
1. 権限のレベルが高いコマンドプロンプトから次のコマンドを実行して、有効なプロトコルの一覧から net.msmq を削除します。
```
%windir%\system32\inetsrv\appcmd.exe set app "Default Web Site/servicemodelsamples" /enabledProtocols:http
```
  注 :
  
  このコマンドはテキスト 1 行です。
2. 権限のレベルが高いコマンドプロンプトから次のコマンドを実行して、net.msmq サイトバインディングを削除します。
```
%windir%\system32\inetsrv\appcmd.exe set site "Default Web Site" --bindings.[protocol='net.msmq',bindingInformation='localhost']
```
  注 :
  
  このコマンドはテキスト 1 行です。
注意 :

バッチファイルを実行すると、DefaultAppPool がリセットされて .NET Framework Version 2.0 で実行されます。

注 :
このコマンドはテキスト 1 行です。

注 :
このコマンドはテキスト 1 行です。

注 :
このコマンドはテキスト 1 行です。

注 :
このコマンドはテキスト 1 行です。

注意 :
バッチファイルを実行すると、DefaultAppPool がリセットされて .NET Framework Version 2.0 で実行されます。

既定の設定では、netMsmqBinding バインディングトランスポートを使用するときはセキュリティが有効になります。トランスポートセキュリティの種類は、MsmqAuthenticationMode と MsmqProtectionLevel の 2 つのプロパティで決まります。既定の設定では、認証モードは Windows、保護レベルは Sign です。MSMQ の認証および署名の機能を利用するには、ドメインに属している必要があります。このサンプルをドメインに属していないコンピューターで実行すると、"ユーザーの内部メッセージキュー認証情報は存在しません" というエラーが表示されます。

ワークグループに参加しているコンピューターでこのサンプルを実行するには

ドメインに属していないコンピューターを使用する場合は、トランスポートセキュリティをオフにします。オフにするには、認証モードと保護レベルを "none" に設定します。サンプル構成を次に示します。
```
<bindings>
    <netMsmqBinding>
        <binding configurationName="TransactedBinding">
            <security mode="None"/>
        </binding>
    </netMsmqBinding>
</bindings>
```

サンプルを実行する前に、サーバーとクライアントの両方の構成を変更します。

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

ワークグループに参加しているコンピューターでアクティブ化を有効にするには、アクティベーションサービスとワーカープロセスの両方を特定のユーザーアカウントで実行する必要があります (どちらも同じアカウントを使用する必要があります)。さらに、キューはその特定のユーザーアカウントの ACL に設定されている必要があります。

ワーカープロセスが実行される ID を変更するには
1. Inetmgr.exe を実行します。
2. [アプリケーションプール] で、[AppPool] (通常は [DefaultAppPool]) を右クリックし、[アプリケーションプールの既定値の設定...] をクリックします。
3. 特定のユーザーアカウントを使用するように、[ID] プロパティを変更します。
アクティブ化サービスが実行される ID を変更するには
1. Services.msc を実行します。
2. [Net.Msmq リスナアダプタ] を右クリックし、[プロパティ] をクリックします。
[ログオン] タブでアカウントを変更します。
ワークグループでは、無制限のトークンを使用してサービスを実行する必要もあります。この操作を行うには、コマンドウィンドウから次のコマンドを実行します。
```
sc sidtype netmsmqactivator unrestricted
```

参照

その他のリソース

AppFabric のホストおよび永続化のサンプル

次の方法で共有

MSMQ アクティベーション

サンプルを設定、ビルド、および実行するには

ワークグループに参加しているコンピューターでこのサンプルを実行するには

参照

その他のリソース

その他のリソース