MessageQueue

[C#] MessageQueueでのメッセージ受信方法

2025-01-18更新日: 2025-01-18

C#でMessageQueueを使用してメッセージを受信するには、まずSystem.Messaging名前空間をインポートします。

次に、MessageQueueオブジェクトを作成し、受信したいキューのパスを指定します。

メッセージを受信するには、Receiveメソッドを使用します。

このメソッドは、キューからメッセージを取り出し、Messageオブジェクトとして返します。

非同期でメッセージを受信する場合は、BeginReceiveメソッドを使用し、コールバックメソッドを指定します。

受信したメッセージは、Bodyプロパティを通じてアクセスできます。

メッセージのフォーマットに応じて、適切なデシリアライズを行う必要があります。

目次から探す

メッセージの受信方法
メッセージの処理
応用例
まとめ

メッセージの受信方法

メッセージキューを使用することで、アプリケーション間でメッセージを送受信することができます。

ここでは、C#におけるメッセージの受信方法について詳しく解説します。

同期受信の方法

同期受信では、メッセージが到着するまでプログラムの実行がブロックされます。

以下は、同期受信の基本的なサンプルコードです。

using System;
using System.Messaging; // MessageQueueを使用するための名前空間
public partial class MyForm
{
    private void ReceiveMessageSynchronously()
    {
        // メッセージキューのパスを指定
        string queuePath = @".\Private$\MyQueue";
        MessageQueue messageQueue = new MessageQueue(queuePath);
        // メッセージを受信
        Message message = messageQueue.Receive(); // メッセージが到着するまで待機
        message.Formatter = new XmlMessageFormatter(new String[] { "System.String,mscorlib" });
        // メッセージの内容を取得
        string messageBody = (string)message.Body;
        Console.WriteLine("受信したメッセージ: " + messageBody);
    }
}

このコードでは、指定したメッセージキューからメッセージを受信し、その内容をコンソールに表示します。

Receive()メソッドは、メッセージが到着するまで待機します。

非同期受信の方法

非同期受信では、メッセージが到着した際にイベントが発生し、プログラムの実行がブロックされません。

以下は、非同期受信の基本的なサンプルコードです。

using System;
using System.Messaging; // MessageQueueを使用するための名前空間
public partial class MyForm
{
    private MessageQueue messageQueue;
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        messageQueue = new MessageQueue(@".\Private$\MyQueue");
        messageQueue.ReceiveCompleted += new ReceiveCompletedEventHandler(OnReceiveCompleted);
        messageQueue.BeginReceive(); // 非同期受信を開始
    }
    private void OnReceiveCompleted(object sender, ReceiveCompletedEventArgs e)
    {
        // メッセージを受信
        Message message = messageQueue.EndReceive(e.AsyncResult);
        message.Formatter = new XmlMessageFormatter(new String[] { "System.String,mscorlib" });
        // メッセージの内容を取得
        string messageBody = (string)message.Body;
        Console.WriteLine("受信したメッセージ: " + messageBody);
        // 再度非同期受信を開始
        messageQueue.BeginReceive();
    }
}

このコードでは、ReceiveCompletedイベントを使用して非同期にメッセージを受信します。

メッセージを受信した際にOnReceiveCompletedメソッドが呼び出され、メッセージの内容が表示されます。

メッセージのデシリアライズ

メッセージのデシリアライズは、受信したメッセージを適切なデータ型に変換するプロセスです。

以下は、メッセージのデシリアライズのサンプルコードです。

using System;
using System.Messaging; // MessageQueueを使用するための名前空間
public partial class MyForm
{
    private void DeserializeMessage()
    {
        string queuePath = @".\Private$\MyQueue";
        MessageQueue messageQueue = new MessageQueue(queuePath);
        // メッセージを受信
        Message message = messageQueue.Receive();
        message.Formatter = new XmlMessageFormatter(new String[] { "System.String,mscorlib" });
        // メッセージのデシリアライズ
        string messageBody = (string)message.Body; // 文字列としてデシリアライズ
        Console.WriteLine("デシリアライズしたメッセージ: " + messageBody);
    }
}

このコードでは、受信したメッセージを文字列としてデシリアライズし、その内容を表示します。

デシリアライズの際には、適切なフォーマッタを設定することが重要です。

メッセージの処理

メッセージを受信した後は、その内容を適切に処理する必要があります。

ここでは、メッセージの内容の取得方法、フォーマットとデータ型、エラーハンドリングについて解説します。

メッセージの内容の取得

メッセージの内容を取得するためには、受信したメッセージのBodyプロパティを使用します。

以下は、メッセージの内容を取得するサンプルコードです。

using System;
using System.Messaging; // MessageQueueを使用するための名前空間
public partial class MyForm
{
    private void GetMessageContent()
    {
        string queuePath = @".\Private$\MyQueue";
        MessageQueue messageQueue = new MessageQueue(queuePath);
        // メッセージを受信
        Message message = messageQueue.Receive();
        message.Formatter = new XmlMessageFormatter(new String[] { "System.String,mscorlib" });
        // メッセージの内容を取得
        string messageBody = (string)message.Body; // メッセージの内容を文字列として取得
        Console.WriteLine("メッセージの内容: " + messageBody);
    }
}

このコードでは、受信したメッセージの内容を文字列として取得し、コンソールに表示します。

Bodyプロパティを使用することで、メッセージの内容にアクセスできます。

メッセージのフォーマットとデータ型

メッセージのフォーマットは、メッセージの内容をどのようにシリアライズおよびデシリアライズするかを決定します。

C#では、一般的にXmlMessageFormatterやBinaryMessageFormatterが使用されます。

以下は、メッセージのフォーマットを設定するサンプルコードです。

