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以来，某些在“生产者”配置部分声明的交换机的默认选项已更改为与“消费者”部分中声明的交换机的默认值匹配。受影响的设置是

  • 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}
    ...

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

消费者

消费者将连接到服务器并开始一个 循环，等待处理传入的消息。根据指定给此类消费者的 回调，将决定其行为。让我们回顾一下上面的消费者配置。

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 来实现。在下面的示例中，此标志添加了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)来检查新的应用程序部署。

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

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

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

在处理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

优雅的最大执行超时

如果您希望消费者运行到一定时间然后优雅退出，请设置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调用。这个bundle使得使用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() 函数的最小值和最大值。我们通过序列化一个数组来发送它们。如果服务器期望 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 的交换类型，其中消息根据——你猜对了——消息的主题被路由到队列。我们可以使用作为主题的主机名和日志的严重性将应用程序的日志发送到 RabbiMQ 主题交换。消息体将是日志内容，我们的路由键将类似于以下内容

• 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:
        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

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

如何贡献

要贡献代码，只需打开一个带有您新代码的拉取请求。请注意，如果您添加新功能或修改现有功能，您必须在README中记录它们的功能。如果您破坏了BC（向后兼容性），也必须记录它。此外，您还必须更新CHANGELOG。因此

• 记录新功能。
• 更新CHANGELOG。
• 记录破坏向后兼容性的变更。

许可协议

查看：resources/meta/LICENSE.md

致谢

此软件包的结构和文档部分基于RedisBundle。