How to Use Spring AMQP with RabbitMQ: Simple Guide

To use Spring AMQP with RabbitMQ, add the spring-boot-starter-amqp dependency, configure connection settings, and create @RabbitListener methods to receive messages and RabbitTemplate to send messages. Spring AMQP simplifies RabbitMQ integration by handling connection and message conversion automatically.

Syntax

The basic syntax involves configuring Spring Boot with RabbitMQ connection details, defining queues, exchanges, and bindings, and using RabbitTemplate to send messages and @RabbitListener to receive them.

• spring.rabbitmq.host: RabbitMQ server address
• RabbitTemplate: Sends messages
• @RabbitListener: Listens for messages on queues
• Queue, Exchange, Binding: Define messaging topology

java

spring.rabbitmq.host=localhost

@Bean
Queue myQueue() {
    return new Queue("myQueue", false);
}

@Bean
DirectExchange myExchange() {
    return new DirectExchange("myExchange");
}

@Bean
Binding binding(Queue myQueue, DirectExchange myExchange) {
    return BindingBuilder.bind(myQueue).to(myExchange).with("routingKey");
}

@Autowired
private RabbitTemplate rabbitTemplate;

// Sending message
rabbitTemplate.convertAndSend("myExchange", "routingKey", "Hello RabbitMQ");

// Receiving message
@RabbitListener(queues = "myQueue")
public void receiveMessage(String message) {
    System.out.println("Received: " + message);
}

Example

This example shows a Spring Boot application that sends a message to RabbitMQ and listens for messages on a queue named myQueue. It demonstrates configuration, sending, and receiving messages.

java

import org.springframework.amqp.core.*;
import org.springframework.amqp.rabbit.annotation.EnableRabbit;
import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
@EnableRabbit
public class RabbitMqExampleApplication implements CommandLineRunner {

    @Autowired
    private RabbitTemplate rabbitTemplate;

    public static void main(String[] args) {
        SpringApplication.run(RabbitMqExampleApplication.class, args);
    }

    @Bean
    Queue myQueue() {
        return new Queue("myQueue", false);
    }

    @Bean
    DirectExchange myExchange() {
        return new DirectExchange("myExchange");
    }

    @Bean
    Binding binding(Queue myQueue, DirectExchange myExchange) {
        return BindingBuilder.bind(myQueue).to(myExchange).with("routingKey");
    }

    @Override
    public void run(String... args) throws Exception {
        System.out.println("Sending message...");
        rabbitTemplate.convertAndSend("myExchange", "routingKey", "Hello RabbitMQ");
    }

    @RabbitListener(queues = "myQueue")
    public void receiveMessage(String message) {
        System.out.println("Received message: " + message);
    }
}

Output

Sending message...
Received message: Hello RabbitMQ

Common Pitfalls

Common mistakes when using Spring AMQP with RabbitMQ include:

• Not defining queues, exchanges, or bindings properly, causing messages to be lost.
• Forgetting to enable @EnableRabbit annotation to activate listener support.
• Using incorrect routing keys that do not match bindings.
• Not configuring RabbitMQ connection properties correctly, leading to connection failures.

Always verify your queue and exchange names match between sender and listener.

java

/* Wrong: Missing @EnableRabbit annotation disables listeners */
@SpringBootApplication
public class App {
    // no @EnableRabbit here
}

/* Right: Add @EnableRabbit to enable listeners */
@SpringBootApplication
@EnableRabbit
public class App {
}

/* Wrong: Sending with wrong routing key */
rabbitTemplate.convertAndSend("myExchange", "wrongKey", "Message");

/* Right: Use correct routing key matching binding */
rabbitTemplate.convertAndSend("myExchange", "routingKey", "Message");

Quick Reference

Remember these key points when using Spring AMQP with RabbitMQ:

• Add spring-boot-starter-amqp dependency.
• Configure RabbitMQ host and credentials in application.properties.
• Define queues, exchanges, and bindings as beans.
• Use RabbitTemplate to send messages.
• Use @RabbitListener to receive messages.
• Enable listener support with @EnableRabbit.

Key Takeaways

Add spring-boot-starter-amqp and configure RabbitMQ connection to start using Spring AMQP.

Define queues, exchanges, and bindings as Spring beans to set up messaging topology.

Use RabbitTemplate to send messages and @RabbitListener to receive them.

Always enable listener support with @EnableRabbit annotation.

Match routing keys and queue names exactly to avoid message loss.