跳到主要内容

RabbitMQ 教程 - “Hello World!”

简介​

信息

先决条件​

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

在哪里获得帮助​

如果您在学习本教程时遇到问题，可以通过 GitHub Discussions 或 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 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;

设置类并命名队列

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 语句，因为 Connection 和 Channel 都实现了 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”消息，那么您可能会挠头想知道哪里出错了。可能是 broker 启动时没有足够的可用磁盘空间（默认情况下至少需要 50 MB 可用空间），因此拒绝接受消息。检查 broker 日志文件以查看是否记录了资源警报，并在必要时降低可用磁盘空间阈值。配置指南将向您展示如何设置 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-resource 语句来自动关闭通道和连接？这样做我们只会让程序继续运行，关闭所有内容，然后退出！这将很尴尬，因为我们希望进程在消费者异步监听消息到达时保持活动状态。

我们即将告诉服务器从队列中向我们传递消息。由于它将异步推送消息给我们，我们以对象的形式提供回调，该对象将缓冲消息，直到我们准备好使用它们。这就是 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 类.

将它们放在一起​

您可以使用 classpath 上的 RabbitMQ java 客户端编译这两个程序

javac -cp amqp-client-5.16.0.jar Send.java Recv.java

要运行它们，您需要在 classpath 上包含 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 上，使用分号而不是冒号来分隔 classpath 中的项目。

消费者将打印出它通过 RabbitMQ 从发布者收到的消息。消费者将保持运行，等待消息（使用 Ctrl-C 停止它），因此尝试从另一个终端运行发布者。

列出队列​

您可能希望查看 RabbitMQ 有哪些队列以及其中有多少消息。您可以使用 rabbitmqctl 工具（以特权用户身份）来完成此操作

sudo rabbitmqctl list_queues

在 Windows 上，省略 sudo

rabbitmqctl.bat list_queues

现在可以继续学习第 2 部分并构建一个简单的工作队列。

提示​

为了节省打字，您可以为 classpath 设置一个环境变量，例如

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
© . All rights reserved.