README

这个库是 AMQP 协议的 纯 PHP 实现。它已经通过了 RabbitMQ 的测试。

要求：PHP 5.3，因为使用了 命名空间。

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

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

新维护者（2016年2月10日）

感谢 videlalvaro 为维护 php-amqplib 所做的辛勤工作！他做得非常出色，留下了很大的空白。

现在，该包将由 postalservice14 和 nubeiro 维护。

支持的 RabbitMQ 版本

从版本 2.0 开始，这个库默认使用 AMQP 0.9.1，因此需要 RabbitMQ 2.0 或更高版本。您不需要更改代码，但在升级前请进行测试。

支持的 RabbitMQ 扩展

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

Exchange 到 Exchange 绑定
基本拒绝
发布者确认
消费者取消通知

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

设置

将一个 composer.json 文件添加到您的项目中

{
  "require": {
      "php-amqplib/php-amqplib": "2.6.*"
  }
}

然后，如果您已安装 composer，您可以运行以下命令

$ composer.phar install

这将从您的 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传递给您的回调。属性AMQPMessage::$body_size将反映接收到的消息的真实正文大小，如果消息已被截断，则该大小将高于strlen(AMQPMessage::getBody())。

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

默认情况下，不会发生截断。要禁用已启用截断的通道的截断，请将 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
            exit(0);
            break;
        case \SIGHUP:
            // some stuff to restart consumer
            break;
        default:
            // do nothing
    }
};

declare(ticks = 1) {
    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 文件的内容。归功于原始作者。

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

该库是将 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

crmao / php-amqplib

维护者

详情