RxAndroid README

The project's README from github.com/ReactiveX/RxAndroid. As one markdown file: README.md.

RxAndroid: Reactive Extensions for Android

Android specific bindings for RxJava 3.

This module adds the minimum classes to RxJava that make writing reactive components in Android applications easy and hassle-free. More specifically, it provides a Scheduler that schedules on the main thread or any given Looper.

Communication

Since RxAndroid is part of the RxJava family the communication channels are similar:

Binaries

dependencies {
    implementation 'io.reactivex.rxjava3:rxandroid:3.0.2'
    // Because RxAndroid releases are few and far between, it is recommended you also
    // explicitly depend on RxJava's latest version for bug fixes and new features.
    // (see https://github.com/ReactiveX/RxJava/releases for latest 3.x.x version)
    implementation 'io.reactivex.rxjava3:rxjava:3.1.5'
}

Additional binaries and dependency information for can be found at search.maven.org.

Snapshots of the development version are available in Sonatype's snapshots repository. 

repositories {
    mavenCentral()
    maven {
        url 'https://oss.sonatype.org/content/repositories/snapshots/'
    }
}

dependencies {
    implementation 'io.reactivex.rxjava3:rxandroid:3.1.0-SNAPSHOT'
}

Build

To build:

$ git clone [email protected]:ReactiveX/RxAndroid.git
$ cd RxAndroid/
$ ./gradlew build

Further details on building can be found on the RxJava Getting Started page of the wiki.

Sample usage

A sample project which provides runnable code examples that demonstrate uses of the classes in this project is available in the sample-app/ folder.

Observing on the main thread

One of the most common operations when dealing with asynchronous tasks on Android is to observe the task's result or outcome on the main thread. Using vanilla Android, this would typically be accomplished with an AsyncTask. With RxJava instead you would declare your Observable to be observed on the main thread:

Observable.just("one", "two", "three", "four", "five")
    .subscribeOn(Schedulers.newThread())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(/* an Observer */);

This will execute the Observable on a new thread, and emit results through onNext on the main thread.

Observing on arbitrary loopers

The previous sample is merely a specialization of a more general concept: binding asynchronous communication to an Android message loop, or Looper. In order to observe an Observable on an arbitrary Looper, create an associated Scheduler by calling AndroidSchedulers.from:

Looper backgroundLooper = // ...
Observable.just("one", "two", "three", "four", "five")
    .observeOn(AndroidSchedulers.from(backgroundLooper))
    .subscribe(/* an Observer */)

This will execute the Observable on a new thread and emit results through onNext on whatever thread is running backgroundLooper.

Bugs and Feedback

For bugs, feature requests, and discussion please use GitHub Issues. For general usage questions please use the mailing list or StackOverflow.

LICENSE

Copyright 2015 The RxAndroid authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

RxAndroid (ReactiveX/RxAndroid)

Searching Database…

19.9K ·GitHub
RxAndroid
What is this?RxAndroid provides Android-specific bindings for RxJava 3, adding the minimum classes needed to write reactive components in Android apps easily.
Is this a standalone framework or an extension to RxJava?It's a small extension library on top of RxJava 3, not a standalone framework; it mainly adds a Scheduler for Android's main thread or any given Looper.
How do I add it to a project?Add the RxAndroid dependency to your Android project (snapshots are available in Sonatype's snapshots repository); see the sample-app/ folder for runnable usage examples.
Do I need RxJava already set up to use this?Yes, RxAndroid is an add-on to RxJava 3, so you need RxJava in your project alongside it.
What exactly does it add beyond vanilla RxJava?It mainly adds AndroidSchedulers so you can observe Observables on the main thread or a custom Looper instead of manually using AsyncTask.
How do I observe on a specific Looper instead of the main thread?Create an AndroidSchedulers.from(backgroundLooper) scheduler; the Observable will run on a new thread and emit results through onNext on whatever thread runs that Looper.
Is there example code to learn from?Yes, the sample-app/ folder contains a sample project with runnable code examples demonstrating the library's classes.
What are similar projects?RxPermissions, MPAndroidChart, PermissionsDispatcher, MVPArms, ARouter, Android-PickerView, androidannotations, lottie-android
Which topics is it in?reactive-programming, android-library, mobile-app, java, mobile, android, apache-2.0, library, developer-tools, open-source
Creator
ReactiveX
Size
1 MB
Stars
19.9K
Updated
CommitOct 01Release3.0.2Nov 09
Age
12y
Commits · 90 Days