Spring Boot and Amazon SQS: How to Send and Receive Product Objects | Spring Boot SQS Integration

🚀 Master Spring Boot & AWS!

Subscribe to Ram N Java for deep dives into Cloud-Native Java development.

SUBSCRIBE NOW

Introduction

Amazon Simple Queue Service (SQS) is a powerful, fully managed message queuing service that allows you to decouple your microservices. In this guide, we'll demonstrate how to integrate Spring Boot 3 with AWS SQS to send and receive complex Java objects (Product objects) as JSON.

Project Dependencies

To get started, you'll need the Spring Cloud AWS Starter SQS dependency in your pom.xml. We use the Bill of Materials (BOM) to manage versions easily.

<dependency>
    <groupId>io.awspring.cloud</groupId>
    <artifactId>spring-cloud-aws-starter-sqs</artifactId>
</dependency>

Step 1: Configuration

Define your AWS credentials and region in application.properties. Then, create a configuration class to initialize the SqsTemplate.

@Configuration
public class SqsConfig {
    @Bean
    public SqsTemplate sqsTemplate(SqsAsyncClient sqsAsyncClient) {
        return SqsTemplate.builder()
                .sqsAsyncClient(sqsAsyncClient)
                .build();
    }
}

Step 2: Sending Messages (Producer)

Use the SqsTemplate to send a Product object. The framework handles the serialization to JSON automatically.

public void sendMessage(Product product) {
    sqsTemplate.send(to -> to.queue("message-queue").payload(product));
}

Step 3: Receiving Messages (Consumer)

Annotate your listener method with @SqsListener. You can choose different acknowledgement modes like OnSuccess, Always, or Manual.

@SqsListener("message-queue")
public void listen(Product product) {
    System.out.println("Received: " + product.getName());
}

Understanding Acknowledgements

• OnSuccess: Message is deleted only if the method finishes without errors.
• Always: Message is deleted regardless of success or failure.
• Manual: You control exactly when the message is removed from the queue.

Conclusion

Integrating Spring Boot with AWS SQS allows your applications to communicate asynchronously and scale independently. By using SqsTemplate and @SqsListener, you reduce boilerplate code and focus on your business logic. Happy coding!