Even when a sender application sends a message only once, the receiver application may receive the message more than once.
The term idempotent is used in mathematics to describe a function that produces the same result if it is applied to itself: f(x) = f(f(x)). In Messaging this concepts translates into a message that has the same effect whether it is received once or multiple times. This means that a message can safely be resent without causing any problems even if the receiver receives duplicates of the same message.
The recipient can explicitly de-dupe messages by keeping track of messages that it already received. A unique message identifier simplifies this task and helps detect those cases where two legitimate messages with the same message content arrive.
In order to detect and eliminate duplicate messages based on the message identifier, the message recipient has to keep a list of already received message identifiers.
In order to store the processed message metadata, we have to be in a transactional context. If something goes wrong, the transaction has to be roll backed.
-
The MessageInterceptor creates an MessageContext and stores it in a ThreadLocal
-
The IdempotencyBarrier is an aspect around the @IdempotentConsumer annotation. It retrieves the MessageContext and checks if the message already exists. The unique message key is composed by the messageId and the consumerQueueName.
If the message does not exist, the target method is invoked and the message metadata is stored in a datastore.
If the message already exists, an error message is logged and the target method is not invoked.
- Maven
<dependency>
<groupId>io.fency</groupId>
<artifactId>fency-spring-boot-starter-redis</artifactId>
<version>0.1.1</version>
</dependency>- Gradle
implementation 'io.fency:fency-spring-boot-starter-redis:+'
Annotate your consumers with @IdempotentConsumer.
See sample app: fency-spring-boot-sample-app
If you are already using spring integration, have a look here