README

关于

The RabbitMqBundle incorporates messaging in your application via RabbitMQ using the php-amqplib library.

此组件实现了在 Thumper 库中看到的一些消息模式。因此，从 Symfony 控制器向 RabbitMQ 发布消息就像

$msg = array('user_id' => 1235, 'image_path' => '/path/to/new/pic.png');
$this->get('old_sound_rabbit_mq.upload_picture_producer')->publish(serialize($msg));

稍后，当您想从 upload_pictures 队列中消费 50 条消息时，只需在 CLI 上运行

$ ./app/console rabbitmq:consumer -m 50 upload_picture

所有示例都假定 RabbitMQ 服务器正在运行。

此组件在 Symfony Live Paris 2011 会议中展出。查看幻灯片这里。

安装

对于 Symfony 框架 >= 2.3

使用 composer 需求此组件及其依赖

$ composer require php-amqplib/rabbitmq-bundle

注册组件

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new OldSound\RabbitMqBundle\OldSoundRabbitMqBundle(),
    );
}

享受！

对于使用 Symfony Console、依赖注入和配置组件的控制台应用程序

如果您有一个用于运行 RabbitMQ 消费者的控制台应用程序，则不需要 Symfony HttpKernel 和 FrameworkBundle。从版本 1.6 开始，您可以使用依赖注入组件加载此组件配置和服务，然后使用消费者命令。

在您的 composer.json 文件中需要此组件

{
    "require": {
        "php-amqplib/rabbitmq-bundle": "~1.6",
    }
}

注册扩展和编译器传递

use OldSound\RabbitMqBundle\DependencyInjection\OldSoundRabbitMqExtension;
use OldSound\RabbitMqBundle\DependencyInjection\Compiler\RegisterPartsPass;

// ...

$containerBuilder->registerExtension(new OldSoundRabbitMqExtension());
$containerBuilder->addCompilerPass(new RegisterPartsPass());

警告 - 兼容性破坏更改

自 2012-06-04 以来，某些在 "producers" 配置部分声明的交换机默认选项已更改为与 "consumers" 部分中声明的交换机默认选项匹配。受影响的设置是
- durable 已从 false 更改为 true，
- auto_delete 已从 true 更改为 false。
如果依赖于以前的默认值，则必须更新您的配置。
自 2012-04-24 以来，ConsumerInterface::execute 方法签名已更改
自 2012-01-03 以来，消费者执行方法获取整个 AMQP 消息对象，而不仅仅是体。

用法

在您的配置文件中添加 old_sound_rabbit_mq 部分

old_sound_rabbit_mq:
    connections:
        default:
            host:     'localhost'
            port:     5672
            user:     'guest'
            password: 'guest'
            vhost:    '/'
            lazy:     false
            connection_timeout: 3
            read_write_timeout: 3

            # requires php-amqplib v2.4.1+ and PHP5.4+
            keepalive: false

            # requires php-amqplib v2.4.1+
            heartbeat: 0

            #requires php_sockets.dll
            use_socket: true # default false
        another:
            # A different (unused) connection defined by an URL. One can omit all parts,
            # except the scheme (amqp:). If both segment in the URL and a key value (see above)
            # are given the value from the URL takes precedence.
            # See https://rabbitmq.cn/uri-spec.html on how to encode values.
            url: 'amqp://guest:password@localhost:5672/vhost?lazy=1&connection_timeout=6'
    producers:
        upload_picture:
            connection:       default
            exchange_options: {name: 'upload-picture', type: direct}
            service_alias:    my_app_service # no alias by default
    consumers:
        upload_picture:
            connection:       default
            exchange_options: {name: 'upload-picture', type: direct}
            queue_options:    {name: 'upload-picture'}
            callback:         upload_picture_service

在此，我们配置了连接服务和我们的应用程序将拥有的消息端点。在此示例中，您的服务容器将包含服务 old_sound_rabbit_mq.upload_picture_producer 和 old_sound_rabbit_mq.upload_picture_consumer。后者期望存在名为 upload_picture_service 的服务。

如果您没有为客户端指定连接，则客户端将寻找具有相同别名的连接。因此，对于我们的 upload_picture，服务容器将寻找一个名为 upload_picture 的连接。

如果您需要添加可选队列参数，则队列选项可以如下所示

