.NET 全网最火RabbitMQ操作

正文

支持.Net/.Net Core/.Net Framework,可以部署在Docker, Windows, Linux, Mac。

RabbitMQ作为一款主流的消息队列工具早已广受欢迎。

相比于其它的MQ工具,RabbitMQ支持的语言更多、功能更完善。.

本文提供一种市面上最/极简单的使用RabbitMQ的方式,只需要会调用以下三个方法,你就几乎可以掌握整个RabbitMQ的使用:

1、SendMessage,发送一个消息

2、GetMessage,获取一个消息

3、UseMessage,使用一个消息(连续使用)

为了调用以上三个方法,首先需要从NuGet引用DeveloperSharp.RabbitMQ包。

然后,对RabbitMQ消息服务器的链接信息进行配置(分.Net Core与.Net Framework两种情况):

若是在.Net Core环境下,你则需要在appsettings.json文件中添加"DeveloperSharp.RabbitMQ"节点(如下配置示例),并把appsettings.json文件放到程序执行目录中

(即bin目录下与dll、exe等文件的同一目录中)(放错了位置会报错)

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",

  "DeveloperSharp.RabbitMQ":[{
    "HostName":"135.208.12.236",
    "UserName":"sa",
    "Password":"aevin.gang",
    "Port":5672
  }]
}

若是在.Net Framework环境下,你则需要在App.config/Web.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的对应值)

(注意:DeveloperSharp.RabbitMQ包在7.0版本以前,.Net Core下也支持App.config/Web.config配置。但在7.0及以后版本中,.Net Core下只支持appsettings.json文件配置)

下面,我们给出一个使用了上述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,你好!

(上述示例中,由于SendMessage是同步方法,故“世界1,你好!”~“世界5,你好!”会按顺序显示。若我们把SendMessage方法全部改为异步的SendMessageAsync,则显示结果将不再是按顺序来的,很有可能显示成类似这样:“世界3,你好!世界1,你好!世界5,你好!世界2,你好!世界4,你好!”)

三个方法的详细功能说明(辅助参考):

1、发送一个消息

void SendMessage(string QueueName, string Message, Dictionary<string, object> Header = null)
//异步方法:SendMessageAsync

2、获取一个消息

RabbitMQMessage GetMessage(string QueueName)
//异步方法:GetMessageAsync

3、使用一个消息(连续使用)

void UseMessage(string QueueName, Func<RabbitMQMessage, bool?> Use)
//异步方法:UseMessageAsync

附加说明:

Use返回值为true时,代表当前消息已被有效处理并会被服务器删除。然后程序自动进入下一条消息的使用。

若Use返回值为false时,代表当前消息未被有效处理但仍会被服务器删除。然后程序自动进入下一条消息的使用。

若Use返回值为null时,代表当前消息会被服务器重新队列分配到其它可用的实例上再处理。然后程序自动进入下一条消息的使用。

若Use内部发生未被处理的异常,程序会停止。

RabbitMQMessage对象定义如下:

public class RabbitMQMessage
{
   public string Message;
   public IDictionary<string, object> Header;
   public string Id; //此处系统自动生成的Id具有UUID的特性。
}

延时队列&死信队列有些场景下,我们希望为使用的消息设定有效期。

在有效期内,这些消息有效可用;但过期后,这些消息将变得无效不可用,同时,它们还将自动被丢弃进一个称之为“死信”的队列。

为了说明这些概念,我们还是来举一个具体的例子。该例子的功能说明如下:

首先,在RabbitMQ服务器上定义一个名为"bbq"、且其中存放的消息会在60秒后过期失效的队列。

然后,在RabbitMQ服务器上定义一个与"bbq"队列对应的死信队列。并连续从该死信队列中获取消息并把它们写入名为BB.txt的文件。

最后,向RabbitMQ服务器上的"bbq"队列发送3个消息。

代码如下:

using DeveloperSharp.RabbitMQ;//从NuGet引用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分钟内支付完毕、等等之类功能...

(其它说明:为了演示便利,文本前面给出的几个代码示例中,把SendMessage、GetMessage、UseMessage三个方法都放到了同一段代码程序中,这样做不好,偶尔会造成一些资源冲突。在实际使用中,最好是把它们分开分别放到三段不同的代码程序中,以获取最佳效果。比如:三个按钮,之类...)

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