filld/larabbit

AMQP wrapper for Laravel and Lumen to publish and consume messages

v2.2.0 2019-04-05 19:36 UTC

Requires

• php: >=5.5.9
• illuminate/support: >=5.1
• php-amqplib/php-amqplib: 2.*

Requires (Dev)

• mockery/mockery: ~0.9
• phpunit/phpunit: ~4.0

MIT

• Björn Schmitt
• Ryan Hoshor

• queue
• package
• rabbitmq
• AMQP
• laravel
• message queue
• laravel5
• lumen
• filld

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:

"filld/larabbit": "2.*"

$ php composer update

or

$ php composer require filld/larabbit

Integration

Environment Variables

The following Env vars need to be set in your .env file:

RABBITMQ_HOST
RABBITMQ_PORT
RABBITMQ_USERNAME
RABBITMQ_PASSWORD
RABBITMQ_VHOST

# Optional SSL:
RABBITMQ_SSL_CERT_PATH

Lumen

Create a config folder in the root directory of your Lumen application and copy the content from vendor/filld/larabbit/config/amqp.php to config/amqp.php.

Adjust the properties to your needs.

return [

    'use' => 'production',

    'properties' => [

        'production' => [
            'host'                => env('RABBITMQ_HOST', 'localhost'),
            'port'                => env('RABBITMQ_PORT', 5672),
            'username'            => env('RABBITMQ_USERNAME'),
            'password'            => env('RABBITMQ_PASSWORD'),
            'vhost'               => env('RABBITMQ_VHOST'),
            'exchanges'           => [
                                         [
                                             'exchange'              => 'exchange_name',
                                             'exchange_type'         => 'topic',
                                             'exchange_passive'      => false,
                                             'exchange_durable'      => true,
                                             'exchange_auto_delete'  => false,
                                             'exchange_internal'     => false,
                                             'exchange_nowait'       => false,
                                             'exchange_properties'   => [],
                         
                                             'routing' => [
                                                 'routing.key.one',
                                                 'routing.key.two',
                                         ]
                                     ],
            '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']],
            'timeout'             => 0
        ],

    ],

];

Register the Lumen Service Provider in bootstrap/app.php:

/*
|--------------------------------------------------------------------------
| Register Service Providers
|--------------------------------------------------------------------------
*/

//...

$app->configure('amqp');
$app->register(Filld\Amqp\LumenServiceProvider::class);

//...

Enable Facade Support for Lumen 5.2+

$app->withFacades();

Laravel

Open config/app.php and add the service provider and alias:

'Filld\Amqp\AmqpServiceProvider',

'Amqp' => 'Filld\Amqp\Facades\Amqp',

Setting up SSL

Make sure you copy the CA cert chain to somewhere that you can reference. The storage/certs directory is suggested. Also, don't forget to set the SSL settings in the config:

'connect_options'     => [
    'capath' => '/etc/ssl/certs',
    'cafile' => env('RABBITMQ_SSL_CERT', storage_path() . '/certs/cacert.pem'),
    'verify_peer' => true
],

Also, don't forget that the port likely changed to 5671

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']);

Notice that if you attempt to set properties like: x-message-ttl you may get an error like the following:

AMQP-rabbit doesn't define data of type []

You must specify a type:

    Amqp::publish('routing-key', 'message', [
        'queue_properties' => [
            "x-ha-policy" => ["S", "all"],
            'x-message-ttl' => ['I', 86400000],
            'x-dead-letter-exchange' => ['S', 'orders_dead_letter'],
        ],
        'queue' => 'orders'
    ]);

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);
}, [
    'exchange' => 'amq.fanout',
    'exchange_type' => 'fanout',
    'queue_force_declare' => true,
    'queue_exclusive' => true,
    'persistent' => true// required if you want to listen forever
]);

Credits

• This project is a fork of https://github.com/bschmitt/laravel-amqp
• Some concepts were used from https://github.com/mookofe/tail

License

This package is open-sourced software licensed under the MIT license