MSMQ 4.0 での有害メッセージ処理

[アーティクル]
09/17/2008

このサンプルでは、サービスで有害メッセージの処理を実行する方法を示します。このサンプルは、「トランザクション MSMQ バインディング」のサンプルに基づいています。このサンプルでは、netMsmqBinding を使用しています。サービスは、自己ホスト型コンソールアプリケーションで、サービスがキュー内のメッセージを受信したかどうかを監視できます。

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

有害メッセージとは、メッセージを読み取るサービスがメッセージを処理できないためメッセージの読み取りが行われるトランザクションを終了する場合に、キューから繰り返し読み取られるメッセージのことです。そのような場合、メッセージは再試行されます。メッセージに問題がある場合、この再試行は理論上、永久に継続します。これは、キューから読み取って、サービス操作を起動するトランザクションを使用する場合にのみ発生することがある点に注意してください。

MSMQ のバージョンによって、NetMsmqBinding がサポートする有害メッセージの検出が制限されている場合と、制限されていない場合があります。メッセージが有害として検出されたら、いくつかの方法で処理できます。また、MSMQ のバージョンによって、NetMsmqBinding がサポートする有害メッセージの処理が制限されている場合と、制限されていない場合があります。

このサンプルでは、Windows Server 2003 プラットフォームと Windows XP プラットフォームに用意されている制限された有害メッセージ機能と、Windows Vista に用意されている制限されていない有害メッセージ機能を示します。どちらのサンプルでも、目的はキューの外にある有害メッセージを、有害メッセージサービスによりサービスを提供可能な別のキューに移動することです。

MSMQ v4.0 の有害メッセージ処理サンプル

Windows Vista では、有害メッセージの格納に使用可能な有害メッセージサブキュー機能が MSMQ に用意されています。このサンプルは、Windows Vista を使用して有害メッセージを処理するベストプラクティスを示しています。

Windows Vista の有害メッセージの検出は、かなり高度な機能です。検出に役立つ 3 つのプロパティがあります。ReceiveRetryCount は、指定したメッセージをキューから再度読み取り、処理するためにアプリケーションにディスパッチする回数です。メッセージをアプリケーションにディスパッチできないか、またはアプリケーションがサービス操作内のトランザクションをロールバックした場合、メッセージはキューに戻ったときにキューから再度読み取られます。MaxRetryCycles は、メッセージが再試行キューに移動する回数です。ReceiveRetryCount に達すると、メッセージは再試行キューに移動されます。メッセージが再試行キューからメインキューに移動されると、RetryCycleDelay プロパティは時間遅延となります。ReceiveRetryCount は 0 にリセットされます。メッセージは再試行されます。メッセージを読み取るすべての試行に失敗すると、メッセージが有害としてマークされます。

メッセージが有害としてマークされると、メッセージは ReceiveErrorHandling 列挙体の設定に従って処理されます。次にもう一度、使用可能な値を示します。

Fault (既定値): リスナとサービスホストをエラーにします。
Drop: メッセージを破棄します。
Move: メッセージを有害メッセージサブキューに移動します。この値は、Windows Vista でのみ使用できます。
Reject: メッセージを送信者の配信不能キューに戻すことにより、メッセージを拒否します。この値は、Windows Vista でのみ使用できます。

このサンプルは有害なメッセージに対する Move 処置の使用法を示します。Move を指定すると、メッセージが有害メッセージサブキューに移動されます。

サービスコントラクトは IOrderProcessor です。これは、キューでの使用に適した一方向サービスを定義します。

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

サービス操作により、注文を処理していることを示すメッセージが表示されます。有害メッセージ機能を示すため、SubmitPurchaseOrder サービス操作は例外をスローして、サービスのランダム起動に基づきトランザクションをロールバックします。これにより、メッセージがキューに戻ります。最終的に、メッセージは有害とマークされます。構成は、有害メッセージサブキューへのメッセージの移動に設定されています。

    // Service class that implements the service contract.
    // Added code to write output to the console window.
    public class OrderProcessorService : IOrderProcessor
    {
        static Random r = new Random(137);

        [OperationBehavior(TransactionScopeRequired = true, TransactionAutoComplete = true)]
        public void SubmitPurchaseOrder(PurchaseOrder po)
        {

            int randomNumber = r.Next(10);

            if (randomNumber % 2 == 0)
            {
                Orders.Add(po);
                Console.WriteLine("Processing {0} ", po);
            }
            else
            {
                Console.WriteLine("Aborting transaction, cannot process purchase order: " + po.PONumber);
                Console.WriteLine();
                throw new Exception("Cannot process purchase order: " + po.PONumber);
            }
        }


        public static void OnServiceFaulted(object sender, EventArgs e) 
        {
            Console.WriteLine("Service Faulted");
        }
        

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

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

            // Get the base address that is used to listen for WS-MetaDataExchange requests.
            // This is useful to generate a proxy for the client.
            string baseAddress = ConfigurationManager.AppSettings["baseAddress"];

            // Create a ServiceHost for the OrderProcessorService type.
            ServiceHost serviceHost = new ServiceHost(typeof(OrderProcessorService), new Uri(baseAddress));

            // Hook on to the service host faulted events.
            serviceHost.Faulted += new EventHandler(OnServiceFaulted);

            // Open the ServiceHostBase 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();

            if(serviceHost.State != CommunicationState.Faulted) {
                serviceHost.Close();
            }

        }
    }

