README

This package allows your laravel applications to easily communicate with each other in an event driven way.

One service can publish an event and another one can consume the event and take actions accordingly.

Installation

You can install the package via composer:

composer require mhfereydouni/laravel-rabbitmq-communication

Then you should publish the package config with running this command:

php artisan vendor:publish --tag="laravel-rabbitmq-communication-config"

This is the contents of the published config file:

<?php

return [
    'host' => env('RABBITMQ_HOST', '127.0.0.1'),
    'port' => env('RABBITMQ_PORT', 5672),
    'user' => env('RABBITMQ_USER', 'guest'),
    'password' => env('RABBITMQ_PASSWORD', 'guest'),
    'vhost' => env('RABBITMQ_VHOST', '/'),

    'event-consumers' => [
//        [
//            'event' => '\App\Events\MyEvent',
//            'routing_key' => 'my_routing_key', // if this event does not use routing key then remove this line
//            'map_into' => '\App\Events\MapIntoEvent', // if you want to use the same event then remove this line
//        ],
    ],

    /** -----------------------------------------------
     * options: 'sync', 'kind-sync', 'job'
     * sync: event are fired when they are consumed and error will stop the consumer
     * kind-sync: event are fired when they are consumed and error will not stop the consumer instead a log is stored
     * job: events are fired in a queue via laravel jobs (Note: you should make sure there is a queue worker for queue)
     */
    'event-consumer-mode' => 'sync',

    'log-channel' => env('RABBITMQ_LOG_CHANNEL', env('LOG_CHANNEL', 'stack')),

    'queue-name' => 'default',
];

Usage

Mark an event to be published on RabbitMQ

The only thing you must do is to make sure your event implements MHFereydouni\RabbitMQ\Support\ShouldPublish interface and that's it. All of the event's public properties will be published, and you can have access to them in your consumer. Make sure these properties are primitive or Arrayable.

If you want your event to be published using a routing key, then consider adding routingKey method to your event:

    public function routingKey(): string
    {
        return 'routing_key';
    }

declare exchanges in rabbitmq server

php artisan rabbitmq:declare-event-exchanges

When a laravel application wants to publish events, you must run this command to create appropriate exchanges on RabbitMQ (Exchanges will be created only for events specified in event service provider). For each event it will create an exchange with the name of event class. You can read more on exchanges types here.

The default type for exchanges will be 'fanout'. If you want to alter the type of exchange for an event you can add this property to your event:

    private static string $exchangeType = 'topic';

Consume events from RabbitMQ

In the rabbitmq.php config file you should list all the events you want to consume.

    'event-consumers' => [
//        [
//            'event' => '\App\Events\MyEvent',
//            'routing_key' => 'my_routing_key', // if this event does not use routing key then remove this line
//            'map_into' => '\App\Events\MapIntoEvent', // if you want to use the same event then remove this line
//        ],
    ],

If you have same event in both services (publisher and consumer) then you can omit the map_into option for the event.

Then you can start consuming events with the following command:

php artisan rabbitmq:consume-events

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• mhfereydouni
• All Contributors

License

The MIT License (MIT). Please see License File for more information.