using System;
using System.Messaging; // MessageQueueを使用するための名前空間
public partial class MyForm
{
    private void SetMessageFormat()
    {
        string queuePath = @".\Private$\MyQueue";
        MessageQueue messageQueue = new MessageQueue(queuePath);
        // メッセージのフォーマットを設定
        messageQueue.Formatter = new XmlMessageFormatter(new String[] { "System.String,mscorlib" });
        
        // メッセージを送信
        Message message = new Message("こんにちは、メッセージキュー！");
        messageQueue.Send(message); // メッセージをキューに送信
    }
}

このコードでは、XmlMessageFormatterを使用してメッセージのフォーマットを設定し、文字列メッセージを送信しています。

フォーマットを適切に設定することで、受信側でのデシリアライズがスムーズになります。

エラーハンドリングと例外処理

メッセージの受信や処理中にエラーが発生する可能性があります。

そのため、エラーハンドリングと例外処理を適切に行うことが重要です。

以下は、エラーハンドリングを含むサンプルコードです。

using System;
using System.Messaging; // MessageQueueを使用するための名前空間
public partial class MyForm
{
    private void HandleErrors()
    {
        string queuePath = @".\Private$\MyQueue";
        MessageQueue messageQueue = new MessageQueue(queuePath);
        try
        {
            // メッセージを受信
            Message message = messageQueue.Receive();
            message.Formatter = new XmlMessageFormatter(new String[] { "System.String,mscorlib" });
            // メッセージの内容を取得
            string messageBody = (string)message.Body;
            Console.WriteLine("受信したメッセージ: " + messageBody);
        }
        catch (MessageQueueException mqEx)
        {
            Console.WriteLine("メッセージキューエラー: " + mqEx.Message);
        }
        catch (Exception ex)
        {
            Console.WriteLine("一般的なエラー: " + ex.Message);
        }
    }
}

このコードでは、try-catchブロックを使用してメッセージの受信中に発生する可能性のある例外を処理しています。

MessageQueueExceptionをキャッチすることで、メッセージキューに特有のエラーを適切に処理できます。

エラーハンドリングを行うことで、アプリケーションの安定性を向上させることができます。

応用例

メッセージキューを使用することで、さまざまな応用が可能です。

ここでは、複数のメッセージキューの管理、メッセージフィルタリングの実装、メッセージの優先度設定について解説します。

複数のメッセージキューの管理

複数のメッセージキューを管理することで、異なる種類のメッセージを効率的に処理できます。

以下は、複数のメッセージキューを管理するサンプルコードです。

using System;
using System.Messaging; // MessageQueueを使用するための名前空間
public partial class MyForm
{
    private void ManageMultipleQueues()
    {
        // メッセージキューのパスを指定
        string queuePath1 = @".\Private$\Queue1";
        string queuePath2 = @".\Private$\Queue2";
        // メッセージキューを作成
        if (!MessageQueue.Exists(queuePath1))
        {
            MessageQueue.Create(queuePath1);
        }
        if (!MessageQueue.Exists(queuePath2))
        {
            MessageQueue.Create(queuePath2);
        }
        // メッセージを送信
        using (MessageQueue queue1 = new MessageQueue(queuePath1))
        using (MessageQueue queue2 = new MessageQueue(queuePath2))
        {
            queue1.Send("Queue1へのメッセージ");
            queue2.Send("Queue2へのメッセージ");
        }
        Console.WriteLine("両方のキューにメッセージを送信しました。");
    }
}

このコードでは、2つのメッセージキューを作成し、それぞれにメッセージを送信しています。

複数のキューを管理することで、異なる処理を分けて行うことができます。

メッセージフィルタリングの実装

メッセージフィルタリングを実装することで、特定の条件に基づいてメッセージを受信することができます。

以下は、メッセージフィルタリングのサンプルコードです。

using System;
using System.Messaging; // MessageQueueを使用するための名前空間
public partial class MyForm
{
    private void FilterMessages()
    {
        string queuePath = @".\Private$\MyQueue";
        MessageQueue messageQueue = new MessageQueue(queuePath);
        // メッセージを受信
        Message message = messageQueue.Receive(new TimeSpan(0, 0, 5)); // 5秒待機
        message.Formatter = new XmlMessageFormatter(new String[] { "System.String,mscorlib" });
        // メッセージの内容を取得
        string messageBody = (string)message.Body;
        // フィルタリング条件
        if (messageBody.Contains("重要"))
        {
            Console.WriteLine("重要なメッセージを受信: " + messageBody);
        }
        else
        {
            Console.WriteLine("フィルタリングされたメッセージ: " + messageBody);
        }
    }
}

このコードでは、受信したメッセージの内容に「重要」というキーワードが含まれているかどうかをチェックし、条件に応じて処理を分けています。

メッセージフィルタリングを行うことで、必要なメッセージのみを処理することができます。

メッセージの優先度設定

メッセージの優先度を設定することで、重要なメッセージを先に処理することができます。

以下は、メッセージの優先度を設定するサンプルコードです。

using System;
using System.Messaging; // MessageQueueを使用するための名前空間
public partial class MyForm
{
    private void SetMessagePriority()
    {
        string queuePath = @".\Private$\MyQueue";
        MessageQueue messageQueue = new MessageQueue(queuePath);
        // 高優先度メッセージを送信
        Message highPriorityMessage = new Message("高優先度メッセージ")
        {
            AppSpecific = 1 // 優先度を設定
        };
        messageQueue.Send(highPriorityMessage);
        // 低優先度メッセージを送信
        Message lowPriorityMessage = new Message("低優先度メッセージ")
        {
            AppSpecific = 0 // 優先度を設定
        };
        messageQueue.Send(lowPriorityMessage);
        Console.WriteLine("メッセージを優先度に応じて送信しました。");
    }
}