queue_options: {name: 'upload-picture', arguments: {'x-ha-policy': ['S', 'all']}}

另一个具有 20 秒消息 TTL 的示例

queue_options: {name: 'upload-picture', arguments: {'x-message-ttl': ['I', 20000]}}

参数值必须是数据类型和值的列表。有效数据类型是

S - 字符串
I - 整数
D - 十进制数
T - 时间戳
F - 表
A - 数组

根据您的需求调整 arguments。

如果您想使用特定的路由键绑定队列，则可以在生产者或消费者配置中声明它

queue_options:
    name: "upload-picture"
    routing_keys:
      - 'android.#.upload'
      - 'iphone.upload'

重要说明 - 懒加载连接

在 Symfony 环境中，每个请求都会完全启动所有服务，从版本 >= 2.3 开始，您可以声明一个服务为延迟加载（延迟加载服务）。此扩展包仍不支持新的延迟加载服务功能，但您可以在您的连接配置中设置 lazy: true 以避免在每次请求中不必要的连接到您的消息代理。出于性能原因，强烈建议使用延迟连接，尽管延迟选项默认禁用，以避免破坏已经使用此扩展包的应用程序。

导入通知 - 心跳

将 read_write_timeout 设置为心跳的 2 倍，这样您的套接字就会保持开启。如果您不这样做，或者使用不同的乘数，则存在风险，消费者 套接字将超时。

动态连接参数

有时您的连接信息可能需要是动态的。动态连接参数允许您通过服务以编程方式提供或覆盖参数。

例如，在一个场景中，连接的 vhost 参数取决于您的白标应用程序的当前租户，并且您不希望（或不能）每次都更改其配置。

在 connection_parameters_provider 下定义一个实现 ConnectionParametersProviderInterface 的服务，并将其添加到适当的 connections 配置中。

connections:
    default:
        host:     'localhost'
        port:     5672
        user:     'guest'
        password: 'guest'
        vhost:    'foo' # to be dynamically overridden by `connection_parameters_provider`
        connection_parameters_provider: connection_parameters_provider_service

示例实现

class ConnectionParametersProviderService implements ConnectionParametersProvider {
    ...
    public function getConnectionParameters() {
        return array('vhost' => $this->getVhost());
    }
    ...
}

在这种情况下，vhost 参数将被 getVhost() 的输出覆盖。

生产者、消费者是什么？

在消息应用程序中，向代理发送消息的过程称为 生产者，而接收这些消息的过程称为 消费者。在您的应用程序中，您将拥有几个它们，可以在配置的相应条目下列出。

生产者

生产者将被用于向服务器发送消息。在 AMQP 模型中，消息被发送到 交换机，这意味着在配置生产者时，您必须指定连接选项以及交换机选项，这通常是交换机的名称和类型。

现在假设您想后台处理图片上传。在将图片移动到其最终位置后，您将向服务器发布包含以下信息的消息

public function indexAction($name)
{
    $msg = array('user_id' => 1235, 'image_path' => '/path/to/new/pic.png');
    $this->get('old_sound_rabbit_mq.upload_picture_producer')->publish(serialize($msg));
}

如您所见，如果您的配置中有一个名为 upload_picture 的生产者，那么在服务容器中将有名为 old_sound_rabbit_mq.upload_picture_producer 的服务。

除了消息本身之外，OldSound\RabbitMqBundle\RabbitMq\Producer#publish() 方法还接受一个可选的 routing key 参数和一个可选的附加属性数组。附加属性数组允许您更改默认情况下使用 PhpAmqpLib\Message\AMQPMessage 对象构造的属性。这样，例如，您可以更改应用程序头。

您可以使用 setContentType 和 setDeliveryMode 方法分别设置消息内容类型和消息投递模式。内容类型的默认值是 text/plain，投递模式的默认值是 2。

$this->get('old_sound_rabbit_mq.upload_picture_producer')->setContentType('application/json');

如果您需要为生产者使用自定义类（该类应继承自 OldSound\RabbitMqBundle\RabbitMq\Producer），则可以使用 class 选项

    ...
    producers:
        upload_picture:
            class: My\Custom\Producer
            connection: default
            exchange_options: {name: 'upload-picture', type: direct}
    ...

