https://github.com/kunalvarma05/laravel-rabbitmq
🐰 An easy to use Laravel package for working with RabbitMQ.
https://github.com/kunalvarma05/laravel-rabbitmq
laravel php rabbitmq
Last synced: 6 months ago
JSON representation
🐰 An easy to use Laravel package for working with RabbitMQ.
- Host: GitHub
- URL: https://github.com/kunalvarma05/laravel-rabbitmq
- Owner: kunalvarma05
- License: mit
- Created: 2020-02-22T13:40:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T05:49:46.000Z (over 2 years ago)
- Last Synced: 2025-11-05T15:18:37.526Z (9 months ago)
- Topics: laravel, php, rabbitmq
- Language: PHP
- Homepage:
- Size: 341 KB
- Stars: 18
- Watchers: 2
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel RabbitMQ
[](https://packagist.org/packages/kunalvarma05/laravel-rabbitmq)
[](https://github.styleci.io/repos/242348127)
[](https://scrutinizer-ci.com/g/kunalvarma05/laravel-rabbitmq)
[](https://packagist.org/packages/kunalvarma05/laravel-rabbitmq)
An easy-to-use Laravel package for working with RabbitMQ.
## Features
- Producers
- Consumers
- Publish / Subscribe
- Exchanges
- Default
- Direct
- Topic
- Fanout
## Requirements
- PHP 7.4+
- Laravel 6.0+
## Setup
### 1. Installation
```sh
composer require kunalvarma05/laravel-rabbitmq
```
### 2. Default Configuration
```sh
php artisan vendor:publish --tag=config
```
## Quick Start
### **Initialize**
There are multiple ways of initializing the library:
```php
// A. Direct instantiation
$rabbitMQ = new RabbitMQManager(app());
// B. Binding
$rabbitMQ = app('rabbitmq');
// C. Dependency injection (Controller, Command, Job, etc.)
public function __consturct(RabbitMQManager $rabbitMQ) { ... }
// D. Facade
// All the public methods of the `RabbitMQManager` class
// are available through the `RabbitMQ` facade.
RabbitMQ::getConnections();
```
### **Publish**
```php
$message = new RabbitMQMessage('message body');
// Publish to the default exchange/topic/queue
$rabbitMQ->publisher()->publish($message);
// Publish bulk messages
$messages = [new RabbitMQMessage('message 1'), new RabbitMQMessage('message 2')];
$rabbitMQ->publisher()->publish($messages);
```
### **Consume**
```php
// A. Consume through a closure
$handler = new RabbitMQGenericMessageConsume(function (RabbitMQIncomingMessage $message) {
$content = $message->getStream();
});
// B. Consume through a class
class MyMessageConsumer extends RabbitMQMessageConsumer {
public function handle(RabbitMQIncomingMessage $message) {
$content = $message->getStream();
}
}
$handler = new MyMessageConsumer();
// Starts a blocking loop `while (true)`
$rabbitMQ->consumer()->consume($handler);
```
### **Interact**
```php
// Resolve the default connection
// @see: AMQPSSLConnection https://github.com/php-amqplib/php-amqplib/blob/master/PhpAmqpLib/Connection/AMQPSSLConnection.php
$amqpConnection = $rabbitMQ->resolveConnection();
// Resolve the default channel
// @see: AMQPChannel https://github.com/php-amqplib/php-amqplib/blob/master/PhpAmqpLib/Channel/AMQPChannel.php
$amqpChannel = $rabbitMQ->resolveChannel();
```
### **Configuration**
#### Connection Configuration
```php
$connectionName = 'custom_connection'; // Set to `null` for default connection
// Override the default connection config
$connectionConfig = new ConnectionConfig(['username' => 'quest', 'password' => 'quest']);
$connectionConfig->setHost('localhost');
$customConnection = $rabbitMQ->resolveConnection($connectionName, $connectionConfig);
```
#### Message Configuration
```php
$config = [
'content_encoding' => 'UTF-8',
'content_type' => 'text/plain',
'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT,
];
$message = new RabbitMQMessage('message body', $config);
// Set message exchange
$exchangeConfig = ['type' => AMQPExchangeType::DIRECT];
$exchange = new RabbitMQExchange('my_exchange', $exchangeConfig);
$message->setExchange($exchange);
```
#### Publish Configuration
```php
$publisher = $rabbitMQ->publisher();
$message = new RabbitMQMessage('message body');
$exchangeConfig = ['type' => AMQPExchangeType::TOPIC];
$exchange = new RabbitMQExchange('my_exchange', $exchangeConfig);
$message->setExchange($exchange);
$routingKey = 'key'; // Can be an empty string, but not null
$connectionName = 'custom_connection'; // Set to null for default connection
// The publish config allows you to any override default configuration
//
// The following precendence works for the configuration:
// Message exchange config > Publish config > Connection config > Default config
//
// In this case, the exchange type used would be AMQPExchangeType::TOPIC
$publishConfig = new PublishConfig(['exchange' => ['type' => AMQPExchangeType::FANOUT]]);
$publisher->publish($message, $routingKey, $connectionName, $publishConfig);
```
#### Consumer Configuration
```php
$consumer = $rabbitMQ->consumer();
$routingKey = 'key';
$exchange = new RabbitMQExchange('test_exchange', ['declare' => true, 'durable' => true]);
$queue = new RabbitMQQueue('my_queue', ['declare' => true, 'durable' => true]);
$messageConsumer = new RabbitMQGenericMessageConsumer(
function (RabbitMQIncomingMessage $message) {
// Acknowledge a message
$message->getDelivery()->acknowledge();
// Reject a message
$requeue = true; // Reject and Requeue
$message->getDelivery()->reject($requeue);
},
$this,
);
// A1. Set the exchange and the queue directly
$messageConsumer
->setExchange($exchange)
->setQueue($queue);
// OR
// A2. Set the exchange and the queue through config
$consumeConfig = new ConsumeConfig(
[
'queue' => [
'name' => 'my_queue',
'declare' => true,
'durable' => true,
],
'exchange' => [
'name' => 'test_exchange',
'declare' => true,
],
],
);
$consumer->consume(
$messageConsumer,
$routingKey,
null,
$consumeConfig,
);
```
## **Example**
### Running a Consumer
- Create a custom command:
```sh
php artisan make:command MyRabbitConsumer --command "rabbitmq:my-consumer {--queue=} {--exchange=} {--routingKey=}"
```
- Register the command in `app/Console/Kernel.php`
```php
protected $commands = [
MyRabbitConsumer::class,
];
```
- Consume through the handler
```php
info($message->getStream()); // Print to console
},
$this, // Scope the closure to the command
);
$routingKey = $this->option('routingKey') ?? '';
$queue = new RabbitMQQueue($this->option('queue') ?? '', ['declare' => true]);
$exchange = new RabbitMQExchange($this->option('exchange') ?? '', ['declare' => true]);
$messageConsumer
->setExchange($exchange)
->setQueue($queue);
$rabbitMQ->consumer()->consume($messageConsumer, $routingKey);
}
}
```
- Call the command from the console
```sh
php artisan rabbitmq:my-consumer --queue='my_queue' --exchange='test_exchange' --routingKey='key'
```
### Publishing Messages
- Create route <-> controller binding
```php
Route::get('/publish', 'MyRabbitMQController@publish');
```
- Create a controller to publish message
```php
class MyRabbitMQController extends Controller {
public function publish(Request $request)
{
$rabbitMQ = app('rabbitmq');
$consumer = $rabbitMQ->consumer();
$routingKey = 'key'; // The key used by the consumer
// The exchange (name) used by the consumer
$exchange = new RabbitMQExchange('test_exchange', ['declare' => true]);
$contents = $request->get('message', 'random message');
$message = new RabbitMQMessage($contents);
$message->setExchange($exchange);
$rabbitMQ->publisher()->publish(
$message,
$routingKey
);
return ['message' => "Published {$contents}"];
}
}
```
- Make a request or browse to: `http://localhost:8000/publish?message=Hello`
- Check your console for the message `Hello` to be printed
## Tests
```php
composer run-script test
```
## Credits
- [Kunal Varma](https://github.com/kunalvarma05)
- [All Contributors](https://github.com/kunalvarma05/laravel-rabbitmq/contributors)
- [PHP AMQP Lib](https://github.com/php-amqplib/php-amqplib)
- [PHP AMQ Package](https://github.com/ssi-anik/amqp)
## License
The MIT License (MIT). Please see [License File](./LICENSE.md) for more information.