Android上的协程:简介

协程是一种并发设计模式,在 Android 平台上可以使用它来简化异步执行的代码。

特点

  • 轻量:因为协程支持挂起,不会使正在运行协程的线程发生阻塞。挂起比阻塞节省内存,且支持多个并行操作
  • 内存泄漏更少:使用结构化并发(Structured concurrency)机制在一个作用域内执行多项操作
  • 内置取消支持:取消操作会自动在运行中的整个协程层次结构内传播
  • Jetpack集成:许多Jetpack库都包含提供全面协程支持的扩展,某些库还提供自己的协程操作域,可供开发者用于结构化并发

依赖库

如需在Android项目中使用协程,需将以下依赖项添加到对应modulebuild.gradle文件中:

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:<version>'
}

执行后台线程

如下示例代码我们在主线程上发起网络请求,主线程会处于等待或阻塞状态,直到收到网络响应。

sealed class Result<out R> {
    data class Success<out T>(val data: T) : Result<T>()
    data class Error(val exception: Exception) : Result<Nothing>()
}

class LoginRepository(private val responseParser: LoginResponseParser) {
    private const val loginUrl = "https://example.com/login"

    // Function that makes the network request, blocking the current thread
    fun makeLoginRequest(
        jsonBody: String
    ): Result<LoginResponse> {
        val url = URL(loginUrl)
        (url.openConnection() as? HttpURLConnection)?.run {
            requestMethod = "POST"
            setRequestProperty("Content-Type", "application/json; utf-8")
            setRequestProperty("Accept", "application/json")
            doOutput = true
            outputStream.write(jsonBody.toByteArray())
            return Result.Success(responseParser.parse(inputStream))
        }
        return Result.Error(Exception("Cannot open HttpURLConnection"))
    }
}

makeLoginRequest 是同步的,并且会阻塞发起调用的线程。为了对网络请求的响应建模,我们创建了自己的 Result 类。ViewModel 会在用户点击(例如,点击按钮)时触发网络请求:

class LoginViewModel(
    private val loginRepository: LoginRepository
): ViewModel() {

    fun login(username: String, token: String) {
        val jsonBody = "{ username: \"$username\", token: \"$token\"}"
        loginRepository.makeLoginRequest(jsonBody)
    }
}

由于此时主线程处于阻塞状态,但Android系统需要更新UI时将无法调用onDraw(),这时将会导致应用卡顿,并有可能产生应用无响应(ANR)对话框。为了更好的用户体验,我们就需要将网络请求的操作放在后台线程上去执行。最简单的方法就是创建一个新的协程,然后在I/O线程上执行网络请求:

class LoginViewModel(
    private val loginRepository: LoginRepository
): ViewModel() {

    fun login(username: String, token: String) {
        // Create a new coroutine to move the execution off the UI thread
        viewModelScope.launch(Dispatchers.IO) {
            val jsonBody = "{ username: \"$username\", token: \"$token\"}"
            loginRepository.makeLoginRequest(jsonBody)
        }
    }
}

下面我们仔细分析一下login函数中的协程代码:

  • viewModelScope是预定义的CorutineScop,包含在ViewModel KTX扩展中。请注意,所有协程都必须在一个作用域内运行。一个CoroutineScope管理一个或多个相关的协程。
  • launch是一个函数,用于创建协程并将其函数主体的执行分派给相应的调试程序。
  • Dispatchers.IO指示协程应在为I/O操作预留的线程上执行。

login函数按以下方式执行:

  • 应用从主线程上的View层调用login函数。
  • launch会创建一个新的协程,并且网络请求在为I/O操作预留的线程上独立发出。
  • 在该协程运行时,login函数会继续执行,并可能在网络请求完成前返回。为模型简单起见,我们暂时忽略网络响应。

由于些协程是通过viewModelScope启动的,因此些协程的所有操作都在ViewModel的作用域内执行。如果ViewModel被销毁,则viewModelScop也会被自动取消,且所有的协程也会被取消。

以上示例还存在一个问题,就是怎样保证makeLoginRequest的所有调用都是在子线程中执行,从而确保主线程安全呢?

使用线程确保主线程安全

如果函数操作不会阻塞主线程更新UI,我们即将其视为主线程安全。这里makeLoginRequest函数就不是主线程安全,因为在主线程调用makeLoginRequest会阻塞UI。可以使用协程库中的witContext()函数将协程的操作移至其他线程:

class LoginRepository(...) {
    ...
    suspend fun makeLoginRequest(
        jsonBody: String
    ): Result<LoginResponse> {

        // Move the execution of the coroutine to the I/O dispatcher
        return withContext(Dispatchers.IO) {
            // Blocking network request code
        }
    }
}

withContext(Dispatchers.IO)将协程的执行操作移至一个I/O线程,从而保证主线程安全。suspend关键字强制标记此函数在协程内调用

由于makeLoginRequest已将执行操作移出主线程,由login函数中的协程可以在主线程中执行:

class LoginViewModel(
    private val loginRepository: LoginRepository
): ViewModel() {

    fun login(username: String, token: String) {

        // Create a new coroutine on the UI thread
        viewModelScope.launch {
            val jsonBody = "{ username: \"$username\", token: \"$token\"}"

            // Make the network call and suspend execution until it finishes
            val result = loginRepository.makeLoginRequest(jsonBody)

            // Display result of the network request to the user
            when (result) {
                is Result.Success<LoginResponse> -> // Happy path
                else -> // Show error in UI
            }
        }
    }
}

⚠请注意,此处仍需要协程,因为 makeLoginRequest 是一个 suspend 函数,而所有 suspend 函数都必须在协程中执行。

最后修改的的区别之处:

  • launch没有Dispatchers.IO参数。如果launch没有Dispatcher参数,则从viewModelScope启动的所有协程都会在主线程中执行。
  • 返回网络请求的处理结果到当前主线程,成功或者失败

login函数的执行流程:

  • 应用从主线程的view层调用login()``函数。
  • launch创建一个新的协程,在
  • 主线程上发出网络请求,然后该协程开始执行。
  • 在协程内,调用 loginRepository.makeLoginRequest() 现在会挂起协程的进一步执行操作,直至 makeLoginRequest() 中的 withContext 块结束运行。
  • withContext 块结束运行后,login() 中的协程在主线程上恢复执行操作,并返回网络请求的结果。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,490评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,581评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,830评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,957评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,974评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,754评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,464评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,357评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,847评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,995评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,137评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,819评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,482评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,023评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,149评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,409评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,086评论 2 355

推荐阅读更多精彩内容