下一个问题是要有一个消费者，它会从队列中取出消息并相应地处理它。

消费者

消费者将连接到服务器并开始一个循环，等待接收到的消息进行处理。这样的消费者的指定回调将决定其行为。让我们回顾一下上面的消费者配置

consumers:
    upload_picture:
        connection:       default
        exchange_options: {name: 'upload-picture', type: direct}
        queue_options:    {name: 'upload-picture'}
        callback:         upload_picture_service

正如我们所见，回调选项有一个对upload_picture_service的引用。当消费者从服务器收到消息时，它将执行这样的回调。如果您需要指定不同的回调进行测试或调试，则可以在那里更改它。

除了回调之外，我们还需要指定要使用的连接，这与生产者的方式相同。其余选项是exchange_options和queue_options。exchange_options应与生产者使用的相同。在queue_options中，我们将提供队列名称。为什么？

正如我们所说的，AMQP中的消息是发布到交换的。这并不意味着消息已经到达队列。要实现这一点，首先我们需要创建这样的队列，然后将其绑定到交换。酷的地方在于，你可以将多个队列绑定到一个交换上，这样一条消息可以到达多个目的地。这种方法的优点是实现了生产者和消费者之间的解耦。生产者不关心会有多少消费者处理他的消息。他需要的只是他的消息到达服务器。这样我们就可以在不需要更改控制器中的代码的情况下，扩展每次上传图片时执行的操作。

现在，如何运行消费者？有一个命令可以执行，如下所示

$ ./app/console rabbitmq:consumer -m 50 upload_picture

这意味着什么？我们正在执行upload_picture消费者，并告诉它只消费50条消息。每次消费者从服务器接收消息时，它都会执行配置的回调，并将AMQP消息作为PhpAmqpLib\Message\AMQPMessage类的实例传递。可以通过调用$msg->body来获取消息正文。默认情况下，消费者将以一些定义的无限循环处理消息。

如果您想确保消费者在Unix信号上立即执行完毕，可以带有标志-w运行命令。

$ ./app/console rabbitmq:consumer -w upload_picture

然后消费者将立即执行完毕。

要使用带有此标志的命令，您需要安装带有PCNTL扩展的PHP。

如果您想设置消费者内存限制，可以使用标志-l。在以下示例中，此标志添加了256 MB的内存限制。消费者将在达到256MB前停止5MB，以避免PHP允许的内存大小错误。

$ ./app/console rabbitmq:consumer -l 256

如果您想删除队列中等待的所有消息，可以执行此命令来清空此队列

$ ./app/console rabbitmq:purge --no-confirmation upload_picture

要删除消费者的队列，请使用此命令

$ ./app/console rabbitmq:delete --no-confirmation upload_picture

消费者事件

这在许多场景中都很有用。有3个AMQP事件

CONSUME

class OnConsumeEvent extends AMQPEvent
{
    const NAME = AMQPEvent::ON_CONSUME;

    /**
     * OnConsumeEvent constructor.
     *
     * @param Consumer $consumer
     */
    public function __construct(Consumer $consumer)
    {
        $this->setConsumer($consumer);
    }
}

比如说，你需要在新应用程序部署时暂停/停止消费者。你可以监听OnConsumeEvent (\OldSound\RabbitMqBundle\Event\OnConsumeEvent)并检查新应用程序部署。

BEFORE PROCESSING MESSAGE

class BeforeProcessingMessageEvent extends AMQPEvent
{
    const NAME = AMQPEvent::BEFORE_PROCESSING_MESSAGE;

    /**
     * BeforeProcessingMessageEvent constructor.
     *
     * @param AMQPMessage $AMQPMessage
     */
    public function __construct(Consumer $consumer, AMQPMessage $AMQPMessage)
    {
        $this->setConsumer($consumer);
        $this->setAMQPMessage($AMQPMessage);
    }
}

在处理AMQPMessage之前触发的事件。

AFTER PROCESSING MESSAGE

class AfterProcessingMessageEvent extends AMQPEvent
{
    const NAME = AMQPEvent::AFTER_PROCESSING_MESSAGE;

