RabbitMQ 教程

RabbitMQ示例“Hello World”

前面章节介绍了 RabbitMQ 的基础知识,这里我们将通过一个“Hello World”示例来了解怎样使用 RabbitMQ。

RabbitMQ 是一个消息代理:它接受和转发消息。您可以将其视为邮局:当您将要邮寄的邮件放入邮箱时,您可以确定邮递员最终会将邮件递送给您的收件人。在这个类比中,RabbitMQ 是一个邮箱、一个邮局和一个邮递员。

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

下面是 RabbitMQ 和一般的消息传递使用一些专业术语:

  • 生产者:生产无非就是发送,发送消息的程序是生产者。用下图表示:

  • 队列:队列是位于 RabbitMQ 中的邮箱的名称。尽管消息流经 RabbitMQ 和您的应用程序,但它们只能存储在队列中。 队列仅受主机的内存和磁盘限制,它本质上是一个大的消息缓冲区。许多生产者可以发送到一个队列的消息,许多消费者可以尝试从一个队列接收数据。下图是我们表示队列的方式:

  • 消费者:消费与接收具有相似的含义,消费者是一个主要等待接收消息的程序。用下图表示:

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

Hello World!

在本教程的这一部分,我们将用 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 客户端及其依赖项,我们可以编写一些代码。

发送(Sending)

我们将调用我们的消息发布者(发送者)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()) {
     
}

Connection 抽象了套接字连接,并为我们处理协议版本协商和认证等。在这里,我们连接到本地机器上的 RabbitMQ 节点 —— 因此是 localhost。如果我们想连接到另一台机器上的节点,我们只需在此处指定其主机名或 IP 地址。

接下来我们创建一个通道(Channel),这是完成任务的大部分 API 所在的位置。请注意,我们可以使用 try-with-resources 语句,因为 Connection 和 Channel 都实现了 java.io.Closeable。 这样我们就不需要在代码中显式地关闭它们。

要发送,我们必须声明一个队列供我们发送;然后我们可以将消息发布到队列中,所有这些都在 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 + "'");

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

发送失败

如果这是您第一次使用 RabbitMQ 并且您没有看到“已发送”消息,那么您可能会摸不着头脑,想知道可能出了什么问题。 也许代理启动时没有足够的可用磁盘空间(默认情况下它需要至少 200 MB 可用空间),因此拒绝接受消息。检查代理日志文件以确认并在必要时减少限制。配置文件文档将向您展示如何设置 disk_free_limit。

接收(Receiving)

我们的消费者监听来自 RabbitMQ 的消息,因此与发布单个消息的发布者不同,我们将让消费者继续运行以监听消息并打印出来。

代码(在 Recv.java 中)与 Send 具有几乎相同的导入:

import com.rabbitmq.client.Channel;
import com.rabbitmq.client.Connection;
import com.rabbitmq.client.ConnectionFactory;
import com.rabbitmq.client.DeliverCallback;

我们将使用额外的接口来缓冲服务器推送给我们的消息。

设置与发布者相同; 我们打开一个连接和一个通道,并声明我们将要消费的队列。 请注意,这与发送发布到的队列相匹配。

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 -> { });

把它们放在一起

您可以只使用类路径上的 RabbitMQ java 客户端来编译这两者:

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

要运行它们,您需要 rabbitmq-client.jar 及其对类路径的依赖项。在终端中,运行消费者(接收者):

java -cp .:amqp-client-5.7.1.jar:slf4j-api-1.7.26.jar:slf4j-simple-1.7.26.jar Recv

然后,运行发布者(发件人):

java -cp .:amqp-client-5.7.1.jar:slf4j-api-1.7.26.jar:slf4j-simple-1.7.26.jar Send

在 Windows 上,使用分号而不是冒号来分隔类路径中的项目。

消费者将通过 RabbitMQ 打印从发布者那里获得的消息。消费者将继续运行,等待消息(使用 Ctrl-C 停止它),因此请尝试从另一个终端运行发布者。

列出队列

您可能希望查看 RabbitMQ 有哪些队列以及其中有多少消息。您可以使用 rabbitmqctl 工具(作为特权用户)执行此操作:

sudo rabbitmqctl list_queues

在 Windows 上,省略 sudo:

rabbitmqctl.bat list_queues

提示

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

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

或在 Windows 上:

set CP=.;amqp-client-5.7.1.jar;slf4j-api-1.7.26.jar;slf4j-simple-1.7.26.jar
java -cp %CP% Send

点击查看 RabbitMQ “Hello World”示例 完整代码。


说说我的看法
全部评论(
没有评论
关于
本网站属于个人的非赢利性网站,转载的文章遵循原作者的版权声明,如果原文没有版权声明,请来信告知:hxstrive@outlook.com
公众号