AsyncAwait


Source link: https://github.com/metalabdesign/AsyncAwait

Async/Await

A Kotlin library for Android to write asynchronous code in a simpler and more reliable way using async/ await approach, like:

async {

 progressBar.visibility = View.VISIBLE
 // Release main thread and wait until text is loaded in background thread
 val loadedText = await {
 loadFromServer() 
}

 // Loaded successfully, come back in UI thread and show the result
 txtResult.text = loadedText
 progressBar.visibility = View.INVISIBLE 
}

As you see in the example above, you can write asynchronous code in a imperative style, step by step. Calling await to run code in background doesn't lock the UI thread. And execution continues in UI thread after background work is finished. There is no magic, see how it works.

Dependency

compile 'co.metalab.asyncawait:asyncawait:1.0.0'

Usage

async

Coroutine code has to be passed as a lambda in async function

async {

 // Coroutine body 
}

await

Long running code has to be passed as a lambda in await function

async {

 val result = await {

 //Long running code
 
}

 // Use result 
}

You may have many await calls inside async block, or have await in a loop

async {

 val repos = await {
 github.getRepos() 
}

 showList(repos)
 repos.forEach {
 repo ->

 val stats = await {
 github.getStats(repo.name) 
}

 showStats(repo, stats)
 
}
 
}

awaitWithProgress

Use it to show loading progress, its second parameter is a progress handler.

val loadedText = awaitWithProgress(::loadTextWithProgress) {

 // Called in UI thread

 progressBar.progress = it

 progressBar.max = 100

 
}

A data loading function (like the loadTextWithProgress above) should has a functional parameter of type (P) -> Unit which can be called in order to push progress value. For example, it could be like:

private fun loadTextWithProgress(handleProgress: (Int) -> Unit): String {

 for (i in 1..10) {

 handleProgress(i * 100 / 10) // in %

 Thread.sleep(300)
 
}

 return "Loaded Text" 
}

Handle exceptions using try/catch

async {

 try {

 val loadedText = await {

 // throw exception in background thread

 
}

 // Process loaded text
 
}
 catch (e: Exception) {

 // Handle exception in UI thread
 
}
 
}

Handle exceptions in onError block

Could be more convenient, as resulting code has fewer indents. onError called only if exception hasn't been handled in try/catch.

async {

 val loadedText = await {

 // throw exception in background thread
 
}

 // Process loaded text 
}
.onError {

 // Handle exception in UI thread 
}

Unhandled exceptions and exception delivered in onError wrapped by AsyncException with convenient stack trace to the place where await been called originally in UI thread

finally execution

finally always executed after calling onError or when the coroutine finished successfully.

async {

 // Show progress
 await {
 
}
 
}
.onError {

 // Handle exception 
}
.finally {

 // Hide progress 
}

Safe execution

The library has Activity.async and Fragment.async extension functions to produce more safe code. So when using async inside Activity/Fragment, coroutine won't be resumed if Activity is in finishing state or Fragment is detached.

Avoid memory leaks

Long running background code referencing any view/context may produce memory leaks. To avoid such memory leaks, call async.cancelAll() when all running coroutines referencing current object should be interrupted, like

override fun onDestroy() {

 super.onDestroy()

 async.cancelAll() 
}

The async is an extension property for Any type. So calling [this.]async.cancelAll intrerrupts only coroutines started by [this.]async { } function.

Common extensions

The library has a convenient API to work with Retrofit and rxJava.

Retorift

  • awaitSuccessful(retrofit2.Call)

Returns Response<V>.body() if successful, or throws RetrofitHttpError with error response otherwise.

async {

 reposList = awaitSuccessful(github.listRepos(userName)) 
}

rxJava

  • await(Observable)

Waits until observable emits first value.

async {

 val observable = Observable.just("O")
 result = await(observable) 
}

How to create custom extensions

You can create your own await implementations. Here is example of rxJava extension to give you idea. Just return the result of calling AsyncController.await with your own lambda implementation. The code inside await block will be run on a background thread.

suspend fun <V> AsyncController.await(observable: Observable<V>): V = this.await {

 observable.toBlocking().first() 
}

How it works

The library is built upon coroutines introduced in Kotlin 1.1.

The Kotlin compiler responsibility is to convert coroutine (everything inside async block) into a state machine, where every await call is a non-blocking suspension point. The library is responsible for thread handling, error handling and managing state machine. When background computation is done the library delivers result back into UI thread and resumes coroutine execution.

Resources

Tagged Unions for the RxJava aesthete.

RxFunctions is a library to smooth RxJava usage by functionally composing functions.

RxPartialApplication is a library to allow partial application on RxJava function primitives.

RxCurrying is a library to allow currying on RxJava function primitives.

RxActions is a library to smooth RxJava usage by functionally composing actions.

FloatingText is a text widget that can floating above view with animation.

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