bschmitt / laravel-amqp
AMQP wrapper for Laravel and Lumen to publish and consume messages
Installs: 1 707 196
Dependents: 7
Suggesters: 0
Security: 0
Stars: 270
Watchers: 11
Forks: 86
Open Issues: 29
Requires
- php: ^7.3|^8.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
AMQP wrapper for Laravel and Lumen to publish and consume messages especially from RabbitMQ
Features
- Advanced queue configuration
- Add message to queues easily
- Listen queues with useful options
Installation
Composer
Add the following to your require part within the composer.json:
"bschmitt/laravel-amqp": "2.*" (Laravel >= 5.5) "bschmitt/laravel-amqp": "1.*" (Laravel < 5.5)
$ php composer update
or
$ php composer require bschmitt/laravel-amqp
Integration
Lumen
Create a config folder in the root directory of your Lumen application and copy the content from vendor/bschmitt/laravel-amqp/config/amqp.php to config/amqp.php.
Adjust the properties to your needs.
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 ], ], ];
Register the Lumen Service Provider in bootstrap/app.php:
/* |-------------------------------------------------------------------------- | Register Service Providers |-------------------------------------------------------------------------- */ //... $app->configure('amqp'); $app->register(Bschmitt\Amqp\LumenServiceProvider::class); //...
Add Facade Support for Lumen 5.2+
//... $app->withFacades(true, [ 'Bschmitt\Amqp\Facades\Amqp' => 'Amqp', ]); //...
Laravel
Open config/app.php and add the service provider and alias:
'Bschmitt\Amqp\AmqpServiceProvider',
'Amqp' => 'Bschmitt\Amqp\Facades\Amqp',
Publishing a message
Push message with routing key
Amqp::publish('routing-key', 'message');
Push message with routing key and create queue
Amqp::publish('routing-key', 'message' , ['queue' => 'queue-name']);
Push message with routing key and overwrite properties
Amqp::publish('routing-key', 'message' , ['exchange' => 'amq.direct']);
Consuming messages
Consume messages, acknowledge and stop when no message is left
Amqp::consume('queue-name', function ($message, $resolver) { var_dump($message->body); $resolver->acknowledge($message); $resolver->stopWhenProcessed(); });
Consume messages forever
Amqp::consume('queue-name', function ($message, $resolver) { var_dump($message->body); $resolver->acknowledge($message); });
Consume messages, with custom settings
Amqp::consume('queue-name', function ($message, $resolver) { var_dump($message->body); $resolver->acknowledge($message); }, [ 'timeout' => 2, 'vhost' => 'vhost3' ]);
Fanout example
Publishing a message
\Amqp::publish('', 'message' , [ 'exchange_type' => 'fanout', 'exchange' => 'amq.fanout', ]);
Consuming messages
\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 ]);
Credits
- Some concepts were used from https://github.com/mookofe/tail
License
This package is open-sourced software licensed under the MIT license