Spring AMQP / RabbitMQ Topic Exchange Example Part 1 – Producer Application

As we are already aware, there are four types of RabbitMQ message exchanges are available.  They can be listed as follows.

  1. Direct Exachange
  2. Topic Exchange
  3. Fanout Exchange
  4. Header Exchange

In this Article, we are going to look at Topic exchange.

What is Topic Exchange?

Same as Direct, but wildcards are allowed in the binding key. ‘#‘ matches zero or more dot-delimited words and ‘*‘ matches exactly one such word.

  • * (star) can substitute for exactly one word.
  • # (hash) can substitute for zero or more words.

Topic exchanges route messages to one or many queues based on matching between a message routing key and the pattern that was used to bind a queue to an exchange. The topic exchange type is often used to implement various publish/subscribe pattern variations. Topic exchanges are commonly used for the multicast routing of messages.

Here is what we are going to do

 

Screen Shot 2017-11-12 at 4.56.34 AM.png

 

In this example we are trying to sort the messages and direct into the right queue based on the manufacturer of the car. we will be getting a huge amount of messages about registered cars in the city. The routing key pattern of every message is as follows.

manufacturer_name.car.type

As you can see, we have created a Topic exchange called vehicle_exchange. In addition, we have created three queues and bound them to the Topic exchange (vehicle_exchange) with following binding keys.

  • toyota_cars_queue  ( binding key – toyota.cars.* )

toyota_cars_queue is bound to the exchange with wildcard biding key toyota.cars.*  This means that the any message starting with routing key toyota.cars and ending with exactly any text should be directed to this queue (toyota_cars_queue).

  • nissan_cars_queue  ( binding key – nissan.cars.* )

In the same way, any message starting with routing key nissan.cars and ending with exactly any text should be directed to the nissan_cars_queue.

  • all_cars_queue  ( binding key – *.cars.#)

According to the binding key, the routing key should start with any text (exactly one) and followed by cars keyword. it can be ended with zero or more texts.

e.g:-  The following set of routing keys can be identified as valid routing key for this binding pattern.

nissan.cars ,  toyota,cars  , any.cars  , anything.cars.everything , anything.cars.anything.and.everything

The following table will show you a list of routing keys and their destination queue(s)

 

routing key delivered to queue(s)
nissan.cars.japan nissan_cars_queue and all_cars_queue
nissan.cars all_cars_queue
toyota.cars.japan.manufactured all_cars_queue
japan.toyota.cars No matching queue. message will be discard
import.nissan.cars.from.japan No matching queue. message will be discard
toyota.cars.manufatured toyota_cars_queue and all_cars_queue
no.latest.cars.toyota No matching queue. message will be discard

Now i believe that you have a clear understanding of how these wildcard binding keys are working with topic exchange.

 

Topic exchange : More to consider

Topic exchange is powerful and can behave like other exchanges.

When a queue is bound with “#” (hash) binding key – it will receive all the messages, regardless of the routing key – like in fanout exchange.

When special characters “*” (star) and “#” (hash) aren’t used in bindings, the topic exchange will behave just like a direct one.

 

Setting UP RabbitMQ Server

 

  • Creating the exchange

Screen Shot 2017-11-12 at 2.07.48 AM.png

 

  • Creating the toyota_cars_queue and bind it to the vehicle_exchange.

Screen Shot 2017-11-12 at 2.33.41 AM.png

 

Screen Shot 2017-11-12 at 2.35.05 AM.png

 

  • Creating the nissan_cars_queue and bind it to the vehicle_exchange.

 

Screen Shot 2017-11-12 at 2.37.40 AM.png

 

Screen Shot 2017-11-12 at 2.38.41 AM.png

 

  • Creating the all_cars_queue and binding it to the vehicle_exchange

 

Screen Shot 2017-11-12 at 2.39.41 AM.png

 

Screen Shot 2017-11-12 at 2.40.13 AM.png

 

Now we have created all  three queues and bound them to the Topic exchange that we have created. Now it is the time to develop a publisher and subscriber application for publish and receive messages from this RabbitMQ server set up.

 

Producer and Consumer Application

Before moving forward, i need to inform you that the fully source code for the Producer and Consumer application can be found at GitHub. You may clone the source code and continue with the article.

click here to download the source code of the application

 

Producer Application

Here is the project structure of the Producer Application.

Screen Shot 2017-11-12 at 2.14.26 PM.png

 

first make sure that you have defined the valid RabbitMQ server details in the application.properties file. These information will be used by the ConnectionFactory class to make a connection with RabbitMQ server when the RabbitTemplate is used.

 

 

Now check whether you have declared/configured the required beans to use Spring AMQP feature with RabbitMQ.

 

As i have mentioned earlier, ConnectionFactory will use the RabbitMQ server details declared in the application.properties to make a connection with RabbitMQ server when the RabbitTemplate is used.

We will be trying to send the POJO instance ( Car object) as the message body. we cannot send it as a java object and we need to convert it into some other common exchange format. We have chosen the JSON as the common exchange format and   RabbitTemplate will use the  Jackson2JsonMessageConverter as a the message converter for converting the POJO into the JSON format.

 

Now we will look at the ProducerService

 

As per the above table. we are having seven routing keys and we are going to publish messages with those routing keys to the exchange called “vehicle_exchange“.  When you run the Producer application, the output will be something like below.

mvn spring-boot:run

 

Screen Shot 2017-11-12 at 6.03.53 PM.png

Now all the messages are published to the RabbitMQ server. So we can check whether the messages are delivered to the relevant queues.

Screen Shot 2017-11-12 at 6.05.41 PM.png

Now we are done with the Producer application for publishing messages for RabbitMQ Topic exchange.  Fully source code (both producer and consumer) of this article can be found at GitHub.  If you need further explanation of writing RabbitMQ consumer application, it is highly recommended to look at one of the below articles.

2 thoughts on “Spring AMQP / RabbitMQ Topic Exchange Example Part 1 – Producer Application

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s