nti/rabbitmq-bundle

集成 php-amqplib 与 Symfony 和 RabbitMq。之前为 oldsound/rabbitmq-bundle。

维护者

详细信息

github.com/ntidev/RabbitMqBundle

来源

安装: 1,285

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 470

类型:symfony-bundle

v2.7.0 2021-05-28 00:31 UTC

Requires

Requires (Dev)

Suggests

Replaces

MIT c4aab5348846f18e39cd741e82d2301c997084c2

  • Alvaro Videla

queuesymfonyrabbitmqmessageAMQPsymfony4symfony5

This package is auto-updated.

Last update: 2024-09-09 02:20:21 UTC

README

Join the chat at https://gitter.im/php-amqplib/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 会议中展出。查看幻灯片 此处。

Build Status

安装

对于 Symfony 框架 >= 2.3

使用 composer 需要此捆绑包及其依赖项

$ composer require nti/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": {
        "nti/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 消息对象，而不仅仅是主体。有关更多详细信息，请参阅 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

消费者事件

这在许多场景中都是有用的。有三个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);
    }
}

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

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

空闲消息事件
<?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设置的basic.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。

我们要发送的参数是 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 选项可用

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 命令来声明你的配置。

如何贡献

要贡献，只需打开一个带有你新代码的拉取请求。请注意，如果你添加新功能或修改现有功能，你必须在本 README 中说明它们的作用。如果你破坏了 BC，你也必须记录下来。此外，你必须更新 CHANGELOG。所以

  • 文档新增功能。
  • 更新变更日志。
  • 记录向后不兼容的更改。

许可协议

NTI

致谢

该包结构和文档部分基于RedisBundle