Discover RabbitMQ with Symfony 5

"&lt;p&gt;I have been working on a project (a game) with my friends and we faced some performance issues when it comes to players logs.&lt;br /&gt; We needed to log every action of the player also we needed to call some services remotely at the same time.&lt;br /&gt; We&amp;rsquo;ve thought about using an asynchronous middleware that we can implement between our Node Js server and our backend.&lt;br /&gt; After some research we found RabbitMQ a middleware message oriented and asynchronous.&lt;/p&gt; &lt;h2&gt;&lt;strong&gt;What is RabbitMQ? &lt;/strong&gt;&lt;/h2&gt; &lt;p&gt;RabbitMQ is a messaging broker - an intermediary for messaging. It gives your applications a common platform to send and receive messages, and your messages a safe place to live until received.&lt;br /&gt; Also, it&amp;rsquo;s lightweight and easy to deploy on premises and in the cloud. It supports multiple messaging protocols (AMQP, MQTT STOMP)&lt;/p&gt; &lt;p&gt;In this short post, we will setup RabbitMQ in a Symfony 5 project using the messenger component of Symfony. We already published a tutorial that clarify all the steps above and more : &lt;a href=&quot;https://devbrains.tn/tutorials/discover-rabbitmq-with-symfony-5-project&quot;&gt;RabbitMQ Tutorial&lt;/a&gt;&lt;/p&gt; &lt;h2&gt;&lt;strong&gt;What is Symfony messenger Component?&lt;/strong&gt;&lt;/h2&gt; &lt;p&gt;Messenger centers around two different classes that you&amp;#39;ll create:&lt;/p&gt; &lt;p&gt;1- A message class that holds data&lt;/p&gt; &lt;p&gt;2- A handler(s) class that will be called when that message is dispatched. The handler class will read the message class and perform one or more tasks.&lt;/p&gt; &lt;h3&gt;&lt;strong&gt;Requirements: &lt;/strong&gt;&lt;/h3&gt; &lt;p&gt;1- Symfony (we will use the version 5.4)&lt;/p&gt; &lt;p&gt;2- Messenger Component&lt;/p&gt; &lt;p&gt;3- RabbitMQ Instance&lt;/p&gt; &lt;p&gt;4- AMQP Protocol defined and configured in php.ini (&lt;a href=&quot;https://devbrains.tn/tutorials/how-to-fix-amqp-extension-is-not-installed&quot;&gt;Tutorial&lt;/a&gt;)&lt;/p&gt; &lt;p&gt;&amp;nbsp;&lt;/p&gt; &lt;h3&gt;&lt;strong&gt;Creating our Symfony 5.4 Project:&lt;/strong&gt;&lt;/h3&gt; &lt;pre&gt; &lt;code&gt;symfony new rabbitmq-demo --version=5.4 &amp;ndash;full&lt;/code&gt;&lt;/pre&gt; &lt;p&gt;&lt;strong&gt;Installing Messenger Component: &lt;/strong&gt;&lt;/p&gt; &lt;pre&gt; &lt;code&gt;composer require messenger&lt;/code&gt;&lt;/pre&gt; &lt;p&gt;&lt;strong&gt;Create your RabbitMQ instance:&lt;/strong&gt;&lt;/p&gt; &lt;p&gt;1- Create your RabbitMQ Instance on&amp;nbsp;&lt;a href=&quot;https://www.cloudamqp.com/&quot;&gt;cloudamqp.com&lt;/a&gt;.&lt;/p&gt; &lt;p&gt;2- Next, via the RabbitMQ manager visit the queue tab and add a queue.&lt;/p&gt; &lt;p&gt;To communicate With RabbitMQ we need to a protocol named AMQP.&lt;/p&gt; &lt;p&gt;&lt;strong&gt;What is AMQP? &amp;nbsp;&lt;/strong&gt;&lt;/p&gt; &lt;p&gt;AMQP (for Advanced Message Queuing Protocol) is an open protocol for middleware-oriented messaging systems developed by the JPMorgan Chase1 bank. The objective of AMQP is to standardize exchanges between message servers based on the following principles: oriented message, use of queues, routing (point to point and publish-subscribe), reliability, and security.&lt;/p&gt; &lt;p&gt;We already published a tutorial to simplify this task: &lt;a href=&quot;https://devbrains.tn/tutorials/how-to-fix-amqp-extension-is-not-installed&quot;&gt;How to Fix AMQP extension is not installed&lt;/a&gt;&amp;nbsp;&lt;/p&gt; &lt;p&gt;&lt;strong&gt;Define the Structure of the message&lt;/strong&gt;&lt;/p&gt; &lt;p&gt;We need to define the structure of our message so we will create an entity via maker bundle:&lt;/p&gt; &lt;pre&gt; &lt;code&gt;php bin/console make entity&lt;/code&gt;&lt;/pre&gt; &lt;p&gt;Entity name&amp;nbsp;: MyMessage&lt;/p&gt; &lt;p&gt;Attribute 1&amp;nbsp;: Sender (String,255, nullable)&lt;/p&gt; &lt;p&gt;Attribute 2&amp;nbsp;: Receiver (String,255, nullable)&lt;/p&gt; &lt;p&gt;Attribute 3&amp;nbsp;:&amp;nbsp; content (String,255, nullable)&lt;/p&gt; &lt;p&gt;&lt;strong&gt;Communicate RabbitMQ with our Symfony Application:&lt;/strong&gt;&lt;/p&gt; &lt;p&gt;We need to copy the information of our instance (user,password,host..) in the .env:&lt;/p&gt; &lt;pre&gt; &lt;code&gt;MESSENGER_TRANSPORT_DSN=amqp://USER:PASSWORD@HOSTNAME.rmq.cloudamqp.com/USER/QUEUE_NAME&lt;/code&gt; &lt;/pre&gt; &lt;p&gt;&lt;strong&gt;Configure our Messenger Component:&lt;/strong&gt;&lt;/p&gt; &lt;pre&gt; &lt;code&gt;framework: messenger: transports: async: &amp;#39;%env(MESSENGER_TRANSPORT_DSN)%&amp;#39; routing: # Route your messages to the transports &amp;#39;App\Entity\MyMessage&amp;#39;: async&lt;/code&gt; &lt;/pre&gt; &lt;h3&gt;&lt;strong&gt;Send messages to RabbitMQ:&lt;/strong&gt;&lt;/h3&gt; &lt;p&gt;Now we will create a controller via make bundle&lt;/p&gt; &lt;pre&gt; &lt;code&gt;&lt;kbd&gt;php bin/console make:controller&lt;/kbd&gt;&lt;/code&gt;&lt;/pre&gt; &lt;p&gt;Controller Name : HomeController&lt;/p&gt; &lt;p&gt;Next, we&amp;#39;ll instantiate an object from our Entity MyMessage and using our dispatch method defined in our MessageBusInterface, we&amp;#39;ll send the message to our RabbitMQ queue.&lt;/p&gt; &lt;pre&gt; &lt;code&gt;&amp;lt;?php namespace App\Controller; use App\Entity\MyMessage; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Messenger\MessageBusInterface; use Symfony\Component\Routing\Annotation\Route; class HomeController extends AbstractController { /** * @Route(&amp;quot;/home&amp;quot;, name=&amp;quot;home&amp;quot;) */ public function index(MessageBusInterface $bus): Response { $message= new MyMessage(); $message-&amp;gt;setSender(&amp;quot;John&amp;quot;); $message-&amp;gt;setReceiver(&amp;quot;Jack&amp;quot;); $message-&amp;gt;setContent(&amp;quot;Hello&amp;quot;); $bus-&amp;gt;dispatch($message); return new Response(&amp;quot;Message sent&amp;quot;); } }&lt;/code&gt; &lt;/pre&gt; &lt;p&gt;Now let&amp;rsquo;s run our web server:&lt;/p&gt; &lt;pre&gt; &lt;code&gt;Symfony server:start&lt;/code&gt;&lt;/pre&gt; &lt;p&gt;If everything is done correctly, we should see in the tab overview in our RabbitMQ instance a message queued.&lt;/p&gt; &lt;p&gt;&lt;strong&gt;Consuming the messages:&lt;/strong&gt;&lt;/p&gt; &lt;p&gt;To consume the messages, we need to add a handler that will handle our message when consuming.&lt;/p&gt; &lt;pre&gt; &lt;code&gt;&amp;lt;?php namespace App\MessageHandler; use App\Entity\MyMessage; use Symfony\Component\Messenger\Handler\MessageHandlerInterface; class MyMessageHandler implements MessageHandlerInterface { public function __invoke(MyMessage $message) { echo &amp;quot;Welcome to MyMessage Handler \n&amp;quot;; echo $message-&amp;gt;getContent().&amp;quot;\n&amp;quot; ; } }&lt;/code&gt; &lt;/pre&gt; &lt;p&gt;Finally it&amp;rsquo;s time to consume the queued messages via the command :&lt;/p&gt; &lt;pre&gt; &lt;code&gt;php bin/console messenger:consume -v&lt;/code&gt;&lt;/pre&gt; &lt;p&gt;That&amp;rsquo;s it 😊&lt;/p&gt; &lt;p&gt;I hope everything works as expected, if you have any question don&amp;rsquo;t hesitate to ask on our &lt;a href=&quot;https://devbrains.tn/forum&quot;&gt;forum&lt;/a&gt;.&lt;/p&gt; &lt;p&gt;Some Useful Resources :&amp;nbsp;&lt;/p&gt; &lt;p&gt;Repository Link : &lt;a href=&quot;https://github.com/HoussemTN/rabbitmq-demo&quot;&gt;RabbitMQ-demo&lt;/a&gt;&lt;br /&gt; RabbitMQ&amp;nbsp;Tutorials : &lt;a href=&quot;https://www.rabbitmq.com/getstarted.html&quot;&gt;RabbitMQ Docs&lt;/a&gt;&lt;/p&gt; &lt;p&gt;&amp;nbsp;&lt;/p&gt;"

Discover RabbitMQ with Symfony 5

Share