RabbitMQ 教程 - “你好世界!”
简介
先决条件
本教程假设您已安装 RabbitMQ 并在 localhost
上运行,端口为标准端口 (5672)。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
在哪里获取帮助
如果您在学习本教程时遇到问题,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
RabbitMQ 是一个消息代理:它接收并转发消息。您可以将其视为邮局:当您将要邮寄的邮件放入邮箱时,您可以确信邮递员最终会将邮件投递给您的收件人。在这个类比中,RabbitMQ 是一个邮箱、一个邮局和一个邮递员。
RabbitMQ 和邮局之间的主要区别在于它不处理纸张,而是接受、存储和转发二进制数据块 —— 消息。
RabbitMQ 以及消息传递通常使用一些术语。
-
生产 仅仅意味着发送。发送消息的程序是生产者
-
队列 是 RabbitMQ 中邮箱的名称。尽管消息流经 RabbitMQ 和您的应用程序,但它们只能存储在队列内部。队列 仅受主机内存和磁盘限制的约束,它本质上是一个大型消息缓冲区。
许多生产者 可以发送消息到一个队列,而许多消费者 可以尝试从一个队列接收数据。
这是我们表示队列的方式
-
消费 与接收具有相似的含义。消费者 是一个主要等待接收消息的程序
请注意,生产者、消费者和代理不必驻留在同一主机上;实际上,在大多数应用程序中它们都不是。一个应用程序也可以同时是生产者和消费者。
你好世界!
(使用 Pika Python 客户端)
在本教程的这一部分,我们将用 Python 编写两个小程序;一个生产者(发送者),它发送一条消息,和一个消费者(接收者),它接收消息并打印出来。这是消息传递的 “你好世界”。
在下面的图中,“P” 是我们的生产者,“C” 是我们的消费者。中间的框是一个队列 —— RabbitMQ 代表消费者维护的消息缓冲区。
我们的总体设计将如下所示
生产者将消息发送到 “hello” 队列。消费者从该队列接收消息。
RabbitMQ 库
RabbitMQ 支持多种协议。本教程使用 AMQP 0-9-1,这是一种开放的、通用的消息传递协议。在许多不同的语言中,都有许多 RabbitMQ 的客户端。在本教程系列中,我们将使用 Pika 1.0.0,它是 RabbitMQ 团队推荐的 Python 客户端。要安装它,您可以使用
pip
包管理工具python -m pip install pika --upgrade
现在我们已经安装了 Pika,我们可以编写一些代码了。
发送
我们的第一个程序 send.py
将向队列发送一条消息。我们需要做的第一件事是建立与 RabbitMQ 服务器的连接。
#!/usr/bin/env python
import pika
connection = pika.BlockingConnection(pika.ConnectionParameters('localhost'))
channel = connection.channel()
我们现在已连接到本地计算机上的代理 —— 因此是 localhost。如果我们想连接到另一台计算机上的代理,我们只需在此处指定其名称或 IP 地址。
接下来,在发送之前,我们需要确保接收队列存在。如果我们向不存在的位置发送消息,RabbitMQ 将直接丢弃该消息。让我们创建一个 hello 队列,消息将被传递到该队列
channel.queue_declare(queue='hello')
此时,我们准备好发送消息了。我们的第一条消息将只包含字符串 Hello World!,我们想将其发送到我们的 hello 队列。
在 RabbitMQ 中,消息永远不能直接发送到队列,它始终需要通过交换机。但我们先不要被细节困扰 —— 您可以在本教程的第三部分中阅读有关交换机的更多信息。我们现在需要知道的是如何使用由空字符串标识的默认交换机。此交换机是特殊的 —— 它允许我们精确指定消息应发送到哪个队列。队列名称需要在 routing_key
参数中指定
channel.basic_publish(exchange='',
routing_key='hello',
body='Hello World!')
print(" [x] Sent 'Hello World!'")
在退出程序之前,我们需要确保网络缓冲区已刷新,并且我们的消息已实际传递到 RabbitMQ。我们可以通过轻轻关闭连接来做到这一点。
connection.close()
发送不起作用!
如果这是您第一次使用 RabbitMQ,并且您没有看到 “Sent” 消息,那么您可能会挠头想知道哪里可能出错了。可能是代理启动时没有足够的可用磁盘空间(默认情况下至少需要 50 MB 可用空间),因此拒绝接受消息。检查代理日志文件,查看是否记录了资源警报,并在必要时降低可用磁盘空间阈值。配置指南将向您展示如何设置
disk_free_limit
。
接收
我们的第二个程序 receive.py
将从队列接收消息并在屏幕上打印它们。
同样,首先我们需要连接到 RabbitMQ 服务器。负责连接到 Rabbit 的代码与之前相同。
下一步,就像之前一样,是确保队列存在。使用 queue_declare
创建队列是幂等的 —— 我们可以根据需要多次运行该命令,并且只会创建一个队列。
channel.queue_declare(queue='hello')
您可能会问,为什么我们要再次声明队列 —— 我们已经在之前的代码中声明了它。如果我们确定队列已经存在,我们可以避免这样做。例如,如果 send.py
程序之前已经运行过。但我们还不确定先运行哪个程序。在这种情况下,在两个程序中重复声明队列是一个好习惯。
列出队列
您可能希望查看 RabbitMQ 有哪些队列以及其中有多少消息。您可以使用
rabbitmqctl
工具(以特权用户身份)来执行此操作sudo rabbitmqctl list_queues
在 Windows 上,省略 sudo
rabbitmqctl.bat list_queues
从队列接收消息更加复杂。它的工作原理是将 callback
函数订阅到一个队列。每当我们收到消息时,Pika 库都会调用此 callback
函数。在我们的例子中,此函数将在屏幕上打印消息的内容。
def callback(ch, method, properties, body):
print(f" [x] Received {body}")
接下来,我们需要告诉 RabbitMQ,这个特定的回调函数应该从我们的 hello 队列接收消息
channel.basic_consume(queue='hello',
auto_ack=True,
on_message_callback=callback)
为了使该命令成功,我们必须确保我们要订阅的队列存在。幸运的是,我们对此充满信心 —— 我们已经在上面使用 queue_declare
创建了一个队列。
auto_ack
参数将在稍后描述。
最后,我们进入一个永无止境的循环,该循环等待数据并在必要时运行回调,并在程序关闭期间捕获 KeyboardInterrupt
。
print(' [*] Waiting for messages. To exit press CTRL+C')
channel.start_consuming()
if __name__ == '__main__':
try:
main()
except KeyboardInterrupt:
print('Interrupted')
try:
sys.exit(0)
except SystemExit:
os._exit(0)
将它们放在一起
send.py
(源代码)
#!/usr/bin/env python
import pika
connection = pika.BlockingConnection(
pika.ConnectionParameters(host='localhost'))
channel = connection.channel()
channel.queue_declare(queue='hello')
channel.basic_publish(exchange='', routing_key='hello', body='Hello World!')
print(" [x] Sent 'Hello World!'")
connection.close()
receive.py
(源代码)
#!/usr/bin/env python
import pika, sys, os
def main():
connection = pika.BlockingConnection(pika.ConnectionParameters(host='localhost'))
channel = connection.channel()
channel.queue_declare(queue='hello')
def callback(ch, method, properties, body):
print(f" [x] Received {body}")
channel.basic_consume(queue='hello', on_message_callback=callback, auto_ack=True)
print(' [*] Waiting for messages. To exit press CTRL+C')
channel.start_consuming()
if __name__ == '__main__':
try:
main()
except KeyboardInterrupt:
print('Interrupted')
try:
sys.exit(0)
except SystemExit:
os._exit(0)
现在我们可以在终端中试用我们的程序了。首先,让我们启动一个消费者,它将持续运行并等待传递
python receive.py
# => [*] Waiting for messages. To exit press CTRL+C
现在在新终端中启动生产者。生产者程序将在每次运行后停止
python send.py
# => [x] Sent 'Hello World!'
消费者将打印消息
# => [*] Waiting for messages. To exit press CTRL+C
# => [x] Received 'Hello World!'
太棒了!我们已经能够通过 RabbitMQ 发送我们的第一条消息。您可能已经注意到,receive.py
程序不会退出。它将保持准备好接收更多消息,并且可以使用 Ctrl-C 中断。
尝试在新终端中再次运行 send.py
。
我们已经学习了如何从命名队列发送和接收消息。现在是时候继续学习第 2 部分并构建一个简单的工作队列了。