Amazon SNS Java Messaging Lib
The Amazon SNS Java Messaging Library holds the compatible classes, that are used for communicating with Amazon Simple Notification Service. This project builds on top of the AWS SDK for Java to use Amazon SNS provider for the messaging applications without running any additional software.
The batch size should be chosen based on the size of individual messages and available network bandwidth as well as the observed latency and throughput improvements based on the real life load. These are configured to some sensible defaults assuming smaller message sizes and the optimal batch size for server side processing.
Request Batch
Combine multiple requests to optimally utilise the network.
Article Martin Fowler Request Batch
Compatible JDK 8, 11 and 17
Compatible AWS JDK v1 >= 1.12
Compatible AWS JDK v2 >= 2.18
This library supports Kotlin
aswell
1. Quick Start
1.1 Prerequisite
In order to use Amazon SNS Java Messaging Lib within a Maven project, simply add the following dependency to your pom.xml. There are no other dependencies for Amazon SNS Java Messaging Lib, which means other unwanted libraries will not overwhelm your project.
You can pull it from the central Maven repositories:
For AWS SDK v1
<dependency>
<groupId>com.github.mvallim</groupId>
<artifactId>amazon-sns-java-messaging-lib-v1</artifactId>
<version>1.0.6</version>
</dependency>
For AWS SDK v2
<dependency>
<groupId>com.github.mvallim</groupId>
<artifactId>amazon-sns-java-messaging-lib-v2</artifactId>
<version>1.0.6</version>
</dependency>
If you want to try a snapshot version, add the following repository:
<repository>
<id>sonatype-snapshots</id>
<name>Sonatype Snapshots</name>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
Gradle
For AWS SDK v1
implementation 'com.github.mvallim:amazon-sns-java-messaging-lib-v1:1.0.6'
For AWS SDK v2
implementation 'com.github.mvallim:amazon-sns-java-messaging-lib-v2:1.0.6'
If you want to try a snapshot version, add the following repository:
repositories {
maven {
url "https://oss.sonatype.org/content/repositories/snapshots"
}
}
1.2 Usage
Properties TopicProperty
Property | Type | Description |
---|---|---|
fifo |
boolean | refers if SNS is fifo or not. |
maximumPoolSize |
int | refers maximum threads for producer. |
topicArn |
string | refers topic arn name. |
linger |
int | refers to the time to wait before sending messages out to SNS. |
maxBatchSize |
int | refers to the maximum amount of data to be collected before sending the batch. |
NOTICE: the buffer of message store in memory is calculate using maximumPoolSize
* maxBatchSize
huge values demand huge memory.
Determining the type of BlockingQueue
with its maximum capacity
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(false)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate<MyMessage> snsTemplate = new AmazonSnsTemplate<>(
amazonSNS, topicProperty, new LinkedBlockingQueue<>(100));
Using an ObjectMapper
other than the default
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(false)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate<MyMessage> snsTemplate = new AmazonSnsTemplate<>(
amazonSNS, topicProperty, new ObjectMapper<>());
Using an ObjectMapper
and a BlockingQueue
other than the default
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(false)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate<MyMessage> snsTemplate = new AmazonSnsTemplate<>(
amazonSNS, topicProperty, new LinkedBlockingQueue<>(100), new ObjectMapper<>());
Standard SNS
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(false)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate<MyMessage> snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry<MyMessage> requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.build();
snsTemplate.send(requestEntry);
FIFO SNS
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(true)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate<MyMessage> snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry<MyMessage> requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.withGroupId(UUID.randomUUID().toString())
.withDeduplicationId(UUID.randomUUID().toString())
.build();
snsTemplate.send(requestEntry);
Send With Callback
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(true)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate<MyMessage> snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry<MyMessage> requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.withGroupId(UUID.randomUUID().toString())
.withDeduplicationId(UUID.randomUUID().toString())
.build();
snsTemplate.send(requestEntry).addCallback(result -> {
successCallback -> LOGGER.info("{}", successCallback),
failureCallback -> LOGGER.error("{}", failureCallback)
});
snsTemplate.send(requestEntry).addCallback(result -> {
successCallback -> LOGGER.info("{}", successCallback)
});
Send And Wait
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(true)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate<MyMessage> snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry<MyMessage> requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.withGroupId(UUID.randomUUID().toString())
.withDeduplicationId(UUID.randomUUID().toString())
.build();
snsTemplate.send(requestEntry).addCallback(result -> {
successCallback -> LOGGER.info("{}", successCallback),
failureCallback -> LOGGER.error("{}", failureCallback)
});
snsTemplate.await().join();
Send And Shutdown
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(true)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate<MyMessage> snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry<MyMessage> requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.withGroupId(UUID.randomUUID().toString())
.withDeduplicationId(UUID.randomUUID().toString())
.build();
snsTemplate.send(requestEntry).addCallback(result -> {
successCallback -> LOGGER.info("{}", successCallback),
failureCallback -> LOGGER.error("{}", failureCallback)
});
snsTemplate.shutdown();
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use GitHub for versioning. For the versions available, see the tags on this repository.
Authors
- Marcos Vallim - Founder, Author, Development, Test, Documentation - mvallim
See also the list of contributors who participated in this project.
License
This project is licensed under the Apache License - see the LICENSE file for details