RabbitMQ 教程 - "Hello World!"
简介
先决条件
本教程假设 RabbitMQ 已 安装 并在 localhost 上的 标准端口 (5672) 上运行。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
哪里寻求帮助
如果您在学习本教程时遇到困难,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
RabbitMQ 是一个消息代理:它接收并转发消息。你可以把它想象成一个邮局:当你把想要寄出的邮件放进邮箱时,你可以确信邮递员最终会将邮件送到你的收件人手中。在这个比喻中,RabbitMQ 就是邮箱、邮局和邮递员。
RabbitMQ 和邮局的主要区别在于,它不处理纸张,而是接收、存储和转发数据的二进制数据块——消息。
RabbitMQ 和消息传递通常会使用一些行话。
-
生产(Producing) 仅仅意味着发送。发送消息的程序就是生产者(producer)。
-
队列 是 RabbitMQ 中邮箱的名称。虽然消息在 RabbitMQ 和你的应用程序之间流动,但它们只能存储在队列 中。队列 的大小仅受主机内存和磁盘空间的限制,它本质上是一个大的消息缓冲区。
许多生产者 可以发送消息到同一个队列,许多消费者 可以尝试从同一个队列 接收数据。
这就是我们表示队列的方式
-
消费 的含义与接收类似。消费者 是一个主要等待接收消息的程序。
请注意,生产者、消费者和代理不一定需要驻留在同一台主机上;事实上,在大多数应用程序中它们都不会。一个应用程序也可以同时是生产者和消费者。
"Hello World"
(使用 AMQP 1.0 Go 客户端)
在本教程的这一部分,我们将用 Go 编写两个小程序;一个是发送单条消息的生产者,另一个是接收并打印消息的消费者。我们将略过 Go AMQP 1.0 客户端 API 的一些细节,重点关注这个非常简单的入门示例。这就是消息传递领域的“Hello World”。
在下面的图表中,“P”是我们的生产者,“C”是我们的消费者。中间的框是一个队列——RabbitMQ 代表消费者存储的消息缓冲区。
AMQP 1.0 Go 客户端库
RabbitMQ 支持多种协议。本教程使用与 AMQP 0-9-1 相同的端口(默认 5672)通过 AMQP 1.0 进行通信。它需要 RabbitMQ 4.0 或更高版本。
请使用 RabbitMQ AMQP 1.0 Go 客户端 (
rabbitmq-amqp-go-client),而不是传统的 AMQP 0-9-1 客户端 (amqp091-go)。请参阅 AMQP 1.0 客户端库 和 Go 客户端包。使用以下命令安装:
go get github.com/rabbitmq/rabbitmq-amqp-go-client
现在客户端已安装,我们可以编写一些代码了。
发送
我们将消息发布者(发送方)命名为 send.go,将消息消费者命名为 receive.go。发布者将连接到 RabbitMQ,发送一条消息,然后退出。
在 send.go 中,我们首先需要导入库:
package main
import (
"context"
"log"
rmq "github.com/rabbitmq/rabbitmq-amqp-go-client/pkg/rabbitmqamqp"
)
使用环境(environment)和连接(connection)设置到代理(broker)的连接:
const brokerURI = "amqp://guest:guest@localhost:5672/"
func main() {
ctx := context.Background()
env := rmq.NewEnvironment(brokerURI, nil)
conn, err := env.NewConnection(ctx)
if err != nil {
log.Panicf("Failed to connect to RabbitMQ: %v", err)
}
defer func() {
_ = env.CloseConnections(context.Background())
}()
环境保存共享设置,连接表示与代理的套接字。使用 defer CloseConnections 可确保程序退出时资源得到释放。
声明一个名为 "hello" 的法定队列(quorum queue):
_, err = conn.Management().DeclareQueue(ctx, &rmq.QuorumQueueSpecification{Name: "hello"})
if err != nil {
log.Panicf("Failed to declare a queue: %v", err)
}
队列声明是幂等的:仅当队列不存在时才会被创建。法定队列是持久化的,并在 RabbitMQ 节点之间进行复制。
创建发布者并发送消息:
publisher, err := conn.NewPublisher(ctx, &rmq.QueueAddress{Queue: "hello"}, nil)
if err != nil {
log.Panicf("Failed to create publisher: %v", err)
}
defer func() { _ = publisher.Close(context.Background()) }()
body := "Hello World!"
res, err := publisher.Publish(ctx, rmq.NewMessage([]byte(body)))
if err != nil {
log.Panicf("Failed to publish a message: %v", err)
}
switch res.Outcome.(type) {
case *rmq.StateAccepted:
default:
log.Panicf("Unexpected publish outcome: %v", res.Outcome)
}
log.Printf(" [x] Sent %s\n", body)
}
在 AMQP 1.0 中,Publish 会返回一个结果。请检查 StateAccepted 以确认代理已接收该消息。
发送不起作用!
如果您是第一次使用 RabbitMQ,并且没有看到 “[x] Sent” 消息,您可能会感到困惑,不知道出了什么问题。也许是代理启动时磁盘空间不足(默认情况下至少需要 50 MB 可用空间),因此拒绝接收消息。请检查代理的 日志文件,查看是否有记录 资源报警。
接收
我们的发布者就到这里了。我们的消费者会监听来自 RabbitMQ 的消息,所以与只发布一条消息的发布者不同,我们将保持消费者的运行状态,监听并打印消息。
receive.go 中的代码类似。设置环境和连接,声明相同的队列,然后创建一个消费者:
package main
import (
"context"
"errors"
"log"
rmq "github.com/rabbitmq/rabbitmq-amqp-go-client/pkg/rabbitmqamqp"
)
const brokerURI = "amqp://guest:guest@localhost:5672/"
func main() {
ctx := context.Background()
env := rmq.NewEnvironment(brokerURI, nil)
conn, err := env.NewConnection(ctx)
if err != nil {
log.Panicf("Failed to connect to RabbitMQ: %v", err)
}
defer func() {
_ = env.CloseConnections(context.Background())
}()
_, err = conn.Management().DeclareQueue(ctx, &rmq.QuorumQueueSpecification{Name: "hello"})
if err != nil {
log.Panicf("Failed to declare a queue: %v", err)
}
consumer, err := conn.NewConsumer(ctx, "hello", nil)
if err != nil {
log.Panicf("Failed to create consumer: %v", err)
}
defer func() { _ = consumer.Close(context.Background()) }()
log.Printf(" [*] Waiting for messages. To exit press CTRL+C")
for {
delivery, err := consumer.Receive(ctx)
if err != nil {
if errors.Is(err, context.Canceled) {
return
}
log.Panicf("Failed to receive a message: %v", err)
}
msg := delivery.Message()
var body string
if len(msg.Data) > 0 {
body = string(msg.Data[0])
}
log.Printf("Received a message: %s", body)
err = delivery.Accept(ctx)
if err != nil {
log.Panicf("Failed to accept message: %v", err)
}
}
}
请注意,我们也在这里声明了队列。因为我们可能在发布者之前启动消费者,所以要确保在尝试从队列消费消息之前该队列已经存在。
在 AMQP 1.0 中,消费者必须通过调用 Accept(或 Discard / Requeue)来处理(settle)每一条消息。在这里,我们在打印消息后调用 delivery.Accept(ctx)。
总而言之
为您的项目创建一个 go.mod 文件:
module rabbitmq-tutorials
go 1.21
require github.com/rabbitmq/rabbitmq-amqp-go-client v0.7.0
然后编译并运行示例。在一个终端中,运行消费者:
go run receive.go
然后运行发布者:
go run send.go
消费者将打印从 RabbitMQ 收到的消息。消费者将持续运行,等待消息(使用 Ctrl+C 停止它),因此您可以尝试从另一个终端运行发布者。
列出队列
您可能希望查看 RabbitMQ 有哪些队列以及其中有多少消息。您可以使用
rabbitmqctl工具(作为特权用户)来完成此操作。sudo rabbitmqctl list_queues在 Windows 上,省略 sudo。
rabbitmqctl.bat list_queues
现在进入 第 2 部分,构建一个简单的工作队列。