    /**
     * AfterProcessingMessageEvent constructor.
     *
     * @param AMQPMessage $AMQPMessage
     */
    public function __construct(Consumer $consumer, AMQPMessage $AMQPMessage)
    {
        $this->setConsumer($consumer);
        $this->setAMQPMessage($AMQPMessage);
    }
}

在处理AMQPMessage之后触发的事件。如果处理消息将抛出异常，则不会触发事件。

IDLE MESSAGE

<?php
class OnIdleEvent extends AMQPEvent
{
    const NAME = AMQPEvent::ON_IDLE;

    /**
     * OnIdleEvent constructor.
     *
     * @param AMQPMessage $AMQPMessage
     */
    public function __construct(Consumer $consumer)
    {
        $this->setConsumer($consumer);
        
        $this->forceStop = true;
    }
}

当wait方法由于超时而退出时触发的事件。为了使用此事件，消费者需要idle_timeout已配置。默认情况下，在空闲超时时退出，您可以通过在监听器中设置$event->setForceStop(false)来防止它。

空闲超时

如果您想在一段时间内没有从队列接收到消息时设置超时，您可以在秒中设置 idle_timeout。idle_timeout_exit_code 指定当空闲超时时消费者应返回的退出代码。如果没有指定它，消费者将抛出 PhpAmqpLib\Exception\AMQPTimeoutException 异常。

consumers:
    upload_picture:
        connection:             default
        exchange_options:       {name: 'upload-picture', type: direct}
        queue_options:          {name: 'upload-picture'}
        callback:               upload_picture_service
        idle_timeout:           60
        idle_timeout_exit_code: 0

优雅的最大执行超时

如果您希望您的消费者运行到一定时间然后优雅退出，则设置 graceful_max_execution.timeout 秒。 "优雅退出" 意味着消费者将在当前正在运行的任务之后或立即退出，当等待新任务时。当发生优雅的最大执行超时时，graceful_max_execution.exit_code 指定消费者应返回的退出代码。如果没有指定它，消费者将以状态 0 退出。

此功能与 supervisord 结合使用时非常好，它可以一起允许定期清理内存泄漏、数据库/rabbitmq 连接更新等。

consumers:
    upload_picture:
        connection:             default
        exchange_options:       {name: 'upload-picture', type: direct}
        queue_options:          {name: 'upload-picture'}
        callback:               upload_picture_service

        graceful_max_execution:
            timeout: 1800 # 30 minutes 
            exit_code: 10 # default is 0

公平调度

您可能已经注意到，调度仍然没有完全按照我们想要的方式进行。例如，在有两个工作者的情况下，当所有奇数消息都很重，偶数消息都很轻时，一个工作者将一直很忙，而另一个工作者几乎不做任何工作。好吧，RabbitMQ 对此一无所知，仍然会平均分发消息。

这是因为 RabbitMQ 只在消息进入队列时才分发消息。它不会查看消费者未确认消息的数量。它只是盲目地将每第 n 个消息分发给第 n 个消费者。

为了解决这个问题，我们可以使用 basic.qos 方法，设置 prefetch_count=1。这告诉 RabbitMQ 不要一次给工作者发送超过一个消息。换句话说，在工作者处理和确认上一个消息之前，不要向其发送新消息。相反，它会将其分发给下一个尚未忙碌的工作者。

来源: https://rabbitmq.cn/tutorials/tutorial-two-python.html

请注意，实现公平调度会引入延迟，这会影响性能（请参阅此博客文章）。但是，实现它允许您在队列增加时动态水平扩展。您应该像博客文章推荐的那样，根据处理每个消息所需的时间和您的网络性能评估合适的预取大小。

使用 RabbitMqBundle，您可以按以下方式配置每个消费者的 qos_options

consumers:
    upload_picture:
        connection:       default
        exchange_options: {name: 'upload-picture', type: direct}
        queue_options:    {name: 'upload-picture'}
        callback:         upload_picture_service
        qos_options:      {prefetch_size: 0, prefetch_count: 1, global: false}

回调

以下是一个示例回调

<?php

//src/Acme/DemoBundle/Consumer/UploadPictureConsumer.php

namespace Acme\DemoBundle\Consumer;

use OldSound\RabbitMqBundle\RabbitMq\ConsumerInterface;
use PhpAmqpLib\Message\AMQPMessage;

