README

这个库是AMQP协议的纯PHP实现。它已在RabbitMQ上进行了测试。

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

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

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

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

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

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

支持的RabbitMQ版本

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

支持的RabbitMQ扩展

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

交换到交换绑定
基本Nack
发布者确认
消费者取消通知

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

设置

将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::$body_size将反映接收到的消息的真实正文大小，如果消息已被截断，则该大小将大于strlen(AMQPMessage::getBody())。

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

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

##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 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

brightlocal / php-amqplib

维护者

详情