README

支持策略

只有最新版本会获得新功能。将通过以下方案提供错误修复：

安装

您可以通过以下命令使用 composer 安装此包：

composer require vladimir-yuldashev/laravel-queue-rabbitmq

此包将自动注册自己。

将连接添加到 config/queue.php

'connections' => [
    // ...

    'rabbitmq' => [
    
       'driver' => 'rabbitmq',
       'queue' => env('RABBITMQ_QUEUE', 'default'),
       'connection' => PhpAmqpLib\Connection\AMQPLazyConnection::class,
   
       'hosts' => [
           [
               'host' => env('RABBITMQ_HOST', '127.0.0.1'),
               'port' => env('RABBITMQ_PORT', 5672),
               'user' => env('RABBITMQ_USER', 'guest'),
               'password' => env('RABBITMQ_PASSWORD', 'guest'),
               'vhost' => env('RABBITMQ_VHOST', '/'),
           ],
       ],
   
       'options' => [
           'ssl_options' => [
               'cafile' => env('RABBITMQ_SSL_CAFILE', null),
               'local_cert' => env('RABBITMQ_SSL_LOCALCERT', null),
               'local_key' => env('RABBITMQ_SSL_LOCALKEY', null),
               'verify_peer' => env('RABBITMQ_SSL_VERIFY_PEER', true),
               'passphrase' => env('RABBITMQ_SSL_PASSPHRASE', null),
           ],
       ],
   
       /*
        * Set to "horizon" if you wish to use Laravel Horizon.
        */
       'worker' => env('RABBITMQ_WORKER', 'default'),
        
    ],

    // ...    
],

可选配置

可选地将队列选项添加到连接的配置中。为此连接创建的每个队列都将获得这些属性。

当您想在消息延迟时优先处理消息时，可以通过添加额外选项来实现。

如果省略了最大优先级，则在使用时最大优先级设置为 2。

'connections' => [
    // ...

    'rabbitmq' => [
        // ...

        'options' => [
            'queue' => [
                // ...

                'prioritize_delayed_messages' =>  false,
                'queue_max_priority' => 10,
            ],
        ],
    ],

    // ...    
],

当您想通过带有路由键的交换机发布消息时，可以通过添加额外选项来实现。

如果省略了交换机，RabbitMQ 将使用 amq.direct 交换机作为路由键。
如果省略了路由键，则默认路由键是 queue 名称。
当在路由键中使用 %s 时，将用队列名称替换。

注意：当使用带有路由键的交换机时，您可能需要自己创建队列的绑定。

'connections' => [
    // ...

    'rabbitmq' => [
        // ...

        'options' => [
            'queue' => [
                // ...

                'exchange' => 'application-x',
                'exchange_type' => 'topic',
                'exchange_routing_key' => '',
            ],
        ],
    ],

    // ...    
],

在 Laravel 中，失败的任务存储在数据库中。但也许您想指示其他进程也处理消息。当您想指示 RabbitMQ 将失败消息重新路由到交换机或特定队列时，可以通过添加额外选项来实现。

如果省略了交换机，RabbitMQ 将使用 amq.direct 交换机作为路由键。
如果省略了路由键，则默认将路由键的 queue 名称替换为 '.failed'。
当在路由键中使用 %s 时，将用队列名称替换。

注意：当使用带有路由键的失败任务交换机时，您可能需要自己创建交换机和队列的绑定。

'connections' => [
    // ...

    'rabbitmq' => [
        // ...

        'options' => [
            'queue' => [
                // ...

                'reroute_failed' => true,
                'failed_exchange' => 'failed-exchange',
                'failed_routing_key' => 'application-x.%s',
            ],
        ],
    ],

    // ...    
],

Laravel 使用方法

配置完成后，您可以使用 Laravel 队列 API。如果您使用了其他队列驱动程序，则不需要更改其他任何内容。如果您不知道如何使用队列 API，请参阅官方 Laravel 文档：https://laravel.net.cn/docs/queues

Laravel Horizon 使用方法

从 8.0 版本开始，此包支持开箱即用的 Laravel Horizon。首先安装 Horizon，然后将 RABBITMQ_WORKER 设置为 horizon。

Lumen 使用方法

对于 Lumen 的使用，应在 bootstrap/app.php 中手动注册服务提供者，如下所示：

$app->register(VladimirYuldashev\LaravelQueueRabbitMQ\LaravelQueueRabbitMQServiceProvider::class);

消费消息

有两种方式可以消费消息。

queue:work 命令是 Laravel 的内置命令。此命令使用 basic_get。
rabbitmq:consume 命令是由此包提供的。此命令使用 basic_consume，比 basic_get 性能高约 2 倍。

测试

使用 docker-compose 设置 RabbitMQ

docker-compose up -d rabbitmq

要运行测试套件，可以使用以下命令：

# To run both style and unit tests.
composer test

# To run only style tests.
composer test:style

# To run only unit tests.
composer test:unit

如果您从样式测试中收到任何错误，可以使用以下命令自动修复大多数，如果不是所有的问题：

composer fix:style

贡献

您可以通过发现错误并打开问题来为此包做出贡献。请记住，在您创建拉取请求或问题时要添加包的版本。（例如：[5.2] 延迟作业上的致命错误）

hooraweb / laravel-queue-rabbitmq

维护者

详细信息