class UploadPictureConsumer implements ConsumerInterface
{
    public function execute(AMQPMessage $msg)
    {
        //Process picture upload.
        //$msg will be an instance of `PhpAmqpLib\Message\AMQPMessage` with the $msg->body being the data sent over RabbitMQ.

        $isUploadSuccess = someUploadPictureMethod();
        if (!$isUploadSuccess) {
            // If your image upload failed due to a temporary error you can return false
            // from your callback so the message will be rejected by the consumer and
            // requeued by RabbitMQ.
            // Any other value not equal to false will acknowledge the message and remove it
            // from the queue
            return false;
        }
    }
}

如您所见，这就像实现一个方法一样简单： ConsumerInterface::execute。

请注意，您的回调需要被注册为常规的 Symfony 服务。在那里，您可以注入服务容器、数据库服务、Symfony 日志记录器等。

有关消息实例的更多详细信息，请参阅 https://github.com/php-amqplib/php-amqplib/blob/master/doc/AMQPMessage.md

总结

这似乎只是为了发送消息而要做很多工作，让我们回顾一下，以获得更好的概述。这是我们生产/消费消息所需的：

在配置中添加消费者/生产者条目。
实现您的回调。
从 CLI 启动消费者。
在控制器中添加发布消息的代码。

就这么多！

审计/日志记录

这是一个需要跟踪接收/发布消息的要求。为了启用此功能，您需要向消费者或发布者添加 "enable_logger" 配置。

consumers:
    upload_picture:
        connection:       default
        exchange_options: {name: 'upload-picture', type: direct}
        queue_options:    {name: 'upload-picture'}
        callback:         upload_picture_service
        enable_logger: true

如果您愿意，您还可以通过引用通道 "phpamqplib" 使用 monolog 的不同处理程序处理队列的日志记录。

RPC 或回复/响应

到目前为止，我们只是向消费者发送消息，但如果我们想从他们那里得到回复呢？为了实现这一点，我们必须在我们的应用程序中实现RPC调用。这个包使得使用Symfony实现这样的功能变得非常简单。

让我们在配置中添加一个RPC客户端和服务器。

rpc_clients:
    integer_store:
        connection: default #default: default
        unserializer: json_decode #default: unserialize
        lazy: true #default: false
        direct_reply_to: false
rpc_servers:
    random_int:
        connection: default
        callback:   random_int_server
        qos_options: {prefetch_size: 0, prefetch_count: 1, global: false}
        exchange_options: {name: random_int, type: topic}
        queue_options: {name: random_int_queue, durable: false, auto_delete: true}
        serializer: json_encode

有关完整的配置参考，请使用php app/console config:dump-reference old_sound_rabbit_mq命令。

这里有一个非常有用的服务器：它向其客户端返回随机整数。用于处理请求的回调将是random_int_server服务。现在让我们看看如何从我们的控制器中调用它。

首先，我们必须从命令行启动服务器。

$ ./app/console_dev rabbitmq:rpc-server random_int

然后，将以下代码添加到我们的控制器中

public function indexAction($name)
{
    $client = $this->get('old_sound_rabbit_mq.integer_store_rpc');
    $client->addRequest(serialize(array('min' => 0, 'max' => 10)), 'random_int', 'request_id');
    $replies = $client->getReplies();
}

如您所见，如果我们的客户端ID是integer_store，则服务名称将是old_sound_rabbit_mq.integer_store_rpc。一旦我们得到这个对象，我们就通过调用addRequest在服务器上放置一个请求，该调用期望三个参数

要发送到远程过程调用的参数。
RPC服务器的名称，在我们的例子中是random_int。
我们调用请求的请求标识符，在这个例子中是request_id。

我们发送的参数是rand()函数的min和max值。我们通过序列化一个数组来发送它们。如果我们的服务器期望JSON信息或XML，我们将在这里发送此类数据。

最后一部分是获取回复。我们的PHP脚本将阻塞，直到服务器返回一个值。变量$replies将是一个关联数组，其中每个来自服务器的回复都将包含在相应的request_id键中。

默认情况下，RPC客户端期望响应被序列化。如果您正在使用的服务器返回非序列化的结果，则将RPC客户端的expect_serialized_response选项设置为false。例如，如果integer_store服务器没有序列化结果，客户端设置如下

