softonic / laravel-amqp
Laravel 和 Lumen 的 AMQP 封装器,用于发布和消费消息
2.4.0
2023-10-24 10:38 UTC
Requires
- php: >=7.0
- illuminate/support: ^v9.0|^v10.0
- php-amqplib/php-amqplib: ^3.4.0
- vlucas/phpdotenv: ^5.5
Requires (Dev)
- mockery/mockery: ^1.5
- phpoption/phpoption: 1.9.x-dev
- phpunit/phpunit: ^8.0
- squizlabs/php_codesniffer: ^3.0@dev
- dev-master
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.1.0-alpha2
- 2.1.0-alpha
- 2.0.9
- 2.0.8
- 2.0.7.1
- 2.0.7
- 2.0.6
- 2.0.5
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.2.6
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- dev-dont-add-breaking-changes
- dev-feature/add-support-laravel-10
- dev-feature/remove_clear_conection_after_publish
- dev-feature/dont_close_connection_on_publish
- dev-feature/Allow-multiple-queue-bindings
- dev-bugfix/issue-56-ssl
- dev-feature/26-write-integration-tests
This package is auto-updated.
Last update: 2024-09-24 12:27:18 UTC
README
Laravel 和 Lumen 的 AMQP 封装器,用于发布和消费消息,特别是从 RabbitMQ
特性
- 高级队列配置
- 轻松将消息添加到队列中
- 使用有用的选项监听队列
安装
Composer
在 composer.json 中的 require 部分添加以下内容
"softonic/laravel-amqp": "2.*" (Laravel >= 5.5) "softonic/laravel-amqp": "1.*" (Laravel < 5.5)
$ php composer update
或
$ php composer require softonic/laravel-amqp
集成
Lumen
在 Lumen 应用程序的根目录下创建一个 config 文件夹,并将 vendor/softonic/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(Softonic\Amqp\LumenServiceProvider::class); //...
为 Lumen 5.2+ 添加 Facade 支持
//... $app->withFacades(true, [ 'Softonic\Amqp\Facades\Amqp' => 'Amqp', ]); //...
Laravel
打开 config/app.php 并添加服务提供者和别名
'Softonic\Amqp\AmqpServiceProvider',
'Amqp' => 'Softonic\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); }, [ 'exchange' => 'amq.fanout', 'exchange_type' => 'fanout', 'queue_force_declare' => true, 'queue_exclusive' => true, 'persistent' => true // required if you want to listen forever ]);
致谢
许可证
此软件包是开源软件,根据 MIT 许可证 许可。