README

RabbitMqBundle

关于

RabbitMqBundle 通过使用 RabbitMQ 和 php-amqplib 库在您的应用程序中集成消息。

该软件包实现了在 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 会议中展出。请参阅幻灯片此处。

版本 2

由于由于 Symfony >=4.4 发生的破坏性更改，发布了一个新的标签，使软件包与 Symfony >=4.4 兼容。此外，它消除了由于 Symfony 4.3 中的 symfony 事件调度器引起的大量通知。

安装

对于 Symfony 框架 >= 4.3

使用 composer 需要软件包及其依赖项

$ composer require emag-tech-labs/rabbitmq-bundle

注册软件包

// app/AppKernel.php

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

享受！

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

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

在您的 composer.json 文件中需要软件包

{
    "require": {
        "emag-tech-labs/rabbitmq-bundle": "^2.0",
    }
}

注册扩展和编译器传递

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

// ...

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

警告 - BC 破坏性更改

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

用法

在配置文件中添加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环境中，所有服务都为每个请求完全启动，从版本>=4.3开始，您可以声明一个服务为懒加载（懒加载服务）。此包仍然不支持新的懒加载服务功能，但您可以在连接配置中设置lazy: true以避免在每个请求中与消息代理建立不必要的连接。由于性能原因，强烈建议使用懒连接，尽管默认禁用懒连接选项，以避免对已使用此包的应用程序造成潜在破坏。

重要提示 - 心跳

将read_write_timeout设置为心跳的两倍是一个好主意，这样您的套接字就会保持开启状态。如果您不这样做，或者使用不同的乘数，消费者套接字超时的风险会增加。

动态连接参数

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

例如，在一个场景中，连接的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()方法还接受一个可选的路由键参数和一个可选的附加属性数组。附加属性数组允许您更改默认情况下由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}
    ...

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

消费者

消费者将连接到服务器并启动一个loop等待处理传入的消息。根据指定给该消费者的callback，它将具有相应的行为。让我们回顾一下上面的消费者配置

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

正如我们看到的，callback选项引用了一个upload_picture_service。当消费者从服务器接收到消息时，它将执行此回调。如果您需要指定不同的回调以进行测试或调试，则可以在此处更改它。

除了回调之外，我们还指定了要使用的连接方式，就像我们处理producer一样。其余选项是exchange_options和queue_options。exchange_options应与用于producer的相同。在queue_options中，我们将提供一个queue name。为什么？

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

现在，如何运行一个消费者？有一个命令可以执行，可以像这样执行

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

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

如果您想确保消费者在Unix信号下立即执行，可以使用带有标志-w的命令。

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

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

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

如果您想设置消费者内存限制，可以使用标志-l。在以下示例中，此标志添加了256MB内存限制。消费者将在达到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事件

ON 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)并检查新应用程序的部署。

处理消息前

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);
    }
}

在处理AMQP消息之前引发的事件。

处理消息后

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);
    }
}

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

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

超时等待

设置秒为timeout_wait。timeout_wait指定消费者在没有接收到新消息之前将等待多长时间，以确保当前连接仍然有效。

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
        timeout_wait:           10

优雅的最大执行超时

如果您希望消费者运行一定时间然后优雅地退出，请设置秒为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

请注意，实现公平分发会引入延迟，这会损害性能（请参阅这篇文章）。但是实现它允许你随着队列的增长动态地水平扩展。你应该根据处理每条消息所需的时间和你的网络性能来评估，如博客中建议的，正确的 prefetch_size 值。

使用 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

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

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。

我们发送的参数是 min 和 max 值，用于 rand() 函数。我们通过序列化数组发送它们。如果我们的服务器期望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选项可用重要：如果您只想消费特定数量的批次然后停止消费者，批量消费者也可以有-b|batches选项可用。

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

emag-tech-labs / rabbitmq-bundle

维护者

详细信息