rpc_clients:
    integer_store:
        connection: default
        expect_serialized_response: false

您还可以为请求设置过期时间（以秒为单位），在此之后，服务器将不再处理消息，客户端请求将简单地超时。设置消息过期时间仅适用于RabbitMQ 3.x及以上版本。有关更多信息，请访问https://rabbitmq.cn/ttl.html#per-message-ttl。

public function indexAction($name)
{
    $expiration = 5; // seconds
    $client = $this->get('old_sound_rabbit_mq.integer_store_rpc');
    $client->addRequest($body, $server, $requestId, $routingKey, $expiration);
    try {
        $replies = $client->getReplies();
        // process $replies['request_id'];
    } catch (\PhpAmqpLib\Exception\AMQPTimeoutException $e) {
        // handle timeout
    }
}

正如您所猜测的，我们还可以进行并行RPC调用。

并行RPC

假设您需要渲染某个网页，您需要执行两个数据库查询，一个需要5秒钟完成，另一个需要2秒钟——非常昂贵的查询。如果您按顺序执行它们，那么您的页面将在大约7秒后准备好交付。如果您并行运行它们，那么您将在大约5秒内得到页面服务。使用RabbitMqBundle，我们可以轻松地进行这样的并行调用。让我们在配置中定义一个并行客户端和另一个RPC服务器

rpc_clients:
    parallel:
        connection: default
rpc_servers:
    char_count:
        connection: default
        callback:   char_count_server
    random_int:
        connection: default
        callback:   random_int_server

然后，此代码应放在我们的控制器中

public function indexAction($name)
{
    $client = $this->get('old_sound_rabbit_mq.parallel_rpc');
    $client->addRequest($name, 'char_count', 'char_count');
    $client->addRequest(serialize(array('min' => 0, 'max' => 10)), 'random_int', 'random_int');
    $replies = $client->getReplies();
}

与上一个示例非常相似，我们只是有一个额外的addRequest调用。我们还提供了有意义的请求标识符，这样以后我们就可以更容易地在$replies数组中找到我们想要的回复。

直接回复客户端

要启用直接回复客户端，您只需在客户端的rpc_clients配置上启用选项direct_reply_to。

此选项将在执行RPC调用时使用伪队列amq.rabbitmq.reply-to。在RPC服务器上不需要进行任何修改。

多个消费者

在逻辑分离方面，拥有许多队列是一种良好的实践。使用简单的消费者时，您需要为每个队列创建一个工作者（消费者），在处理许多演变时可能难以管理（忘记在supervisord配置中添加一行？）。这对于小型队列也很有用，您可能不想拥有与队列一样多的工作者，并希望将一些任务重新分组，同时不失去灵活性和分离原则。

多个消费者允许您通过同一个消费者监听多个队列来处理此用例。

以下是设置具有多个队列的消费者的方法

multiple_consumers:
    upload:
        connection:       default
        exchange_options: {name: 'upload', type: direct}
        queues_provider: queues_provider_service
        queues:
            upload-picture:
                name:     upload_picture
                callback: upload_picture_service
                routing_keys:
                    - picture
            upload-video:
                name:     upload_video
                callback: upload_video_service
                routing_keys:
                    - video
            upload-stats:
                name:     upload_stats
                callback: upload_stats

现在，回调被指定在每个队列下，必须像简单消费者一样实现ConsumerInterface。消费者中所有queues-options的选项都适用于每个队列。

请注意，所有队列都在同一个交换机下，设置回调的正确路由取决于您。

queues_provider是一个可选服务，它可以动态提供队列。它必须实现QueuesProviderInterface。

请注意，队列提供者负责对setDequeuer的正确调用，并且回调是可调用的（不是ConsumerInterface）。如果提供队列的服务实现了DequeuerAwareInterface，则将添加对setDequeuer的调用到服务的定义中，当前DequeuerInterface是一个MultipleConsumer。

任意绑定

您可能会发现，您的应用程序具有复杂的流程，并且您需要任意绑定。任意绑定场景可能包括通过destination_is_exchange属性在交换机到交换机之间的绑定。

bindings:
    - {exchange: foo, destination: bar, routing_key: 'baz.*' }
    - {exchange: foo1, destination: foo, routing_key: 'baz.*' destination_is_exchange: true}

