跳到主要内容

RabbitMQ Stream 教程 - “Hello World!”

简介​

信息

先决条件​

本教程假设您已安装 RabbitMQ，并在 localhost 上运行，并且已启用 stream 插件。标准 stream 端口为 5552。如果您使用不同的主机、端口或凭据，则需要调整连接设置。

使用 Docker​

如果您没有安装 RabbitMQ，可以在 Docker 容器中运行它

docker run -it --rm --name rabbitmq -p 5552:5552 -p 15672:15672 -p 5672:5672  \
    -e RABBITMQ_SERVER_ADDITIONAL_ERL_ARGS='-rabbitmq_stream advertised_host localhost' \
    rabbitmq:4-management

等待服务器启动，然后启用 stream 和 stream management 插件

docker exec rabbitmq rabbitmq-plugins enable rabbitmq_stream rabbitmq_stream_management

在哪里获得帮助​

如果您在学习本教程时遇到问题，可以通过邮件列表或 discord 社区服务器联系我们。

RabbitMQ Streams 在 RabbitMQ 3.9 中引入。更多信息请访问此处。

“Hello World”​

（使用 .NET/C# Stream 客户端）​

在本教程的这一部分，我们将用 C# 编写两个程序；一个生产者发送一条消息，一个消费者接收消息并打印出来。我们将略过 .NET 客户端 API 的一些细节，专注于这个非常简单的事情，以便入门。这是 RabbitMQ Streams 的“Hello World”。

.NET stream 客户端库​

RabbitMQ 使用多种协议。本教程使用 RabbitMQ stream 协议，该协议是 RabbitMQ streams 的专用协议。在 多种不同的语言中，有许多 RabbitMQ 客户端，请参阅每种语言的 stream 客户端库。我们将使用 RabbitMQ 提供的 .NET stream 客户端。

该客户端支持 .NET。本教程将使用 RabbitMQ .NET stream 客户端 1.8.0 和 .NET，因此请确保您已安装并在您的 PATH 中。

RabbitMQ .NET stream 客户端 1.8 及更高版本通过 nuget 分发。

本教程假设您在 Windows 上使用 PowerShell。在 MacOS 和 Linux 上，几乎任何 shell 都可以工作。

设置​

首先，让我们验证您的 .NET 工具链是否在 PATH 中

dotnet --help

运行该命令应该会生成帮助消息。

本教程的可执行版本可以在 RabbitMQ 教程存储库中找到。

现在让我们生成两个项目，一个用于发布者，一个用于消费者

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.Stream.Client 
cd ../Receive
dotnet add package RabbitMQ.Stream.Client 
cd ..

现在我们已经设置了 .NET 项目，我们可以编写一些代码了。

发送​

我们将把我们的消息生产者（发送者）称为 Send.cs，消息消费者（接收者）称为 Receive.cs。生产者将连接到 RabbitMQ，发送一条消息，然后退出。

在 Send.cs 中，我们需要使用一些命名空间

using System.Text;
using RabbitMQ.Stream.Client;
using RabbitMQ.Stream.Client.Reliable;

然后我们可以创建到服务器的连接

var streamSystem = await StreamSystem.Create(new StreamSystemConfig());

stream .NET 客户端的入口点是 StreamSystem。它用于配置 RabbitMQ stream 发布者、stream 消费者和 stream 本身。

它抽象了套接字连接，并为我们处理协议版本协商和身份验证等。

本教程假设 stream 发布者和消费者连接到本地运行的 RabbitMQ 节点，即 localhost。要连接到不同机器上的节点，只需在 StreamSystemConfig 上指定目标主机名或 IP 地址。

接下来，让我们创建一个生产者。

生产者还将声明一个 stream，它将向其发布消息，然后发布一条消息

await streamSystem.CreateStream(new StreamSpec("hello-stream")
{
    MaxLengthBytes = 5_000_000_000
});

var producer = await Producer.Create(new ProducerConfig(streamSystem, "hello-stream"));

