跳到主要内容

RabbitMQ 教程 - “Hello World!”

介绍

信息

先决条件

本教程假定 RabbitMQ 已安装并在 localhost 上运行,端口为标准端口(5672)。如果您使用不同的主机、端口或凭据,则连接设置需要调整。

哪里可以获取帮助

如果您在完成本教程时遇到问题,可以通过GitHub 讨论RabbitMQ 社区 Discord联系我们。

RabbitMQ 是一个消息代理:它接收和转发消息。您可以把它想象成一个邮局:当您将要寄出的邮件放入邮箱时,您可以确信信使最终会将邮件送到收件人手中。在这个比喻中,RabbitMQ 就是邮箱、邮局和信使。

RabbitMQ 与邮局的主要区别在于它不处理纸张,而是接收、存储和转发二进制数据块 ‒ 消息

RabbitMQ,以及一般意义上的消息传递,使用了一些专业术语。

  • 生产意味着发送。发送消息的程序称为生产者

  • 队列是 RabbitMQ 中邮箱的名称。虽然消息会流经 RabbitMQ 和您的应用程序,但它们只能存储在队列中。队列仅受主机内存和磁盘限制的约束,本质上是一个大型消息缓冲区。

    许多生产者可以发送消息到同一个队列,并且许多消费者可以尝试从同一个队列接收数据。

    以下是队列的表示方式

  • 消费与接收含义类似。消费者是一个主要等待接收消息的程序

请注意,生产者、消费者和代理不必驻留在同一台主机上;事实上,在大多数应用程序中,它们都不会驻留在同一台主机上。应用程序也可以同时是生产者和消费者。

“Hello World”

(使用 Java 客户端)

在本教程的这一部分中,我们将用 Java 编写两个程序;一个发送单个消息的生产者,以及一个接收消息并打印出来的消费者。我们将略过 Java API 中的一些细节,专注于这个非常简单的事情,只是为了开始。这是消息传递的“Hello World”。

在下图中,“P” 是我们的生产者,“C” 是我们的消费者。中间的方框是一个队列 ‒ 一个 RabbitMQ 代表消费者保留的消息缓冲区。

Java 客户端库

RabbitMQ 支持多种协议。本教程使用 AMQP 0-9-1,这是一个用于消息传递的开放式通用协议。RabbitMQ 在许多不同的语言中都有许多客户端。我们将使用 RabbitMQ 提供的 Java 客户端。

下载客户端库及其依赖项 (SLF4J APISLF4J 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;

设置类并命名队列

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 地址即可。

接下来,我们创建一个通道,这是大多数 API 执行操作的地方。请注意,我们可以使用 try-with-resources 语句,因为 ConnectionChannel 都实现了 java.lang.AutoCloseable。这样,我们就不需要在代码中显式关闭它们。

为了发送,我们必须声明一个队列供我们发送;然后我们可以将消息发布到队列,所有这些都在 try-with-resources 语句中进行

channel.queueDeclare(QUEUE_NAME, false, false, false, null);
String message = "Hello World!";
channel.basicPublish("", QUEUE_NAME, null, message.getBytes());
System.out.println(" [x] Sent '" + message + "'");

声明队列是幂等的 ‒ 只有在队列不存在时才会创建它。消息内容是一个字节数组,因此您可以对其中编码任何内容。

以下是完整的 Send.java 类.

发送不起作用!

如果您是第一次使用 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;

我们将使用的额外 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();

channel.queueDeclare(QUEUE_NAME, false, false, false, null);
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 -> { });

以下是完整的 Recv.java 类.

将所有内容整合在一起

您可以仅使用 RabbitMQ java 客户端作为类路径来编译这两个文件

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 部分并构建一个简单的工作队列了。

提示

为了节省输入,您可以为类路径设置一个环境变量,例如

export CP=.:amqp-client-5.16.0.jar:slf4j-api-1.7.36.jar:slf4j-simple-1.7.36.jar
java -cp $CP Send

或者在 Windows 上

set CP=.;amqp-client-5.16.0.jar;slf4j-api-1.7.36.jar;slf4j-simple-1.7.36.jar
java -cp %CP% Send
© 2024 RabbitMQ. All rights reserved.