ProjectReactor Retry AOP

This project uses projectreactor retry mechanism and spring AOP to retry failed reactive operations.

Quick Start

This section provides a quick introduction to getting started with ProjectReactor Retry AOP.

Add Dependencies

You can add the following maven dependencies to your project:

<dependency>
    <groupId>io.github.mahdibohloul</groupId>
    <artifactId>projectreactor-retry-aop</artifactId>
    <version>1.4.0</version>
    <type>pom</type>
</dependency>

implementation 'io.github.mahdibohloul:projectreactor-retry-aop:1.4.0'

Declarative Example

The following example shows how to use ProjectReactor Retry AOP in a declarative fashion.

@Configuration
@EnableReactiveRetry
public class Application {

}

@Service
class Service {
    @ReactiveRetryable(include = IllegalStateException.class)
    public Mono<Void> service() {
        return Mono.defer(() -> {
            // do something
        });
    }
}

This example calls the service method and, if it fails with a IllegalStateException, it will retry the call. There are various options in the @ReactiveRetryable annotation attributes for including and excluding exception types, limiting the number of retries, and specifying a backoff strategy.

Features

Custom Interceptor

By default, ProjectReactor Retry AOP uses the ReactiveRetryInterceptor to intercept failed reactive operations based on the @ReactiveRetryable annotation attributes. You can use your own interceptor by implementing the MethodInterceptor and pass the name of your interceptor bean to the ReactiveRetryable annotation.

Version 1.2.0: In this version you can specify the order of the interceptor bean in the EnableReactiveRetry annotation.

API

ProjectReactor Retry AOP uses project reactor's retry mechanism in underlying reactive operations. You can see more details about the retry mechanism in the projectreactor retry documentation.

Contributing

ProjectReactor Retry AOP is released under the non-restrictive MIT license. If you have any questions or comments, please open an issue or open a pull request.

If you can improve this project, do not hesitate to contribute with me. I'm waiting for your merge requests with open arms.

ChangeLog

1.1.0: Change java version from 17 to 11 for source compatibility

1.2.0: Add order field to the EnableReactiveRetry annotation

1.2.1: Fix missing sources in maven publications

1.3.0: Fix retry backoff strategy exception filter

1.4.0:

• Add log for before retry and after retry.
  • If you want to check the throwable message in the log, you should access it via debug level.
• Fix bug in method join point processing on retry interceptor.
  • detail of the bug:
    • If you have another annotation on your method such as the transactional annotation, the retry interceptor doesn't go to call these annotation in the retrying process.