thitruongsicom / laravel-amqp
Laravel 和 Lumen 的 AMQP 封装库,用于发布和消费消息
2.1.0
2021-08-03 07:18 UTC
Requires
- php: ^7.3|~8.0.0
- illuminate/support: >=6.20.0
- php-amqplib/php-amqplib: ^3.0
Requires (Dev)
- illuminate/config: >=5.5
- mockery/mockery: ^1.2
- phpoption/phpoption: 1.7.x-dev
- phpunit/phpunit: >=6.0
- squizlabs/php_codesniffer: ^3.0@dev
- vlucas/phpdotenv: ^5.3
README
Laravel 和 Lumen 的 AMQP 封装库,特别用于从 RabbitMQ 发布和消费消息
特性
- 高级队列配置
- 轻松将消息添加到队列中
- 使用有用选项监听队列
安装
Composer
将以下内容添加到 composer.json 文件中的 require 部分:
"bschmitt/laravel-amqp": "2.*" (Laravel >= 5.5) "bschmitt/laravel-amqp": "1.*" (Laravel < 5.5)
$ php composer update
或者
$ php composer require bschmitt/laravel-amqp
集成
Lumen
在 Lumen 应用程序的根目录中创建一个 config 文件夹,并将 vendor/bschmitt/laravel-amqp/config/amqp.php 的内容复制到 config/amqp.php。
根据需要调整属性。
return [ 'use' => 'production', 'properties' => [ 'production' => [ 'host' => 'localhost', 'port' => 5672, 'username' => 'username', 'password' => 'password', 'vhost' => '/', 'exchange' => 'amq.topic', 'exchange_type' => 'topic', 'consumer_tag' => 'consumer', 'ssl_options' => [], // See https://secure.php.net/manual/en/context.ssl.php 'connect_options' => [], // See https://github.com/php-amqplib/php-amqplib/blob/master/PhpAmqpLib/Connection/AMQPSSLConnection.php 'queue_properties' => ['x-ha-policy' => ['S', 'all']], 'exchange_properties' => [], 'timeout' => 0 ], ], ];
在 bootstrap/app.php 中注册 Lumen 服务提供者
/* |-------------------------------------------------------------------------- | Register Service Providers |-------------------------------------------------------------------------- */ //... $app->configure('amqp'); $app->register(Bschmitt\Amqp\LumenServiceProvider::class); //...
Lumen 5.2+ 添加 Facade 支持
//... $app->withFacades(true, [ 'Bschmitt\Amqp\Facades\Amqp' => 'Amqp', ]); //...
Laravel
打开 config/app.php 并添加服务提供者和别名
'Bschmitt\Amqp\AmqpServiceProvider',
'Amqp' => 'Bschmitt\Amqp\Facades\Amqp',
发布消息
使用路由键推送消息
Amqp::publish('routing-key', 'message');
使用路由键推送消息并创建队列
Amqp::publish('routing-key', 'message' , ['queue' => 'queue-name']);
使用路由键推送消息并覆盖属性
Amqp::publish('routing-key', 'message' , ['exchange' => 'amq.direct']);
消费消息
消费消息,确认并停止当没有剩余消息时
Amqp::consume('queue-name', function ($message, $resolver) { var_dump($message->body); $resolver->acknowledge($message); $resolver->stopWhenProcessed(); });
永久消费消息
Amqp::consume('queue-name', function ($message, $resolver) { var_dump($message->body); $resolver->acknowledge($message); });
使用自定义设置消费消息
Amqp::consume('queue-name', function ($message, $resolver) { var_dump($message->body); $resolver->acknowledge($message); }, [ 'timeout' => 2, 'vhost' => 'vhost3' ]);
Fanout 示例
发布消息
\Amqp::publish('', 'message' , [ 'exchange_type' => 'fanout', 'exchange' => 'amq.fanout', ]);
消费消息
\Amqp::consume('', function ($message, $resolver) { var_dump($message->body); $resolver->acknowledge($message); }, [ 'routing' => '', 'exchange' => 'amq.fanout', 'exchange_type' => 'fanout', 'queue_force_declare' => true, 'queue_exclusive' => true, 'persistent' => true // required if you want to listen forever ]);
鸣谢
许可证
本软件包是开源软件,根据 MIT 许可证 发布