rabbitmq:setup-fabric命令将在创建任意绑定之前声明由您的生产者、消费者和多消费者配置中定义的交换机和队列。然而，rabbitmq:setup-fabric将不会声明在绑定中定义的附加队列和交换机。您必须确保交换机和队列被声明。

动态消费者

有时您必须动态更改消费者的配置。动态消费者允许您根据上下文程序化地定义消费者队列选项。

例如，在一个场景中，定义的消费者必须负责动态数量的主题，并且您不想（或不能）每次都更改它的配置。

定义一个实现QueueOptionsProviderInterface的服务queue_options_provider，并将其添加到您的dynamic_consumers配置中。

dynamic_consumers:
    proc_logs:
        connection: default
        exchange_options: {name: 'logs', type: topic}
        callback: parse_logs_service
        queue_options_provider: queue_options_provider_service

示例用法

$ ./app/console rabbitmq:dynamic-consumer proc_logs server1

在这种情况下，proc_logs消费者为server1运行，并且它可以决定它使用的队列选项。

匿名消费者

现在，我们为什么需要匿名消费者呢？这听起来像某种互联网威胁或类似的东西……继续阅读。

在AMQP中，有一种名为topic的交换机类型，消息是根据消息的主题路由到队列的。我们可以使用主题将应用程序的日志发送到RabbitMQ主题交换机，该主题是创建日志的主机名和日志的严重性。消息体将是日志内容，我们的路由键将是这样的

server1.error
server2.info
server1.warning
...

由于我们不希望用无限的日志填满队列，我们可以做的是，当我们想监控系统时，我们可以启动一个消费者，它创建一个队列并基于某些主题将队列附加到logs交换机，例如，我们想查看服务器报告的所有错误。路由键可能类似于：#.error。在这种情况下，我们必须想出一个队列名称，将其绑定到交换机，获取日志，解绑并删除队列。幸运的是，AMQP提供了一种自动执行此操作的方法，如果您在声明和绑定队列时提供正确的选项。问题是您不想记住所有这些选项。因此，我们实现了匿名消费者模式。

当我们启动匿名消费者时，它会处理这些细节，我们只需要考虑在消息到达时实现回调。为什么叫匿名消费者，因为它不会指定队列名称，但会等待RabbitMQ随机分配一个。

现在，如何配置和运行这样的消费者？

anon_consumers:
    logs_watcher:
        connection:       default
        exchange_options: {name: 'app-logs', type: topic}
        callback:         logs_watcher

在这里我们指定交换机名称和它的类型，以及当消息到达时应执行的回调。

这个匿名消费者现在能够监听与相同交换机和类型为topic的生产者。

    producers:
        app_logs:
            connection:       default
            exchange_options: {name: 'app-logs', type: topic}

要启动一个匿名消费者，我们使用以下命令

$ ./app/console_dev rabbitmq:anon-consumer -m 5 -r '#.error' logs_watcher

与之前看到的命令相比，唯一的新选项是指定路由键：-r '#.error'。

批量消费者

在某些情况下，您可能想要获取一批消息，然后对它们进行处理。批量消费者将允许您为此类处理定义逻辑。

例如：想象一下，您有一个队列，您在其中接收一条插入数据库的消息，您发现批量插入比逐个插入要好得多。

定义一个实现BatchConsumerInterface的回调服务，并将消费者的定义添加到您的配置中。

batch_consumers:
    batch_basic_consumer:
        connection:       default
        exchange_options: {name: 'batch', type: fanout}
        queue_options:    {name: 'batch'}
        callback:         batch.basic
        qos_options:      {prefetch_size: 0, prefetch_count: 2, global: false}
        timeout_wait:     5
        auto_setup_fabric: false
        idle_timeout_exit_code: -2
        keep_alive: false
        graceful_max_execution:
            timeout: 60

注意：如果将keep_alive选项设置为true，则忽略idle_timeout_exit_code，消费者进程将继续。

您可以实现一个批量消费者，它将在一个返回中确认所有消息，或者您可以控制哪些消息需要确认。

namespace AppBundle\Service;

use OldSound\RabbitMqBundle\RabbitMq\BatchConsumerInterface;
use PhpAmqpLib\Message\AMQPMessage;

