README

这个库是AMQP 0-9-1协议的纯PHP实现。它已通过RabbitMQ进行测试。

要求：PHP 5.3 由于使用了命名空间。

要求：bcmath和mbstring扩展 该库利用bcmath和mbstring PHP扩展。安装步骤因PHP版本和底层操作系统而异。以下示例展示了如何在Ubuntu 15.10上添加到现有的PHP安装

sudo apt-get install php7.0-mbstring
sudo apt-get install php7.0-bcmath

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

请注意，该项目遵循贡献者行为准则。通过参与此项目，您同意遵守其条款。

项目维护者

感谢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绑定
基本Nack
发布者确认
消费者取消通知

修改现有方法（如备用交换）的扩展也得到支持。

设置

确保您已安装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以获取有关最近更改的更多信息。

教程

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

批量发布

假设您有一个生成大量消息的过程，这些消息将被用于使用相同的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 Channel中读取并立即丢弃，因此无法在回调中检索。如果您有另一个可以处理具有更大有效负载的消息的消费者，您可以使用basic_reject或basic_nack告诉服务器（它仍然有一个完整的副本）将其转发到死信交换机。

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

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后运行以下命令来完成此操作：

$ rabbitmqctl add_vhost phpamqplib_testbed
$ rabbitmqctl add_user phpamqplib phpamqplib_password
$ rabbitmqctl set_permissions -p phpamqplib_testbed phpamqplib ".*" ".*" ".*"

一旦您的环境设置完成，您就可以这样运行您的测试

$ make test

贡献

有关详细信息，请参阅 CONTRIBUTING

使用 AMQP 0.8

如果您仍然想使用旧版协议，您可以通过在配置代码中设置以下常量来实现

define('AMQP_PROTOCOL', '0.8');

默认值是 '0.9.1'。

提供您自己的自动加载器

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

原始 README

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

实现高级消息队列协议 (AMQP) 的 PHP 库。

该库是 py-amqplib 的 Python 代码的移植版本 http://barryp.org/software/py-amqplib/

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

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

请加入小组进行讨论

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

请使用项目页面的错误跟踪系统进行错误报告。

欢迎提交补丁！

作者：Vadim Zaliva lord@crocodile.org

levy / php-amqplib

维护者

详细信息