RxLifecycle


Source link: https://github.com/trello/RxLifecycle

RxLifecycle

This library allows one to automatically complete sequences based on a second lifecycle stream.

This capability is useful in Android, where incomplete subscriptions can cause memory leaks.

Usage

You must start with an Observable<T> representing a lifecycle stream. Then you use RxLifecycle to bind a sequence to that lifecycle.

You can bind when the lifecycle emits anything:

myObservable
  .compose(RxLifecycle.bind(lifecycle))
  .subscribe();

Or you can bind to when a specific lifecyle event occurs:

myObservable
  .compose(RxLifecycle.bindUntilEvent(lifecycle, ActivityEvent.DESTROY))
  .subscribe();

Alternatively, you can let RxLifecycle determine the appropriate time to end the sequence:

myObservable
  .compose(RxLifecycleAndroid.bindActivity(lifecycle))
  .subscribe();

It assumes you want to end the sequence in the opposing lifecycle event - e.g., if subscribing during START, it will terminate on STOP. If you subscribe after PAUSE, it will terminate at the next destruction event (e.g., PAUSE will terminate in STOP).

Providers

Where do lifecycles come from? Generally, they are provided by an appropriate LifecycleProvider<T>. But where are those implemented?

You have a few options for that:

  1. Use rxlifecycle-components and subclass the provided RxActivity, RxFragment, etc. classes.
  2. Use Navi + rxlifecycle-navi to generate providers.
  3. Use Android's lifecycle + rxlifecycle-android-lifecycle to generate providers.
  4. Write the implementation yourself.

If you use rxlifecycle-components, just extend the appropriate class, then use the built-in bindToLifecycle() (or bindUntilEvent()) methods:

public class MyActivity extends RxActivity {

  @Override
  public void onResume() {

super.onResume();

myObservable

 .compose(bindToLifecycle())

 .subscribe();

  
}
 
}

If you use rxlifecycle-navi, then you just pass your NaviComponent to NaviLifecycle to generate a provider:

public class MyActivity extends NaviActivity {

  private final LifecycleProvider<ActivityEvent> provider

= NaviLifecycle.createActivityLifecycleProvider(this);

@Override
  public void onResume() {

super.onResume();

myObservable

 .compose(provider.bindToLifecycle())

 .subscribe();

  
}
 
}

If you use rxlifecycle-android-lifecycle, then you just pass your LifecycleOwner to AndroidLifecycle to generate a provider:

public class MyActivity extends LifecycleActivity {

  private final LifecycleProvider<Lifecycle.Event> provider

= AndroidLifecycle.createLifecycleProvider(this);

@Override
  public void onResume() {

super.onResume();

myObservable

 .compose(provider.bindToLifecycle())

 .subscribe();

  
}
 
}

Unsubscription

RxLifecycle does not actually unsubscribe the sequence. Instead it terminates the sequence. The way in which it does so varies based on the type:

  • Observable, Flowable and Maybe - emits onCompleted()
  • Single and Completable - emits onError(CancellationException)

If a sequence requires the Subscription.unsubscribe() behavior, then it is suggested that you manually handle the Subscription yourself and call unsubscribe() when appropriate.

Kotlin

The rxlifecycle-kotlin module provides built-in extensions to the base RxJava types:

myObservable
  .bindToLifecycle(myView)
  .subscribe {
 
}
  myObservable
  .bindUntilEvent(myRxActivity, STOP)
  .subscribe {
 
}

There is an additional rxlifecycle-android-lifecycle-kotlin module to provider extensions to work with LivecycleOwner's.

myObservable
  .bindToLifecycle(myLifecycleActivity, ON_STOP)
  .subscribe {
 
}

Installation

compile 'com.trello.rxlifecycle2:rxlifecycle:2.2.0'  // If you want to bind to Android-specific lifecycles compile 'com.trello.rxlifecycle2:rxlifecycle-android:2.2.0'  // If you want pre-written Activities and Fragments you can subclass as providers compile 'com.trello.rxlifecycle2:rxlifecycle-components:2.2.0'  // If you want pre-written support preference Fragments you can subclass as providers compile 'com.trello.rxlifecycle2:rxlifecycle-components-preference:2.2.0'  // If you want to use Navi for providers compile 'com.trello.rxlifecycle2:rxlifecycle-navi:2.2.0'  // If you want to use Android Lifecycle for providers compile 'com.trello.rxlifecycle2:rxlifecycle-android-lifecycle:2.2.0'  // If you want to use Kotlin syntax compile 'com.trello.rxlifecycle2:rxlifecycle-kotlin:2.2.0'  // If you want to use Kotlin syntax with Android Lifecycle compile 'com.trello.rxlifecycle2:rxlifecycle-android-lifecycle-kotlin:2.2.0'

License

Copyright (C) 2016 Trello  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. 

Resources

Android Library to provide swipe, click and other functionality to RecyclerView.

Google AutoValue plugin for IntelliJ.

An android library to display the licenses of your application libraries in a easy way.

Multi choice selection applied on recycler view make life easier.

A perfectically simple library to manage http requests.

Tiny library that uses Android Design Support Library and lets you create and show snackbars in a fluent manner.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes