RabbitMQ 教程 - “Hello World!”
简介
先决条件
本教程假设您已安装 RabbitMQ 并在 localhost
上运行,使用标准端口 (5672)。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
在哪里获得帮助
如果您在学习本教程时遇到问题,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
RabbitMQ 是一个消息代理:它接受和转发消息。您可以将其视为邮局:当您将要邮寄的邮件放入邮箱时,您可以确信邮递员最终会将邮件投递给您的收件人。在这个类比中,RabbitMQ 是邮箱、邮局和邮递员。
RabbitMQ 与邮局之间的主要区别在于它不处理纸张,而是接受、存储和转发二进制数据块——消息。
RabbitMQ 和一般的消息传递使用一些术语。
-
生产 意味着发送。发送消息的程序是 生产者
-
队列 是 RabbitMQ 中邮箱的名称。虽然消息流经 RabbitMQ 和您的应用程序,但它们只能存储在队列内部。队列 仅受主机内存和磁盘限制的约束,它本质上是一个大型消息缓冲区。
许多生产者 可以发送消息到一个队列,而许多消费者 可以尝试从一个队列接收数据。
这是我们表示队列的方式
-
消费 与接收具有相似的含义。消费者 是一个主要等待接收消息的程序
请注意,生产者、消费者和代理不必驻留在同一主机上;实际上,在大多数应用程序中它们都不是。一个应用程序也可以同时是生产者和消费者。
“Hello World”
(使用 .NET/C# 客户端)
在本教程的这一部分中,我们将用 C# 编写两个程序;一个生产者发送单个消息,一个消费者接收消息并打印出来。我们将忽略 .NET 客户端 API 中的一些细节,专注于这个非常简单的事情,以便开始入门。这是消息传递的“Hello World”。
在下图中,“P”是我们的生产者,“C”是我们的消费者。中间的框是一个队列 - RabbitMQ 代表消费者维护的消息缓冲区。
.NET 客户端库
RabbitMQ 支持多种协议。本教程使用 AMQP 0-9-1,这是一种开放的、通用的消息传递协议。在 许多不同的语言中,有许多 RabbitMQ 的客户端。我们将使用 RabbitMQ 提供的 .NET 客户端。
该客户端支持 .NET Core 以及 .NET Framework 4.6.2+。本教程将使用 RabbitMQ .NET 客户端 7.0 和 .NET Core,因此请确保您已安装并在您的 PATH 中。
您也可以使用 .NET Framework 完成本教程,但设置步骤会有所不同。
RabbitMQ .NET 客户端版本 7 通过 nuget 分发。
本教程假设您在 Windows 上使用 PowerShell。在 MacOS 和 Linux 上,几乎任何 shell 都可以工作。
设置
首先,让我们验证您是否在 PATH
中安装了 .NET Core 工具链
dotnet --help
应该生成帮助消息。
现在让我们生成两个项目,一个用于发布者,一个用于消费者
dotnet new console --name Send
mv Send/Program.cs Send/Send.cs
dotnet new console --name Receive
mv Receive/Program.cs Receive/Receive.cs
这将创建两个名为 Send
和 Receive
的新目录。
然后添加客户端依赖项。
cd Send
dotnet add package RabbitMQ.Client
cd ../Receive
dotnet add package RabbitMQ.Client
现在我们已经设置了 .NET 项目,我们可以编写一些代码了。
发送
我们将我们的消息发布者(发送者)称为 Send.cs
,将我们的消息消费者(接收者)称为 Receive.cs
。发布者将连接到 RabbitMQ,发送一条消息,然后退出。
在 Send.cs
中,我们需要使用一些命名空间
loading...
然后我们可以创建到服务器的连接
loading...
连接抽象了套接字连接,并为我们处理协议版本协商和身份验证等。这里我们连接到本地机器上的 RabbitMQ 节点 - 因此是 localhost。如果我们想连接到不同机器上的节点,我们只需在此处指定其主机名或 IP 地址。
接下来我们创建一个通道,这是完成大多数 API 操作的地方。
要发送,我们必须声明一个队列供我们发送到;然后我们可以将消息发布到队列
loading...
声明队列是幂等的 - 仅当队列尚不存在时才会创建。消息内容是一个字节数组,因此您可以在其中编码任何您喜欢的内容。
当上面的代码完成运行时,通道和连接将被释放。我们的发布者就完成了。
发送不起作用!
如果这是您第一次使用 RabbitMQ 并且没有看到“Sent”消息,那么您可能会挠头想知道哪里可能出错了。可能是启动 Broker 时没有足够的可用磁盘空间(默认情况下至少需要 50 MB 可用空间),因此拒绝接受消息。检查 Broker 日志文件 以查看是否记录了 资源警报,并在必要时降低可用磁盘空间阈值。配置指南 将向您展示如何设置
disk_free_limit
。
接收
至于消费者,它正在监听来自 RabbitMQ 的消息。因此,与发布单个消息的发布者不同,我们将保持消费者持续运行以监听消息并将其打印出来。
代码(在 Receive.cs
中)与 Send
具有几乎相同的 using
语句
loading...
设置与发布者相同;我们打开一个连接和一个通道,并声明我们要从中消费的队列。请注意,这与 Send
发布到的队列相匹配。
loading...
请注意,我们在这里也声明了队列。因为我们可能会在发布者之前启动消费者,所以我们想确保队列在我们尝试从中消费消息之前存在。
我们即将告诉服务器向我们传递来自队列的消息。由于它将异步推送消息给我们,因此我们提供一个回调。这就是 AsyncEventingBasicConsumer.Received
事件处理程序的作用。
loading...
将它们放在一起
打开两个终端。
您可以按任何顺序运行客户端,因为两者都声明了队列。我们将首先运行消费者,以便您可以看到它正在等待然后接收消息
cd Receive
dotnet run
然后运行生产者
cd Send
dotnet run
消费者将打印它从发布者通过 RabbitMQ 收到的消息。消费者将保持运行,等待消息,因此请尝试多次重启发布者。
是时候继续学习第 2 部分并构建一个简单的工作队列了。