DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones AWS Cloud
by AWS Developer Relations
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones
AWS Cloud
by AWS Developer Relations
  1. DZone
  2. Software Design and Architecture
  3. Cloud Architecture
  4. Spring Boot Listener for AWS SQS With Spring Cloud

Spring Boot Listener for AWS SQS With Spring Cloud

This tutorial will demonstrate how to set up your Spring Cloud instance to listen for messages on your Amazon SQS queue.

Bill Schneider user avatar by
Bill Schneider
·
Sep. 21, 18 · Tutorial
Like (1)
Save
Tweet
Share
37.88K Views

Join the DZone community and get the full member experience.

Join For Free

Spring Cloud AWS makes it easy to create a Java method that listens for messages on an Amazon SQS queue.  Between Spring Boot and Spring Cloud, I was surprised by just how little code I needed to make all this happen.

The key is that when you have the right dependencies in your Maven POM, all you have to do is annotate your listener method with  @SqsListener:

@SqsListener("your-queue-name")
public void listen(DataObject message) {
LOG.info("!!!! received message {} {}", message.getFoo(), message.getBar());
}


The dependency on spring-cloud-starter-aws takes care of initializing everything and scanning for annotated methods.

I put a gist on Github to illustrate the full Java class and full Maven POM.

Converting Messages to Java Objects

Your listener method can accept a String as an argument, or it can convert JSON in the message into Java objects.  Spring will use Jackson to convert the incoming JSON to Java, with appropriate annotations:

@JsonCreator
public DataObject(@JsonProperty("foo") String foo, @JsonProperty("bar") String bar) {
this.foo = foo;
this.bar = bar;
}

Command Line Arguments and Authentication

You specify AWS credentials and region through Spring Boot properties. I passed these as command line arguments through Eclipse, where I was debugging locally/not on AWS:

  •  --cloud.aws.region.static=us-east-1 set my region to US East 1 (Northern VA).

  •  --cloud.aws.credentials.useDefaultAwsCredentialsChain=true tells Spring Boot to use the AWS  DefaultAWSCredentialsChain, which will pull credentials from either environment vars or  ~/.aws/credentials file.

  • I also set the environment variable  AWS_PROFILE for the default credentials chain to find my credentials under the correct profile.

If I were running in AWS itself, the EC2 instance metadata could have determined the region automatically, and also provided credentials via the instance profile.

Testing via AWS Console

I used the AWS console to send test messages. The main catch is that if you are using JSON messages and using Spring to automatically deserialize JSON to your objects via @JsonProperty  annotations, you will need to specify the message attribute (header) contentType  with value  application/json. Otherwise, the conversion will fail with an unhelpful error message like "Cannot convert from [java.lang.String] to .... for GenericMessage ...." with no indication why there was a failure.

There is another alternative for reconfiguring the default Spring messaging classes to ignore the contentType  header.

Spring Framework AWS Spring Cloud Spring Boot

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • A Beginner's Guide to Infrastructure as Code
  • A First Look at Neon
  • Old School or Still Cool? Top Reasons To Choose ETL Over ELT
  • How To Perform Local Website Testing Using Selenium And Java

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: