它讓你1小時精通RabbitMQ訊息佇列(新增死信處理)

2022-10-12 12:00:38

支援.NET/.NET Framework/.NET Core

RabbitMQ作為一款主流的訊息佇列工具早已廣受歡迎。相比於其它的MQ工具,RabbitMQ支援的語言更多、功能更完善。

本文提供一種市面上最/極簡單的使用RabbitMQ的方式,只需要會呼叫以下三個方法,你就幾乎可以掌握整個RabbitMQ的使用:

(1)     SendMessage,傳送一個訊息

(2)     GetMessage,獲取一個訊息

(3)     UseMessage,使用一個訊息(連續使用)

 

為了呼叫以上三個方法,首先需要從nuget參照DeveloperSharp.RabbitMQ,並在App.config/Web.config裡面新增如下設定(.NET6 / VS2022中已有App.config這個新增單項):

  <appSettings>
    <add key="RabbitMQConnectionString" value="hostName=135.208.12.236,port=5672,userName=sa,password=aevin.gang" />
  </appSettings>

說明:上述設定中分別設定了RabbitMQ應用所在的伺服器IP地址hostName、埠port、使用者名稱userName、密碼password(請把這四項的對應值修改成你自己那邊的RabbitMQ的對應值)

 

下面,我們給出一個使用了上述SendMessage、GetMessage、UseMessage三個方法的範例。該範例的功能說明如下:

  • 先向RabbitMQ伺服器上名為「aa」的佇列傳送了5個訊息,
  • 然後從RabbitMQ伺服器上的「aa」佇列中獲取,並列印出第1個訊息,
  • 最後再連續從RabbitMQ伺服器上的「aa」佇列中獲取剩餘4個訊息,並把它們寫入名為fj.txt的檔案。

程式碼如下:

using DeveloperSharp.RabbitMQ;
--------------------------

        static void Main(string[] args)
        {
            //傳送5個訊息(使用SendMessage)
            RabbitMQHelper.SendMessage("aa", "世界1,你好!");
            RabbitMQHelper.SendMessage("aa", "世界2,你好!");
            RabbitMQHelper.SendMessage("aa", "世界3,你好!");
            RabbitMQHelper.SendMessage("aa", "世界4,你好!");
            RabbitMQHelper.SendMessage("aa", "世界5,你好!");

            //獲取1個訊息(使用GetMessage)
            string OneMessage = RabbitMQHelper.GetMessage("aa").Message;
            Console.WriteLine(OneMessage);

            //向fj.txt這個文字檔案中寫入4個訊息(使用UseMessage)
            RabbitMQHelper.UseMessage("aa", t => 
            {
                System.IO.File.AppendAllText("D:/fj.txt", t.Message);
                return true;
            });
        }

執行結果如下:

【控制檯顯示出】:世界1,你好!

【fj.txt檔案中顯示出】:世界2,你好!世界3,你好!世界4,你好!世界5,你好!

 

三個方法的詳細功能說明(輔助參考):

1)傳送一個訊息
void SendMessage(string QueueName, string Message, Dictionary<string, object> Header = null)

(2)獲取一個訊息
RabbitMQMessage GetMessage(string QueueName)

(3)使用一個訊息(連續使用)
void UseMessage(string QueueName, Func<RabbitMQMessage, bool?> Use)
附加說明:
    (I)Use返回值為true時,代表當前訊息已被有效處理並會被伺服器刪除。然後程式自動進入下一條訊息的使用。
         若Use返回值為false時,代表當前訊息未被有效處理但仍會被伺服器刪除。然後程式自動進入下一條訊息的使用。
         若Use返回值為null時,代表當前訊息會被伺服器重新佇列分配到其它可用的範例上再處理。然後程式自動進入下一條訊息的使用。
         若Use內部發生未被處理的異常,程式會停止。
    (II)RabbitMQMessage物件定義如下:
          public class RabbitMQMessage
          {
             public string Message;
             public IDictionary<string, object> Header;
             public string Id; //此處系統自動生成的Id具有分散式唯一Id的特性。
          }

 

延時佇列&死信佇列

有些場景下,我們希望為使用的訊息設定有效期。在有效期內,這些訊息有效可用;但過期後,這些訊息將變得無效不可用,同時,它們還將自動進入一個稱之為「死信」的佇列。

為了說明這些概念,我們還是來舉一個具體的例子。該例子的功能說明如下:

  • 首先,在RabbitMQ伺服器上定義一個名為"bbq"的佇列。且設定此佇列中存放的所有訊息會在60秒後過期失效。
  • 然後,在RabbitMQ伺服器上定義一個與"bbq"佇列對應的死信佇列。並連續從該死信佇列中獲取訊息並把它們寫入名為BB.txt的檔案。
  • 最後,向RabbitMQ伺服器上的"bbq"佇列傳送3個訊息。

 程式碼如下:

using DeveloperSharp.RabbitMQ;
--------------------------

            //定義bbq佇列,其中存放的訊息會在60秒後過期
            var myQ = RabbitMQHelper.SetQueue("bbq", 60000);

            //定義與bbq佇列對應的死信佇列
            var expQ = RabbitMQHelper.GetQueue("bbq");
            //向BB.txt這個文字檔案中連續寫入死信佇列中的訊息
            expQ.UseMessage(t =>
            {
                System.IO.File.AppendAllText("D:/BB.txt", t.Message);
                return true;
            });

            //向bbq佇列傳送3個訊息
            myQ.SendMessage("jinA");
            myQ.SendMessage("jinB");
            myQ.SendMessage("jinC");

            /*
            //【附加題】:若去掉註釋讓此語句執行,死信佇列中將不會獲得訊息(為啥?自己推理)
            RabbitMQHelper.UseMessage("bbq", t =>
            {
                return true;//若此處返回false,死信佇列將會獲得訊息
            });
            */

執行以上程式:

60秒之內,【BB.txt檔案】中沒有內容

60秒以後,【BB.txt檔案】中顯示出:jinAjinBjinC

 

通過以上例子,我們可簡單預測一下,延時佇列&死信佇列常用在「限時消費」、「過期處理」等場景。生活中最常見範例如:訂單請在10分鐘內支付完畢、等等之類功能...

 

使用訊息服務對解耦分散式系統、實現釋出/訂閱、提高系統效能、等方面都有巨大用處,相信本文會擴充套件你的思維認知,讓你在相關技術解決方案上有更多靈活思路+聯想空間!

 

【附註】:文中所有範例均已成功執行通過!!技術交流/支援,請微信掃描二維條碼,備註「進群」!