一个非常简单用.NET操作RabbitMQ的方法

RabbitMQ作为一款主流的消息队列工具早已广受欢迎。相比于其它的MQ工具,RabbitMQ支持的语言更多、功能更完善。

 

本文提供一种市面上最/极简单的使用RabbitMQ的方式(支持.NET/.NET Framework/.NET Core),只需要会调用以下三个方法,你就几乎可以掌握整个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具有UUID的特性。
          }
    (III)RabbitMQMessage.Header字典中,实际值为string类型的object值,需要通过字节转换才能变为字符串。
           例如:Encoding.UTF8.GetString((byte[])p.Header["Content"])

最后说明一点:一旦调用三个方法,会与RabbitMQ服务器建立“长链接”。若要结束“长链接”,可在“任务管理器”中杀死进程。

 

使用消息服务对解耦分布式系统、实现发布/订阅、提高系统性能、等方面都有巨大用处,相信本文会扩展你的思维认知,让你在相关技术解决方案上有更多灵活思路+联想空间!

 

【附注】:文中所有示例均已成功运行通过!!技术交流/支持,请微信扫描二维码,备注“进群”!