サービス構成には、receiveRetryCount、maxRetryCycles、retryCycleDelay、および receiveErrorHandling という有害メッセージプロパティが含まれています。次の構成ファイルを参照してください。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <!-- Use appSetting to configure MSMQ queue name. -->
    <add key="queueName" value=".\private$\ServiceModelSamplesPoison" />
    <add key="baseAddress" value="https://localhost:8000/orderProcessor/poisonSample"/>
  </appSettings>
  <system.serviceModel>
    <services>
      <service 
              name="Microsoft.ServiceModel.Samples.OrderProcessorService">
        <!-- Define NetMsmqEndpoint -->
        <endpoint address="net.msmq://localhost/private/ServiceModelSamplesPoison"
                  binding="netMsmqBinding"
                  bindingConfiguration="PoisonBinding" 
                  contract="Microsoft.ServiceModel.Samples.IOrderProcessor" />
      </service>
    </services>

    <bindings>
      <netMsmqBinding>
        <binding name="PoisonBinding" 
                 receiveRetryCount="0"
                 maxRetryCycles="1"
                 retryCycleDelay="00:00:05"                      
                 receiveErrorHandling="Move">
        </binding>
      </netMsmqBinding>
    </bindings>
  </system.serviceModel>
</configuration>

有害メッセージキューのメッセージの処理

有害メッセージサービスは、最終的な有害メッセージキューからメッセージを読み取って、それを処理します。

有害メッセージキューのメッセージは、メッセージを処理するサービスに対応付けられたメッセージで、有害メッセージサービスのエンドポイントとは異なる場合があります。そのため、有害メッセージサービスがキューからメッセージを読み取ると、WCF のチャネルレイヤはエンドポイントで不一致を検出し、メッセージをディスパッチしません。この場合、メッセージは注文処理サービス宛てになりますが、有害メッセージサービスが受信します。別のエンドポイント宛のメッセージも含めてメッセージの受信を続けるには、ServiceBehavior を追加して、メッセージの任意の宛先サービスエンドポイントを一致条件としてアドレスをフィルタする必要があります。これは、有害メッセージキューから読み込んだメッセージを正常に処理するために必要です。

