RabbitMQ 教程 - “Hello World!”
简介
先决条件
本教程假设 RabbitMQ 已安装并在 localhost
上运行,使用标准端口 (5672)。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
在哪里获得帮助
如果您在学习本教程时遇到问题,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
RabbitMQ 是一个消息代理:它接收和转发消息。您可以将其视为邮局:当您将要邮寄的邮件放入邮箱时,您可以确信邮递员最终会将邮件投递给您的收件人。在这个类比中,RabbitMQ 是邮箱、邮局和邮递员。
RabbitMQ 和邮局之间的主要区别在于它不处理纸张,而是接受、存储和转发二进制数据块,即消息。
RabbitMQ 以及一般的消息传递使用一些术语。
-
生产 意味着发送。发送消息的程序是生产者
-
队列 是 RabbitMQ 中邮箱的名称。尽管消息流经 RabbitMQ 和您的应用程序,但它们只能存储在队列 中。队列 仅受主机内存和磁盘限制的约束,它本质上是一个大型消息缓冲区。
许多生产者 可以发送消息到同一个队列,并且许多消费者 可以尝试从同一个队列 接收数据。
这就是我们表示队列的方式
-
消费 与接收具有相似的含义。消费者 是一个主要等待接收消息的程序
请注意,生产者、消费者和 Broker 不必驻留在同一主机上;实际上,在大多数应用程序中,它们都不是。一个应用程序也可以同时是生产者和消费者。
“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()
}
连接抽象了套接字连接,并为我们处理协议版本协商和身份验证等。接下来,我们创建一个通道,这是完成大部分 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”消息,那么您可能会挠头想知道哪里出错了。可能是 Broker 启动时没有足够的可用磁盘空间(默认情况下至少需要 50 MB 可用空间),因此拒绝接受消息。检查 Broker 日志文件 以查看是否记录了资源警报,并在必要时降低可用磁盘空间阈值。配置指南 将向您展示如何设置
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
返回)读取消息。
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
。
现在可以继续学习第 2 部分并构建一个简单的工作队列。