The use of multiple servers with dedicated functionality can communicate with each other through API and notifications.
Overview
Example where a backend server that performs a task followed by notification to user via Email, while to another server through PUSH notification.
In a simple description on its usage;
- A producer: Sends a message to RabbitMQ with a specified exchange (direct, topic, or fanout) and queue(s) name.
- RabbitMQ: Places the message to the queue(s).
- A consumer: Configured to retrieve message from a queue.
- A consumer: Check and retrieve message from the queue.
- RabbitMQ: Remove message from the queue
Communication with RabbitMQ can be simplified through the library amqplib that implements the machinery needed to make clients for AMQP 0-9-1.
Steps
- Install RabbitMQ
- Configure RabbitMQ
- Add RabbitMQ package in a Laravel project
- Create a service of Laravel jobs or other automated function
- Create Laravel controller to publish and consume messages
- Tinker to test Producer
- Tinker to test Consumer
Install RabbitMQ
Lets imagine following environment;
- RabbitMQ server: IP 10.1.1.101
- Producer server: IP 10.1.1.102
- Consumer server: IP 10.1.1.103
On RabbitMQ, ensure PHP is installed, including the package socket. On this example, SELINUX is enabled.
On RabbitMQ, install the server application.
curl -s https://packagecloud.io/install/repositories/rabbitmq/rabbitmq-server/script.rpm.sh | sudo bashcurl -s https://packagecloud.io/install/repositories/rabbitmq/erlang/script.rpm.sh | sudo bashsudo yum makecache -y --disablerepo='*' --enablerepo='rabbitmq_rabbitmq-server'
sudo yum -y --disablerepo='*' --enablerepo='rabbitmq_rabbitmq-server' --enablerepo='rabbitmq_erlang' install rabbitmq-server
rpm -qi rabbitmq-server
Name : rabbitmq-server
Version : 3.13.0
Release : 1.el8
Architecture: noarch
Version : 3.13.0
Release : 1.el8
Architecture: noarch
Configure the server
By default, RabbitMQ uses port 5672, and for the web administration port 15672. Update the server hosts file with its domain name and enable the web based management
echo "127.0.0.1 rabbitmq.demo" | sudo tee -a /etc/hostssudo systemctl enable --now rabbitmq-server.servicesudo rabbitmqctl statussudo rabbitmq-plugins enable rabbitmq_managementss -tunelp | grep 15672sudo firewall-cmd --add-port={5672,15672}/tcp --permanentsudo firewall-cmd --reload
Verify access: Open URL http://rabbitmq.demo:15672 on a web browser. Then ensure tall feature flags are viewable.
rabbitmqctl list_feature_flags
rabbitmqctl enable_feature_flag all
Create users
Create the initial administrator user as admin and a password.
sudo rabbitmqctl add_user admin SECRETPASSWORD
sudo rabbitmqctl set_user_tags admin administrator
sudo yum -y --disablerepo='pgdg*' install mlocate
sudo updatedb
Create user to access from Producer and Consumer.
sudo rabbitmqctl add_user user1 SECRETPASSWORD
sudo rabbitmqctl set_user_tags user1 management,monitoring
Laravel support for rabbitmq
Create or use an existing laravel project.
composer require php-amqplib/php-amqplibcomposer updatesudo semanage port -a -t http_port_t -p tcp 5672
Edit Laravel's .env file:
RABBITMQ_HOST=mem.hqcloakRABBITMQ_IP=10.1.1.101RABBITMQ_PORT=5672RABBITMQ_VHOST="/"RABBITMQ_LOGIN=user1RABBITMQ_PASSWORD=SECRETPASSWORDRABBITMQ_QUEUE="queue1"
Laravel rabbitmq service
Create the file in app\Services\RabbitMQService.php . No examples is provided for usage of this service.
<?php
namespace App\Services;
use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Connection\AMQPSSLConnection;
use PhpAmqpLib\Message\AMQPMessage;
use PhpAmqpLib\Exchange\AMQPExchangeType;
use Illuminate\Support\Facades\Log;
class RabbitMQService
{
protected $connection;
protected $channel;
protected $exchange = 'amq.topic';
protected $queue = null;
protected $routingKey = 'routing_key';
protected $status = true;
public function __construct()
{
$this->connection = new AMQPStreamConnection(
env('RABBITMQ_HOST'),
env('RABBITMQ_PORT'),
env('RABBITMQ_LOGIN'),
env('RABBITMQ_PASSWORD'),
env('RABBITMQ_VHOST')
);
$this->channel = $this->connection->channel();
/*
name: $exchange
type: direct
passive: false // don't check if an exchange with the same name exists
durable: false // the exchange will not survive server restarts
auto_delete: true // the exchange will be deleted once the channel is closed.
*/
$this->channel->exchange_declare($this->exchange, 'topic', false, true, false);
/*
name: $queue // should be unique in fanout exchange. Let RabbitMQ create
// a queue name for us
passive: false // don't check if a queue with the same name exists
durable: false // the queue will not survive server restarts
exclusive: true // the queue can not be accessed by other channels
auto_delete: true // the queue will be deleted once the channel is closed.
*/
$queue = env('RABBITMQ_QUEUE', 'queue1');
$this->init($queue, 'routing_key');
}
public function init($queue, $routing)
{
$this->queue = $queue;
$this->routingKey = $routing;
$this->channel->queue_declare($this->queue, false, true, false, false);
$this->channel->queue_bind($this->queue, $this->exchange, $this->routingKey);
}
/**
* custom message format: code | value | extradata
*/
public function publish($message)
{
if (null == $this->queue) {
return;
}
$msg = new AMQPMessage($message);
$this->channel->basic_publish($msg, $this->exchange, $this->routingKey);
}
public function stop()
{
$this->status = false;
}
public function consume($callback)
{
if (null == $this->queue) {
return;
}
/*
queue: Queue from where to get the messages
consumer_tag: Consumer identifier
no_local: Don't receive messages published by this consumer.
no_ack: If set to true, automatic acknowledgement mode will be used by this consumer. See https://www.rabbitmq.com/confirms.html for details.
exclusive: Request exclusive consumer access, meaning only this consumer can access the queue
nowait: don't wait for a server response. In case of error the server will raise a channel
exception
callback: A PHP Callback
*/
$this->channel->basic_consume($this->queue, 'test', false, true, false, false, $callback);
while ($this->channel->is_consuming()) {
if (false == $this->status) {
break;
}
$this->channel->wait();
}
}
public function __destruct()
{
$this->channel->close();
$this->connection->close();
}
}
Create Laravel Controller
On the server Producer and Consumer create controller that can publish or consume, with the file app\Http\Controllers\RabbitMQController.php
<?php
namespace App\Http\Controllers;
use App\Services\RabbitMQService;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log;
class RabbitMQController extends Controller
{
public function publishMessage(Request $request)
{
$message = $request->message;
$result = $this->publish($message);
return response('Message published to RabbitMQ');
}
public function publish($message)
{
$rabbitMQService = new RabbitMQService();
$rabbitMQService->publish($message);
return response('Message published to RabbitMQ');
}
public function consumeMessage()
{
$rabbitMQService = new RabbitMQService();
$callback = function ($msg) {
echo "Received message: " . $msg->body . "\n";
};
$rabbitMQService->consume($callback);
}
public function consume()
{
$rabbitMQService = new RabbitMQService();
$callback = function ($msg) {
$data = $msg->body;
echo "Received:".$data;
};
$rabbitMQService->consume($callback);
}
}
Create a tinker to test Producer
On server Producer, create the file ./tinker-producer.php
$controller = app()->make('App\Http\Controllers\API\RabbitMQController');$results = app()->call([$controller, 'publish'], ['message'=>'1001|ACTION|VALUE'] );print( "$results");
Run tinker
more tinker-producer.php | php artisan tinker
On RabbitMQ web console, observer creation of the queue and the message.
Create a tinker to test Consumer
On server Consumer, create the file ./tinker-consumer.php
$controller = app()->make('App\Http\Controllers\RabbitMQController');$results = app()->call([$controller, 'consume'],[] );print( "$results");
Run tinker
more tinker-consumer.php | php artisan tinker
On RabbitMQ web console, observer queue and message consumed.