await producer.Send(new Message(Encoding.UTF8.GetBytes($"Hello, World")));

stream 声明操作是幂等的：stream 仅在尚不存在时才会被创建。

stream 是一种仅追加的日志抽象，允许重复消费消息，直到它们过期。始终定义保留策略是一个好习惯。在上面的示例中，stream 的大小限制为 5 GiB。

消息内容是字节数组。应用程序可以使用任何适当的格式（例如 JSON、MessagePack 等）来编码他们需要传输的数据。

当上面的代码完成运行时，生产者连接和 stream-system 连接将被关闭。这就是我们的生产者。

每次运行生产者时，它都会向服务器发送一条消息，并且该消息将被附加到 stream。

完整的 Send.cs 文件可以在 GitHub 上找到。

发送不起作用！​

如果这是您第一次使用 RabbitMQ，并且没有看到“Sent”消息，那么您可能会挠头想知道哪里出错了。可能是启动 broker 时磁盘空间不足（默认情况下至少需要 50 MB 空闲空间），因此拒绝接受消息。检查 broker 日志文件以查看是否记录了 资源警报，并在必要时降低可用磁盘空间阈值。配置指南将向您展示如何设置 disk_free_limit。

另一个原因可能是程序在消息到达 broker 之前退出。在某些客户端库中，发送是异步的：函数立即返回，但消息在通过网络传输之前会在 IO 层排队。发送程序要求用户按键以完成该过程：消息有足够的时间到达 broker。stream 协议提供了一种确认机制来确保 broker 接收出站消息，但为了简单起见，本教程未使用此机制。

接收​

本教程的另一部分，消费者，将连接到 RabbitMQ 节点并等待消息被推送到它。与本教程中发布单条消息并停止的生产者不同，消费者将持续运行，消费 RabbitMQ 将推送给它的消息，并打印接收到的有效负载。

与 Send.cs 类似，Receive.cs 也需要使用一些命名空间

using System.Text;
using RabbitMQ.Stream.Client;
using RabbitMQ.Stream.Client.Reliable;

在初始设置方面，消费者部分与生产者部分非常相似；我们使用默认连接设置并声明消费者将从中消费的 stream。

请注意，stream 名称必须与生产者使用的名称匹配。

var streamSystem = await StreamSystem.Create(new StreamSystemConfig());

await streamSystem.CreateStream(new StreamSpec("hello-stream")
{
    MaxLengthBytes = 5_000_000_000
});

请注意，消费者部分也声明了 stream。这是为了允许先启动生产者或消费者中的任何一个。

Consumer 类用于实例化 stream 消费者，而 ConsumerConfig 记录用于配置它。我们提供了一个 MessageHandler 回调来处理传递的消息。

OffsetSpec 属性定义了消费者的起始点。在本例中，消费者从 stream 中可用的第一条消息开始。

var consumer = await Consumer.Create(new ConsumerConfig(streamSystem, "hello-stream")
{
    OffsetSpec = new OffsetTypeFirst(),
    MessageHandler = async (stream, _, _, message) =>
    {
        Console.WriteLine($"Stream: {stream} - " +
                          $"Received message: {Encoding.UTF8.GetString(message.Data.Contents)}");
        await Task.CompletedTask;
    }
});

完整的 Receive.cs 文件可以在 GitHub 上找到。

将它们放在一起​

为了运行这两个示例，请打开两个终端（shell）标签页。

本教程的两个部分都可以按任何顺序运行，因为它们都声明了 stream。让我们先运行消费者，以便在第一个发布者启动时，消费者将打印它

cd Receive
dotnet run

然后运行生产者

cd Send
dotnet run

消费者将打印它从 RabbitMQ 通过发布者获得的消息。消费者将保持运行，等待新的交付。尝试多次重新运行发布者以观察这一点。

Stream 与队列的不同之处在于，它们是可以重复消费的消息的仅追加日志。当多个消费者从一个 stream 消费时，他们将从第一条可用消息开始。

© . All rights reserved.