Spring Boot Netflix RxJava Declarative Schedulers

A Spring Boot starter for RxJava schedulers integration

Setup

Add the Spring Boot starter to your project:

<dependency>
  <groupId>io.jmnarloch</groupId>
  <artifactId>rxjava-scheduler-spring-boot-starter</artifactId>
  <version>1.0.0</version>
</dependency>

Usage

Adds a declarative approach for defining schedulers on the methods RxJava return types: Observable or Single.

• SubscribeOn - subscribes to the RxJava predefined scheduler.
• SubscribeOnBean - subscribes to Scheduler defined as bean within application context.

Example

    @Configuration
    @EnableAspectJAutoProxy
    public static class Application {

        @Bean
        public rx.Scheduler executorScheduler() {
            return Schedulers.from(
                    Executors.newSingleThreadExecutor()
            );
        }
    }

Afterwards you can define that your bean uses the custom scheduler or any of the RxJava predefined scheduler by annotating your methods. This is going to work as long as the return type is either Observable or Single.

    @Service
    public class InvoiceService {

        @SubscribeOn(Scheduler.IO)
        public Observable<Invoice> getInvoices() {
            return Observable.just(
                ...
            );
        }

        @SubscribeOnBean("executorScheduler")
        public Observable<Invoice> getUnprocessedInvoices() {
            return Observable.just(
                ...
            );
        }
    }

Note: You need to enable Spring AOP proxies through @EnableAspectJAutoProxy in order to use this extension.

Properties

The only supported property is rxjava.schedulers.enabled which allows to disable this extension.

rxjava.schedulers.enabled=true # true by default

License

Apache 2.0