Setup Android Kotlin Coroutines (1.1) With Coroutine Scope

April 6, 2019

NOTE: Why use Kotlin Coroutines?

Setup an Android Project with Kotlin.

Dependencies

Edit module:app build.gradles.

dependencies {
    // https://mvnrepository.com/artifact/org.jetbrains.kotlinx/kotlinx-coroutines-android
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.1.1'
}

Coroutine Scope

CoroutineScope helps to ensure the Job is cancelled when container/scope is destroyed (e.g. the coroutines will cancel when activity is destroyed).

@ExperimentalCoroutinesApi
class GoogleDriveListActivity : AppCompatActivity(), CoroutineScope by MainScope() {

    override fun onDestroy() {
        super.onDestroy()
        cancel()
    }

    override fun test() {
        // launch in background thread
        launch(Dispatchers.Default) {

        }

        // launch in main/ui thread
        launch { // Dispatchers.Main

        }
    }
}

NOTE: If the job should outlived the parent container, use GlobalScope.launch.

NOTE: Refer Android Kotlin Coroutine Scope for Activity, Fragment and ViewModel (Architecture Components)

By Desmond Lua

A dream boy who enjoys programming and travelling, maker of Travelopy. Follow me on @d_luaz.

Tags:

Related entries:

Kotlin Serialization and Json (Android)

Android Kotlin Coroutine Scope for Activity, Fragment and ViewModel (Architecture Components)

Android Kotlin Coroutines Setup and Basic Usage

Setup Dagger 2 For Android Kotlin

Guide to learning Android Dev with Kotlin and Architecture Components (ViewModel, LiveData and Room)

CoroutineWorker: Use Kotlin Coroutines in WorkManager

Kotlin Coroutines Wait Task to Complete

Convert Callback to Kotlin Coroutines

Use runBlocking to Execute Coroutine/Suspend Function (Kotlin Coroutines) in Worker/Backgroung Thread

Migrating to Android Kotlin 1.3 Coroutines

Android Standardize Context and Activity Property for Activity and Fragment

Kotlin Android Extentions ViewBinding for RecyclerView ViewHolder (LayoutContainer)

Convert Callback Into Kotlin Coroutines Suspend or Deferred

Kotlin Coroutines Delay Job (Synchronized)

Kotlin Coroutines Detect Cancellation Callback

Android Kotlin Auto Close Resource/Cursor on Exception

Kotlin Coroutines Wait Multiple / Await All Deferred to Complete

Kotlin Coroutines Switch Between Ui and Background

Kotlin Coroutines Exeption Handling

Kotlin Android Coroutine Context: Default Dispatcher vs Commonpool

Android Google Api Get Task Result Without Callback

Android Check File Exist (Kotlin)

Syntax To Inject Constructor For Kotlin

This work is licensed under a
Creative Commons Attribution-NonCommercial 4.0 International License.