README

这个库是AMQP 0-9-1协议的纯PHP实现。[链接](https://rabbitmq.cn/tutorials/amqp-concepts.html)。它已经通过了RabbitMQ的测试。

这个库被用于RabbitMQ in Action和官方RabbitMQ教程的PHP示例。

请注意，此项目采用[贡献者行为准则](https://github.com/vrnvgasu/php-amqplib/blob/HEAD/CODE_OF_CONDUCT.md)。通过参与此项目，您同意遵守其条款。

项目维护者

感谢videlalvaro和postalservice14为维护php-amqplib所付出的辛勤努力！没有他们，这个库不会达到现在的水平。

现在，该软件包由nubeiro和一些在RabbitMQ和相关项目上工作的Pivotal工程师维护。

支持的RabbitMQ版本

从版本2.0开始，这个库默认使用AMQP 0.9.1，因此需要RabbitMQ 2.0或更高版本。通常服务器升级不需要修改任何应用程序代码，因为协议变化非常少，但请在升级前自行测试。

支持的RabbitMQ扩展

由于这个库使用了AMQP 0.9.1，我们添加了对以下RabbitMQ扩展的支持

Exchange到Exchange绑定
Basic Nack
发布者确认
消费者取消通知

修改现有方法（如alternate exchanges）的扩展也得到支持。

设置

确保您已安装composer，然后运行以下命令

$ composer require php-amqplib/php-amqplib

这将获取库及其依赖项，并将其放在您的vendor文件夹中。然后，您可以将以下内容添加到您的.php文件中以使用该库

require_once __DIR__.'/vendor/autoload.php';

然后您需要使用相关的类，例如

use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;

用法

当RabbitMQ运行时，打开两个终端，在第一个终端中执行以下命令以启动消费者

$ cd php-amqplib/demo
$ php amqp_consumer.php

然后在另一个终端中执行以下操作

$ cd php-amqplib/demo
$ php amqp_publisher.php some text to publish

您应该在另一个终端上的进程中看到消息到达

然后要停止消费者，向其发送quit消息

$ php amqp_publisher.php quit

如果您需要监听连接到RabbitMQ所使用的套接字，请查看非阻塞消费者的示例。

$ php amqp_consumer_non_blocking.php

变更日志

请参阅CHANGELOG以获取更多关于最近更改的信息。

API 文档

http://php-amqplib.github.io/php-amqplib/

教程

为了避免重复，如果您想了解更多关于这个库的信息，请参阅官方 RabbitMQ 教程。

多个主机连接

如果您有一个应用程序可以连接的多节点集群，您可以使用一个主机数组来启动连接。为此，您应使用 create_connection 静态方法。

例如

$connection = AMQPStreamConnection::create_connection([
    ['host' => HOST1, 'port' => PORT, 'user' => USER, 'password' => PASS, 'vhost' => VHOST],
    ['host' => HOST2, 'port' => PORT, 'user' => USER, 'password' => PASS, 'vhost' => VHOST]
],
$options);

此代码将首先尝试连接到 HOST1，如果第一次连接失败，则连接到 HOST2。该方法返回第一个成功连接的连接对象。如果所有连接都失败，它将抛出最后一次连接尝试的异常。

请参阅 demo/amqp_connect_multiple_hosts.php 以获取更多示例。

批量发布

假设您有一个生成大量消息的过程，这些消息将要使用相同的 exchange 和相同的 routing_key 以及如 mandatory 等选项进行发布。然后您可以使用 batch_basic_publish 库功能。您可以像这样批量消息

$msg = new AMQPMessage($msg_body);
$ch->batch_basic_publish($msg, $exchange);

$msg2 = new AMQPMessage($msg_body);
$ch->batch_basic_publish($msg2, $exchange);

然后像这样发送批次

$ch->publish_batch();

我们何时发布消息批次？

假设我们的程序需要从文件中读取并逐行发布一条消息。根据消息大小，您将不得不决定何时发送批次。您可以选择每 50 条消息发送一次，或者每 100 条。这取决于您。

优化消息发布

另一种加快消息发布速度的方法是重用 AMQPMessage 消息实例。您可以创建新消息如下

$properties = array('content_type' => 'text/plain', 'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT);
$msg = new AMQPMessage($body, $properties);
$ch->basic_publish($msg, $exchange);

现在假设您想更改未来消息的消息主体，但将保留相同的属性，即您的消息仍然是 text/plain，并且 delivery_mode 仍然是 AMQPMessage::DELIVERY_MODE_PERSISTENT。如果您为每条发布的消息创建一个新的 AMQPMessage 实例，那么这些属性将不得不重新编码在 AMQP 二进制格式中。您可以通过重用 AMQPMessage 并按如下方式重置消息主体来避免所有这些

$msg->setBody($body2);
$ch->basic_publish($msg, $exchange);

截断大型消息

AMQP 对消息的大小没有限制；如果消费者接收到一个非常大的消息，PHP 的内存限制可能在 basic_consume 调用的回调之前在库中达到。

为了避免这种情况，您可以在您的 Channel 实例上调用方法 AMQPChannel::setBodySizeLimit(int $bytes)。超过此限制的消息体将被截断，并带有 AMQPMessage::$is_truncated 标志设置为 true 传递给您的回调。属性 AMQPMessage::$body_size 将反映接收到的消息的真实主体大小，如果消息被截断，它将高于 strlen(AMQPMessage::getBody())。

请注意，所有超过限制的数据都是从AMQP通道读取并立即丢弃的，因此无法在回调函数中检索它。如果您有另一个可以处理较大负载的消息的消费者，可以使用basic_reject或basic_nack来通知服务器（服务器仍然有一个完整的副本）将其转发到死信交换机。

默认情况下，不会发生截断。要在已启用截断的通道上禁用截断，请将0（或null）传递给AMQPChannel::setBodySizeLimit()。

连接恢复

一些RabbitMQ客户端使用自动连接恢复机制来重新连接并恢复网络错误情况下的通道和消费者。

由于此客户端使用单线程，您可以使用异常处理机制来设置连接恢复。

可能抛出的连接错误异常

PhpAmqpLib\Exception\AMQPConnectionClosedException
PhpAmqpLib\Exception\AMQPIOException
\RuntimeException
\ErrorException

可能会抛出其他异常，但连接仍然存在。在重新连接之前处理异常时清理旧连接总是一个好主意。

例如，如果您想设置一个恢复的连接

$connection = null;
$channel = null;
while(true){
    try {
        $connection = new AMQPStreamConnection(HOST, PORT, USER, PASS, VHOST);
        // Your application code goes here.
        do_something_with_connection($connection);
    } catch(AMQPRuntimeException $e) {
        echo $e->getMessage();
        cleanup_connection($connection);
        usleep(WAIT_BEFORE_RECONNECT_uS);
    } catch(\RuntimeException $e) {
        cleanup_connection($connection);
        usleep(WAIT_BEFORE_RECONNECT_uS);
    } catch(\ErrorException $e) {
        cleanup_connection($connection);
        usleep(WAIT_BEFORE_RECONNECT_uS);
    }
}

完整的示例在demo/connection_recovery_consume.php中。

每当发生异常时，此代码都会重新连接并重新尝试应用程序代码。某些异常仍可能抛出，不应作为重新连接过程的一部分进行处理，因为它们可能是应用程序错误。

这种方法主要适用于消费者应用程序，生产者将需要一些额外的应用程序代码来避免多次发布相同的信息。

这是一个最简单的示例，在实际应用程序中，您可能希望控制重试次数并可能优雅地降低重新连接的等待时间。

您可以在#444中找到更详细的示例。

UNIX信号

如果您已安装PCNTL扩展，则当消费者未处理消息时将处理信号的分派。

$pcntlHandler = function ($signal) {
    switch ($signal) {
        case \SIGTERM:
        case \SIGUSR1:
        case \SIGINT:
            // some stuff before stop consumer e.g. delete lock etc
            pcntl_signal($signal, SIG_DFL); // restore handler
            posix_kill(posix_getpid(), $signal); // kill self with signal, see https://www.cons.org/cracauer/sigint.html
        case \SIGHUP:
            // some stuff to restart consumer
            break;
        default:
            // do nothing
    }
};

pcntl_signal(\SIGTERM, $pcntlHandler);
pcntl_signal(\SIGINT,  $pcntlHandler);
pcntl_signal(\SIGUSR1, $pcntlHandler);
pcntl_signal(\SIGHUP,  $pcntlHandler);

要禁用此功能，请将常量AMQP_WITHOUT_SIGNALS定义为true。

<?php
define('AMQP_WITHOUT_SIGNALS', true);

... more code

调试

如果您想了解协议级别发生了什么，请将以下常量添加到您的代码中

<?php
define('AMQP_DEBUG', true);

... more code

?>

基准测试

要运行发布/消费基准测试，请输入以下内容

$ make benchmark

测试

要成功运行测试，您首先需要在本地运行一个RabbitMQ代理。然后，像这样运行测试

$ make test

贡献

有关详细信息，请参阅CONTRIBUTING。

使用AMQP 0.8

如果您仍然想使用旧版本的协议，则可以在配置代码中设置以下常量

define('AMQP_PROTOCOL', '0.8');

默认值为'0.9.1'。

提供自己的自动加载器

如果您出于某种原因不想使用composer，则需要为库类提供一个自动加载器。有人报告使用此自动加载器成功。

原始README

以下是原始README文件的内容。归功于原始作者。

PHP库实现高级消息队列协议（AMQP）。

此库是py-amqplib http://barryp.org/software/py-amqplib/的Python代码的移植。

它已与RabbitMQ服务器进行了测试。

项目主页：http://code.google.com/p/php-amqplib/

有关讨论，请加入该小组

http://groups.google.com/group/php-amqplib-devel

有关错误报告，请使用项目页面上的错误跟踪系统。

欢迎提交补丁！

作者：Vadim Zaliva lord@crocodile.org

vrnvgasu / php-amqplib

维护者

详细信息