README

关于

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会议上展出。请参阅这里的幻灯片。

安装

对于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());

警告 - BC不兼容更改

• 自2012-06-04以来，某些在“producers”配置部分声明的交换机的默认选项已更改为与“consumers”部分中声明的交换机的默认值相匹配。受影响的设置是

  • 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环境中，每个请求都会完全启动所有服务，从版本>=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()方法还接受一个可选的路由键参数和一个可选的附加属性数组。附加属性数组允许您更改默认情况下构建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的引用。当消费者从服务器接收到消息时，它将执行此回调。如果您需要指定不同的回调以进行测试或调试，则可以更改它。

除了回调之外，我们还需要指定要使用的连接方式，就像我们对<强>生产者所做的那样。剩余的选项是<强>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来完成。在下面的示例中，此标志添加了256MB的内存限制。消费者将在达到256MB前的五MB停止，以避免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)，并检查新应用程序的部署。

处理消息前

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消息后引发的事件。如果处理消息会抛出异常，则不会引发此事件。

空闲消息

<?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 个消费者。

为了解决这个问题，我们可以使用带有 prefetch_count=1 设置的基本.qos 方法。这告诉 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

如果您愿意，您还可以使用 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。

我们发送的参数是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。在这种情况下，我们必须想出一个队列名，将其绑定到交换机，获取日志，解绑并删除队列。幸运的是，AMPQ提供了一种自动执行此操作的方法，如果您在声明和绑定队列时提供正确的选项。问题是您不想记住所有这些选项。因此，我们实现了匿名消费者模式。

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

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

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

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

此匿名消费者现在能够监听与同一交换机和类型为topic的Producers。

    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

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

如何贡献

要贡献，只需打开一个带有您新代码的 Pull Request，请注意，如果您添加了新功能或修改了现有功能，您必须在此 README 中记录它们的功能。如果您破坏了 BC，您也必须记录下来。此外，您必须更新 CHANGELOG。因此

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

许可

查看：resources/meta/LICENSE.md

致谢

该组件的结构和文档部分基于RedisBundle