RabbitMQ 教程 - "Hello World!"
简介
先决条件
本教程假设 RabbitMQ 已 安装 并在 localhost 上的 标准端口 (5672) 上运行。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
哪里寻求帮助
如果您在学习本教程时遇到困难,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
RabbitMQ 是一个消息代理:它接收并转发消息。你可以把它想象成一个邮局:当你把想要寄出的邮件放进邮箱时,你可以确信邮递员最终会将邮件送到你的收件人手中。在这个比喻中,RabbitMQ 就是邮箱、邮局和邮递员。
RabbitMQ 和邮局的主要区别在于,它不处理纸张,而是接收、存储和转发数据的二进制数据块——消息。
RabbitMQ 和消息传递通常会使用一些行话。
-
发布 (Producing) 仅仅意味着发送。发送消息的程序就是生产者 (producer)。
-
队列 是 RabbitMQ 中邮箱的名称。虽然消息在 RabbitMQ 和你的应用程序之间流动,但它们只能存储在队列 中。队列 的大小仅受主机内存和磁盘空间的限制,它本质上是一个大的消息缓冲区。
许多生产者 可以发送消息到同一个队列,许多消费者 可以尝试从同一个队列 接收数据。
这就是我们表示队列的方式
-
消费 的含义与接收类似。消费者 是一个主要等待接收消息的程序。
请注意,生产者、消费者和代理不一定需要驻留在同一台主机上;事实上,在大多数应用程序中它们都不会。一个应用程序也可以同时是生产者和消费者。
"Hello World"
(使用 Go RabbitMQ 客户端)
在本教程的这一部分,我们将用 Go 编写两个小程序:一个生产者,发送一条消息;一个消费者,接收消息并打印出来。我们会省略 Go RabbitMQ API 中一些细节,主要关注这个非常简单的入门操作。这是消息传递的“Hello World”。
在下面的图表中,“P”是我们的生产者,“C”是我们的消费者。中间的框是一个队列——RabbitMQ 代表消费者存储的消息缓冲区。
Go RabbitMQ 客户端库
RabbitMQ 支持多种协议。本教程使用 AMQP 0-9-1,这是一种开放的、通用的消息传递协议。在 许多不同的语言 中都有 RabbitMQ 的客户端。本教程将使用 Go amqp 客户端。
首先,使用
go get安装 amqpgo mod init <your-module-name>
go get github.com/rabbitmq/amqp091-go
现在我们已经安装了 amqp,就可以开始编写代码了。
发送
我们将把消息发布者(发送者)命名为 send.go,将消息消费者命名为 receive.go。发布者将连接到 RabbitMQ,发送一条消息,然后退出。
在 send.go 中,我们首先需要导入库
package main
import (
"context"
"log"
"time"
amqp "github.com/rabbitmq/amqp091-go"
)
我们还需要一个辅助函数来检查每个 amqp 调用的返回值
func failOnError(err error, msg string) {
if err != nil {
log.Panicf("%s: %s", msg, err)
}
}
然后创建 main 函数并连接到 RabbitMQ 服务器
func main() {
conn, err := amqp.Dial("amqp://guest:guest@localhost:5672/")
failOnError(err, "Failed to connect to RabbitMQ")
defer conn.Close()
}
连接抽象了套接字连接,并为我们处理协议版本协商、身份验证等。接下来我们创建一个 channel,这是我们完成大部分任务 API 的地方。
ch, err := conn.Channel()
failOnError(err, "Failed to open a channel")
defer ch.Close()
为了发送,我们必须声明一个要发送到的队列;然后我们可以将消息发布到该队列。
q, err := ch.QueueDeclare(
"hello", // name
false, // durable
false, // delete when unused
false, // exclusive
false, // no-wait
nil, // arguments
)
failOnError(err, "Failed to declare a queue")
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
body := "Hello World!"
err = ch.PublishWithContext(ctx,
"", // exchange
q.Name, // routing key
false, // mandatory
false, // immediate
amqp.Publishing {
ContentType: "text/plain",
Body: []byte(body),
})
failOnError(err, "Failed to publish a message")
log.Printf(" [x] Sent %s\n", body)
声明队列是幂等的——只有在队列不存在时才会创建。消息内容是字节数组,因此您可以对其进行任意编码。
发送不起作用!
如果这是您第一次使用 RabbitMQ,但没有看到“Sent”消息,您可能会感到困惑,不知道哪里出了问题。也许代理启动时磁盘空间不足(默认需要至少 50 MB 可用空间),因此拒绝接收消息。检查代理的日志文件,看看是否有资源警报已记录,并在必要时降低可用磁盘空间阈值。配置指南将展示如何设置
disk_free_limit。
接收
我们的发布者就到这里了。我们的消费者会监听来自 RabbitMQ 的消息,所以与只发布一条消息的发布者不同,我们将保持消费者的运行状态,监听并打印消息。
代码(在 receive.go 中)与 send 具有相同的导入和辅助函数
package main
import (
"log"
amqp "github.com/rabbitmq/amqp091-go"
)
func failOnError(err error, msg string) {
if err != nil {
log.Panicf("%s: %s", msg, err)
}
}
为消费者应用创建一个新目录,例如 `receiver/receive.go`,以避免重复声明。
设置与发布者相同;我们打开一个连接和一个通道,并声明我们将要消费的队列。注意这与 send 发布到的队列相匹配。
conn, err := amqp.Dial("amqp://guest:guest@localhost:5672/")
failOnError(err, "Failed to connect to RabbitMQ")
defer conn.Close()
ch, err := conn.Channel()
failOnError(err, "Failed to open a channel")
defer ch.Close()
q, err := ch.QueueDeclare(
"hello", // name
false, // durable
false, // delete when unused
false, // exclusive
false, // no-wait
nil, // arguments
)
failOnError(err, "Failed to declare a queue")
请注意,我们在这里也声明了队列。因为我们可能在发布者之前启动消费者,所以我们希望确保在尝试从队列中消费消息之前,队列已经存在。
我们将告诉服务器将队列中的消息推送给我们。由于它会异步地推送消息,我们将在一个 goroutine 中从 amqp::Consume 返回的 channel 中读取消息。
msgs, err := ch.Consume(
q.Name, // queue
"", // consumer
true, // auto-ack
false, // exclusive
false, // no-local
false, // no-wait
nil, // args
)
failOnError(err, "Failed to register a consumer")
var forever chan struct{}
go func() {
for d := range msgs {
log.Printf("Received a message: %s", d.Body)
}
}()
log.Printf(" [*] Waiting for messages. To exit press CTRL+C")
<-forever
总而言之
现在我们可以运行这两个脚本了。在终端中,运行发布者
go run send.go
然后,运行消费者
go run receive.go
消费者将打印出它通过 RabbitMQ 从发布者那里收到的消息。消费者将继续运行,等待消息(按 Ctrl-C 停止它),所以尝试从另一个终端运行发布者。
如果你想检查队列,可以尝试使用 rabbitmqctl list_queues。
是时候继续学习 第二部分,构建一个简单的工作队列(work queue)了。