RabbitMQ 教程 - "Hello World!"
简介
先决条件
本教程假设 RabbitMQ 已 安装 并在 localhost 上的 标准端口 (5672) 上运行。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
哪里寻求帮助
如果您在学习本教程时遇到困难,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
RabbitMQ 是一个消息代理:它接收并转发消息。你可以把它想象成一个邮局:当你把想要寄出的邮件放进邮箱时,你可以确信邮递员最终会将邮件送到你的收件人手中。在这个比喻中,RabbitMQ 就是邮箱、邮局和邮递员。
RabbitMQ 和邮局的主要区别在于,它不处理纸张,而是接收、存储和转发数据的二进制数据块——消息。
RabbitMQ 和消息传递通常会使用一些行话。
-
生产仅仅意味着发送。发送消息的程序就是生产者。
-
队列 是 RabbitMQ 中邮箱的名称。虽然消息在 RabbitMQ 和你的应用程序之间流动,但它们只能存储在队列 中。队列 的大小仅受主机内存和磁盘空间的限制,它本质上是一个大的消息缓冲区。
许多生产者 可以发送消息到同一个队列,许多消费者 可以尝试从同一个队列 接收数据。
这就是我们表示队列的方式
-
消费 的含义与接收类似。消费者 是一个主要等待接收消息的程序。
请注意,生产者、消费者和代理不一定需要驻留在同一台主机上;事实上,在大多数应用程序中它们都不会。一个应用程序也可以同时是生产者和消费者。
"Hello World"
(使用 AMQP 1.0 .NET 客户端)
在本教程的这一部分,我们将用 C# 编写两个小程序;一个用于发送单条消息的生产者,以及一个用于接收并打印消息的消费者。我们将略过 .NET AMQP 1.0 客户端 API 的一些细节,专注于这个非常简单的入门示例。这就是消息传递领域的“Hello World”。
在下面的图表中,“P”是我们的生产者,“C”是我们的消费者。中间的框是一个队列——RabbitMQ 代表消费者存储的消息缓冲区。
AMQP 1.0 .NET 客户端库
RabbitMQ 支持多种协议。本教程使用与 AMQP 0-9-1 相同的端口(默认 5672)通过 AMQP 1.0 进行通信。它需要 RabbitMQ 4.0 或更高版本。
请使用 RabbitMQ AMQP 1.0 .NET 客户端(NuGet 上的
RabbitMQ.AMQP.Client),不要使用传统的 AMQP 0-9-1 客户端(RabbitMQ.Client)。请参阅 AMQP 1.0 客户端库 和 .NET 客户端 API。将该包添加到您的项目中
dotnet add package RabbitMQ.AMQP.Client本系列教程的可运行源代码在合并到上游后,可在 RabbitMQ 教程 仓库(
dotnet-amqp目录)中找到。
现在我们已经引用了客户端,可以编写一些代码了。
发送
我们将消息发布者(发送方)称为 Send,将消息消费者称为 Receive。发布者将连接到 RabbitMQ,发送单条消息,然后退出。
在 Send/Program.cs 中,使用这些命名空间
using System.Text;
using RabbitMQ.AMQP.Client;
using RabbitMQ.AMQP.Client.Impl;
创建连接设置、环境和连接。URI 使用默认虚拟主机(%2f 代表 /)
const string brokerUri = "amqp://guest:guest@localhost:5672/%2f";
ConnectionSettings settings = ConnectionSettingsBuilder.Create()
.Uri(new Uri(brokerUri))
.ContainerId("tutorial-send")
.Build();
IEnvironment environment = AmqpEnvironment.Create(settings);
IConnection connection = await environment.CreateConnectionAsync();
声明一个名为 hello 的仲裁队列 (quorum queue),然后创建一个发布者并发布一条消息。检查 PublishResult.Outcome.State 是否为 OutcomeState.Accepted
try
{
IManagement management = connection.Management();
IQueueSpecification queueSpec = management.Queue("hello").Type(QueueType.QUORUM);
await queueSpec.DeclareAsync();
IPublisher publisher = await connection.PublisherBuilder().Queue("hello").BuildAsync();
try
{
const string body = "Hello World!";
var message = new AmqpMessage(Encoding.UTF8.GetBytes(body));
PublishResult pr = await publisher.PublishAsync(message);
if (pr.Outcome.State != OutcomeState.Accepted)
{
Console.Error.WriteLine($"Unexpected publish outcome: {pr.Outcome.State}");
Environment.Exit(1);
}
Console.WriteLine($" [x] Sent {body}");
}
finally
{
await publisher.CloseAsync();
}
}
finally
{
await connection.CloseAsync();
await environment.CloseAsync();
}
完整的 Send/Program.cs 源码(合并到上游后)。
发送不起作用!
如果您是第一次使用 RabbitMQ 且没有看到 "[x] Sent" 消息,您可能会感到困惑,不知道出了什么问题。也许代理服务器启动时磁盘剩余空间不足(默认至少需要 50 MB 空间),因此拒绝接受消息。请检查代理服务器的 日志文件,查看是否有记录 资源报警。
接收
我们的发布者就到这里了。我们的消费者会监听来自 RabbitMQ 的消息,所以与只发布一条消息的发布者不同,我们将保持消费者的运行状态,监听并打印消息。
Receive/Program.cs 中的代码声明了相同的仲裁队列,然后构建了一个带消息处理程序的消费者。调用 ctx.Accept() 来确认消息(AMQP 1.0)
IManagement management = connection.Management();
IQueueSpecification queueSpec = management.Queue("hello").Type(QueueType.QUORUM);
await queueSpec.DeclareAsync();
IConsumer consumer = await connection.ConsumerBuilder()
.Queue("hello")
.MessageHandler((ctx, message) =>
{
Console.WriteLine($"Received a message: {Encoding.UTF8.GetString(message.Body()!)}");
ctx.Accept();
return Task.CompletedTask;
})
.BuildAndStartAsync();
使用 Ctrl+C 处理和 Task.Delay(Timeout.Infinite, cts.Token) 让进程保持运行,直到被中断。
完整的 Receive/Program.cs 源码(合并到上游后)。
总而言之
在 dotnet-amqp 目录下,先运行消费者,再运行发布者
dotnet run --project Receive/Receive.csproj
dotnet run --project Send/Send.csproj
消费者将打印从发布者通过 RabbitMQ 获取的消息。
列出队列
您可能希望查看 RabbitMQ 有哪些队列以及其中有多少消息。您可以使用
rabbitmqctl工具(作为特权用户)来完成此操作。sudo rabbitmqctl list_queues在 Windows 上,省略 sudo。
rabbitmqctl.bat list_queues
现在是时候继续学习 第 2 部分,并构建一个简单的工作队列了。