有害メッセージサービス実装そのものは、サービス実装と非常によく似ています。コントラクトを実装し、注文を処理します。コード例を次に示します。

    // Service class that implements the service contract.
    // Added code to write output to the console window.
    [ServiceBehavior(AddressFilterMode=AddressFilterMode.Any)]
    public class OrderProcessorService : IOrderProcessor
    {
        [OperationBehavior(TransactionScopeRequired = true, TransactionAutoComplete = true)]
        public void SubmitPurchaseOrder(PurchaseOrder po)
        {
            Orders.Add(po);
            Console.WriteLine("Processing {0} ", po);
        }

        public static void OnServiceFaulted(object sender, EventArgs e) 
        {
            Console.WriteLine("Service Faulted...exiting app");
            Environment.Exit(1);
        }


        // Host the service within this EXE console application.
        public static void Main()
        {
   
            // Create a ServiceHost for the OrderProcessorService type.
            ServiceHost serviceHost = new ServiceHost(typeof(OrderProcessorService));

            // Hook on to the service host faulted events.
            serviceHost.Faulted += new EventHandler(OnServiceFaulted);
            
            serviceHost.Open();

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

            // Close the ServiceHostBase to shutdown the service.
            if(serviceHost.State != CommunicationState.Faulted)
            {
                serviceHost.Close();
            }
        }

注文処理サービスはメッセージを注文キューから読み込みますが、有害メッセージサービスはメッセージを有害サブキューから読み込みます。有害キューはメインキューのサブキューであり、名前は "poison" で、MSMQ により自動生成されます。アクセスするには、メインキュー名の後ろに ";" を追加し、その後ろにサブキュー名 (この場合は "poison") を指定します。次のサンプル構成を参照してください。

メモ :
MSMQ v3.0 用のサンプルでは、有害キュー名はサブキューではなく、メッセージの移動先キューになります。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <system.serviceModel>
    <services>
      <service name="Microsoft.ServiceModel.Samples.OrderProcessorService">
        <!-- Define NetMsmqEndpoint -->
        <endpoint address="net.msmq://localhost/private/ServiceModelSamplesPoison;poison"
                  binding="netMsmqBinding"
                  contract="Microsoft.ServiceModel.Samples.IOrderProcessor" >
        </endpoint>
      </service>
    </services>

  </system.serviceModel>
</configuration>

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

サービスが実行を開始し、注文を処理し、処理の終了をランダムに開始します。メッセージに注文処理の完了が示されていた場合、クライアントをもう一度実行して、サービスが実際にメッセージを終了したことを確認するまで別のメッセージを送信できます。構成されている有害設定に基づき、メッセージは 1 度処理を試行されてから、最後の有害キューに移されます。

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

Processing Purchase Order: 0f063b71-93e0-42a1-aa3b-bca6c7a89546
        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

Processing Purchase Order: 5ef9a4fa-5a30-4175-b455-2fb1396095fa
        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

Aborting transaction, cannot process purchase order: 23e0b991-fbf9-4438-a0e2-20adf93a4f89

有害メッセージサービスを起動して、有害メッセージを有害キューから読み込みます。この例では、有害メッセージサービスはメッセージを読み込んで処理します。終了され有害指定された発注書が有害メッセージサービスによって読み込まれるのを確認できます。

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

Processing Purchase Order: 23e0b991-fbf9-4438-a0e2-20adf93a4f89
        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

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

「Windows Communication Foundation サンプルの 1 回限りのセットアップの手順」が実行済みであることを確認します。
ソリューションの C# 版または Visual Basic .NET 版をビルドするには、「Windows Communication Foundation サンプルのビルド」の手順に従います。
サンプルを単一コンピュータ構成または複数コンピュータ構成で実行するには、キュー名を localhost から実際のホスト名に変更し、「Windows Communication Foundation サンプルの実行」の手順に従います。

netMsmqBinding バインディングトランスポートを使用する場合の既定では、セキュリティが有効です。トランスポートセキュリティの種類は、MsmqAuthenticationMode と MsmqProtectionLevel の 2 つのプロパティで決まります。既定では、認証モードは Windows に、保護レベルは Sign に、それぞれ設定されます。MSMQ で認証および署名機能を実行するには、MSMQ がドメインに属している必要があります。このサンプルをドメインに属していないコンピュータで実行すると、"User's internal message queuing certificate does not exist" というエラーが表示されます。

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

ドメインに属していないコンピュータを使用する場合は、トランスポートセキュリティをオフにします。オフにするには、認証モードと保護レベルを None に設定します。サンプル構成を次に示します。
```
<bindings>
    <netMsmqBinding>
        <binding name="TransactedBinding">
            <security mode="None"/>
        </binding>
    </netMsmqBinding>
</bindings>
```
エンドポイントの bindingConfiguration 属性を設定して、エンドポイントがこのバインディングに関連付けられるようにします。

サンプルを実行する前に、PoisonMessageServer、サーバー、およびクライアントの構成を変更してください。

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

Metadata Exchange を機能させるため、URL を HTTP バインディングに登録します。これを行うには、サービスが権限の高いコマンドウィンドウで実行されている必要があります。それ以外の場合、"未処理の例外 : System.ServiceModel.AddressAccessDeniedException: HTTP は URL http://+:8000/ServiceModelSamples/service/ を登録できません。プロセスにこの名前空間へのアクセス権がありません (詳細については、https://go.microsoft.com/fwlink/?LinkId=70353 を参照してください)。 ---> "System.Net.HttpListenerException: アクセスが拒否されました。" のような例外が発生します。

Footer image

次の方法で共有

MSMQ 4.0 での有害メッセージ処理

MSMQ v4.0 の有害メッセージ処理サンプル

有害メッセージキューのメッセージの処理

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

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

その他のリソース

次の方法で共有

MSMQ 4.0 での有害メッセージ処理

MSMQ v4.0 の有害メッセージ処理サンプル

有害メッセージ キューのメッセージの処理

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

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

その他のリソース

有害メッセージキューのメッセージの処理