RabbitMQ 教程 - "Hello World!"
简介
先决条件
本教程假设 RabbitMQ 已 安装 并在 localhost 上的 标准端口 (5672) 上运行。如果您使用不同的主机、端口或凭据,则需要调整连接设置。
哪里寻求帮助
如果您在学习本教程时遇到困难,可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
RabbitMQ 是一个消息代理:它接收并转发消息。你可以把它想象成一个邮局:当你把想要寄出的邮件放进邮箱时,你可以确信邮递员最终会将邮件送到你的收件人手中。在这个比喻中,RabbitMQ 就是邮箱、邮局和邮递员。
RabbitMQ 和邮局的主要区别在于,它不处理纸张,而是接收、存储和转发数据的二进制数据块——消息。
RabbitMQ 和消息传递通常会使用一些行话。
-
生产(Producing)指的就是发送。发送消息的程序被称为生产者(producer)
-
队列 是 RabbitMQ 中邮箱的名称。虽然消息在 RabbitMQ 和你的应用程序之间流动,但它们只能存储在队列 中。队列 的大小仅受主机内存和磁盘空间的限制,它本质上是一个大的消息缓冲区。
许多生产者 可以发送消息到同一个队列,许多消费者 可以尝试从同一个队列 接收数据。
这就是我们表示队列的方式
-
消费 的含义与接收类似。消费者 是一个主要等待接收消息的程序。
请注意,生产者、消费者和代理不一定需要驻留在同一台主机上;事实上,在大多数应用程序中它们都不会。一个应用程序也可以同时是生产者和消费者。
"Hello World"
(使用 Java 客户端)
在本教程的这一部分,我们将用 Java 编写两个程序:一个发送单条消息的生产者,以及一个接收消息并将其打印出来的消费者。我们将略过 Java API 中的一些细节,专注于这个非常简单的事情以便入门。这就是消息传递领域的“Hello World”。
在下面的图表中,“P”是我们的生产者,“C”是我们的消费者。中间的框是一个队列——RabbitMQ 代表消费者存储的消息缓冲区。
Java 客户端库
RabbitMQ 支持多种协议。本教程使用 AMQP 0-9-1,这是一种通用的开源消息传递协议。RabbitMQ 有多种不同语言的客户端。我们将使用 RabbitMQ 提供的 Java 客户端。
下载客户端库及其依赖项(SLF4J API 和 SLF4J Simple)。将这些文件复制到你的工作目录中,并与教程的 Java 文件放在一起。
请注意,SLF4J Simple 足够用于教程,但在生产环境中,你应该使用功能更全的日志库,如 Logback。
(RabbitMQ Java 客户端也在中央 Maven 仓库中,groupId 为
com.rabbitmq,artifactId 为amqp-client。)
现在我们有了 Java 客户端及其依赖项,可以编写一些代码了。
发送
我们将消息发布者(发送方)命名为 Send,将消息消费者(接收方)命名为 Recv。发布者将连接到 RabbitMQ,发送单条消息,然后退出。
在 Send.java 中,我们需要导入一些类
import com.rabbitmq.client.ConnectionFactory;
import com.rabbitmq.client.Connection;
import com.rabbitmq.client.Channel;
import java.util.Map;
设置类并命名队列
public class Send {
private final static String QUEUE_NAME = "hello";
public static void main(String[] argv) throws Exception {
...
}
}
然后,我们可以创建一个到服务器的连接
ConnectionFactory factory = new ConnectionFactory();
factory.setHost("localhost");
try (Connection connection = factory.newConnection();
Channel channel = connection.createChannel()) {
}
连接抽象了套接字连接,并为我们处理了协议版本协商、身份验证等工作。此处我们连接的是本地机器上的 RabbitMQ 节点,因此使用了 localhost。如果我们要连接到另一台机器上的节点,只需在此处指定其主机名或 IP 地址即可。
接下来我们创建一个通道(channel),这是完成大部分 API 操作的地方。请注意,我们可以使用 try-with-resources 语句,因为 Connection 和 Channel 都实现了 java.lang.AutoCloseable。这样我们就不需要在代码中显式关闭它们了。
为了发送消息,我们必须声明一个目标队列;然后我们就可以将消息发布到该队列,这一切都在 try-with-resources 语句中完成
Map<String, Object> args = Map.of("x-queue-type", "quorum");
channel.queueDeclare(QUEUE_NAME, true, false, false, args);
String message = "Hello World!";
channel.basicPublish("", QUEUE_NAME, null, message.getBytes());
System.out.println(" [x] Sent '" + message + "'");
声明队列是幂等的——只有在队列不存在时才会创建。消息内容是字节数组,因此您可以对其进行任意编码。
发送不起作用!
如果这是您第一次使用 RabbitMQ,但没有看到“Sent”消息,您可能会感到困惑,不知道哪里出了问题。也许代理启动时磁盘空间不足(默认需要至少 50 MB 可用空间),因此拒绝接收消息。检查代理的日志文件,看看是否有资源警报已记录,并在必要时降低可用磁盘空间阈值。配置指南将展示如何设置
disk_free_limit。
接收
我们的发布者就到这里了。我们的消费者会监听来自 RabbitMQ 的消息,所以与只发布一条消息的发布者不同,我们将保持消费者的运行状态,监听并打印消息。
该代码(在 Recv.java 中)的导入项与 Send 几乎相同
import com.rabbitmq.client.Channel;
import com.rabbitmq.client.Connection;
import com.rabbitmq.client.ConnectionFactory;
import com.rabbitmq.client.DeliverCallback;
import java.util.Map;
我们还将使用额外的 DeliverCallback 接口来缓存服务器推送给我们的消息。
设置与发布者相同;我们打开一个连接和一个通道,并声明我们将要消费的队列。注意这与 send 发布到的队列相匹配。
public class Recv {
private final static String QUEUE_NAME = "hello";
public static void main(String[] argv) throws Exception {
ConnectionFactory factory = new ConnectionFactory();
factory.setHost("localhost");
Connection connection = factory.newConnection();
Channel channel = connection.createChannel();
Map<String, Object> args = Map.of("x-queue-type", "quorum");
channel.queueDeclare(QUEUE_NAME, true, false, false, args);
System.out.println(" [*] Waiting for messages. To exit press CTRL+C");
}
}
请注意,我们在这里也声明了队列。因为我们可能在发布者之前启动消费者,所以我们希望确保在尝试从队列中消费消息之前,队列已经存在。
为什么我们不使用 try-with-resources 语句来自动关闭通道和连接呢?那样做的话,程序就会直接运行完毕、关闭所有内容并退出!这会很麻烦,因为我们需要进程在消费者异步监听消息到达时保持活跃。
我们即将告诉服务器从队列中向我们发送消息。由于它是异步推送消息的,我们提供了一个对象形式的回调函数,它会缓存消息直到我们准备好处理它们。这就是 DeliverCallback 子类所做的事情。
DeliverCallback deliverCallback = (consumerTag, delivery) -> {
String message = new String(delivery.getBody(), "UTF-8");
System.out.println(" [x] Received '" + message + "'");
};
channel.basicConsume(QUEUE_NAME, true, deliverCallback, consumerTag -> { });
总而言之
只需将 RabbitMQ Java 客户端添加到类路径(classpath)中,即可编译这两个文件
javac -cp amqp-client-5.16.0.jar Send.java Recv.java
要运行它们,你需要将 rabbitmq-client.jar 及其依赖项添加到类路径中。在终端中运行消费者(接收方)
java -cp .:amqp-client-5.16.0.jar:slf4j-api-1.7.36.jar:slf4j-simple-1.7.36.jar Recv
然后,运行发布者(发送者):
java -cp .:amqp-client-5.16.0.jar:slf4j-api-1.7.36.jar:slf4j-simple-1.7.36.jar Send
在 Windows 上,请使用分号而不是冒号来分隔类路径中的项目。
消费者将打印出它通过 RabbitMQ 从发布者那里收到的消息。消费者将继续运行,等待消息(按 Ctrl-C 停止它),所以尝试从另一个终端运行发布者。
列出队列
您可能希望查看 RabbitMQ 有哪些队列以及其中有多少消息。您可以使用
rabbitmqctl工具(作为特权用户)来完成此操作。sudo rabbitmqctl list_queues在 Windows 上,省略 sudo。
rabbitmqctl.bat list_queues
是时候进入第 2 部分并构建一个简单的工作队列(work queue)了。
提示
为了减少输入,你可以为类路径设置一个环境变量,例如
export CP=.:amqp-client-5.16.0.jar:slf4j-api-1.7.36.jar:slf4j-simple-1.7.36.jarjava -cp $CP Send或者在 Windows 上
set CP=.;amqp-client-5.16.0.jar;slf4j-api-1.7.36.jar;slf4j-simple-1.7.36.jarjava -cp %CP% Send