class DevckBasicConsumer implements BatchConsumerInterface
{
    /**
     * @inheritDoc
     */
    public function batchExecute(array $messages)
    {
        echo sprintf('Doing batch execution%s', PHP_EOL);
        foreach ($messages as $message) {
            $this->executeSomeLogicPerMessage($message);
        }

        // you ack all messages got in batch
        return true; 
    }
}

namespace AppBundle\Service;

use OldSound\RabbitMqBundle\RabbitMq\BatchConsumerInterface;
use PhpAmqpLib\Message\AMQPMessage;

class DevckBasicConsumer implements BatchConsumerInterface
{
    /**
     * @inheritDoc
     */
    public function batchExecute(array $messages)
    {
        echo sprintf('Doing batch execution%s', PHP_EOL);
        $result = [];
        /** @var AMQPMessage $message */
        foreach ($messages as $message) {
            $result[(int)$message->delivery_info['delivery_tag']] = $this->executeSomeLogicPerMessage($message);
        }

        // you ack only some messages that have return true
        // e.g:
        // $return = [
        //      1 => true,
        //      2 => true,
        //      3 => false,
        //      4 => true,
        //      5 => -1,
        //      6 => 2,
        //  ];
        // The following will happen:
        //  * ack: 1,2,4
        //  * reject and requeq: 3
        //  * nack and requeue: 6
        //  * reject and drop: 5
        return $result;
    }
}

如何运行以下批量消费者

    $ ./bin/console rabbitmq:batch:consumer batch_basic_consumer -w

重要：批量消费者将没有-m|messages选项可用

STDIN生产者

有一个命令可以从STDIN读取数据并将其发布到RabbitMQ队列。要使用它，首先您需要在配置文件中配置一个producer服务，如下所示

producers:
    words:
      connection:       default
      exchange_options: {name: 'words', type: direct}

该生产者将消息发布到words直接交换机。当然，您可以适应任何您喜欢的配置。

然后假设您想要发布一些XML文件的内容，以便它们被消费者农场处理。您可以使用以下命令发布它们

$ find vendor/symfony/ -name "*.xml" -print0 | xargs -0 cat | ./app/console rabbitmq:stdin-producer words

这意味着您可以使用纯Unix命令组合生产者。

让我们分解这个单行命令

$ find vendor/symfony/ -name "*.xml" -print0

该命令将在symfony文件夹中找到所有.xml文件，并将文件名打印出来。然后，每个文件名都通过xargs被管道传输到cat。

$ xargs -0 cat

最后，cat的输出直接发送到我们的生产者，该生产者被调用如下

$ ./app/console rabbitmq:stdin-producer words

它只需要一个参数，即您在config.yml文件中配置的生产者名称。

其他命令

设置RabbitMQ结构

此包的目的是让您的应用程序产生消息并将它们发布到您配置的一些交换机。

在某些情况下，即使您的配置正确，您产生的消息也可能不会路由到任何队列，因为没有队列存在。负责队列消费的消费者必须运行，队列才会创建。

当消费者数量很多时，为每个消费者启动一个命令可能是一场噩梦。

为了一次性创建交换机、队列和绑定，并确保您不会丢失任何消息，您可以运行以下命令

$ ./app/console rabbitmq:setup-fabric

当需要时，您可以配置您的消费者和生产者假设RabbitMQ结构已经定义。为此，请将以下内容添加到您的配置中

producers:
    upload_picture:
      auto_setup_fabric: false
consumers:
    upload_picture:
      auto_setup_fabric: false

默认情况下，消费者或生产者在启动时会向RabbitMQ声明它所需的所有内容。使用时请注意，如果未定义交换机或队列，将会出现错误。当你更改任何配置时，需要运行上述setup-fabric命令来声明你的配置。

如何贡献

要贡献，只需提交一个包含你新代码的Pull Request，请注意，如果你添加了新功能或修改了现有功能，你必须在此README中记录它们的功能。如果你破坏了BC，你也必须记录下来。另外，你还需要更新CHANGELOG。所以

记录新功能。
更新CHANGELOG。
记录BC破坏性更改。

许可证

见：resources/meta/LICENSE.md

鸣谢

组件结构及文档部分基于RedisBundle。

gabrielextso / rabbitmq-bundle

维护者

详细信息