Android 上的 Kotlin 协程

协程是一种并发设计模式，您可以在 Android 上使用它来简化异步执行的代码。Kotlin 在 1.3 版中添加了协程，它们基于其他语言中的既有概念。

在 Android 上，协程有助于管理长时间运行的任务，这些任务可能会阻塞主线程并导致应用无响应。超过 50% 的使用协程的专业开发者表示生产力有所提高。本主题介绍了如何使用 Kotlin 协程来解决这些问题，从而使您能够编写更简洁、更精简的应用代码。

功能

协程是我们推荐的 Android 异步编程解决方案。值得注意的功能包括：

轻量级：由于支持挂起，您可以在单个线程上运行许多协程，挂起不会阻塞协程运行所在的线程。挂起相比阻塞可节省内存，同时支持许多并发操作。
内存泄漏更少：使用结构化并发在作用域内运行操作。
内置取消支持：取消会自动通过正在运行的协程层次结构传播。
Jetpack 集成：许多 Jetpack 库都包含提供完整协程支持的扩展程序。某些库还提供自己的协程作用域，您可以将其用于结构化并发。

示例概览

本主题中的示例基于应用架构指南，会发起网络请求并将结果返回给主线程，应用随后即可向用户显示结果。

具体来说，ViewModel 架构组件会在主线程上调用代码库层以触发网络请求。本指南将逐一介绍使用协程以避免主线程阻塞的各种解决方案。

ViewModel 包含一组可直接与协程搭配使用的 KTX 扩展程序。这些扩展程序是 lifecycle-viewmodel-ktx 库，并在本指南中使用。

依赖项信息

要在 Android 项目中使用协程，请在应用的 build.gradle 文件中添加以下依赖项：

Groovy

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'
}

Kotlin

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9")
}

在后台线程中执行

在主线程上发起网络请求会导致它等待或阻塞，直到收到响应。由于线程被阻塞，操作系统无法调用 onDraw()，这会导致应用冻结，并可能导致“应用无响应”(ANR) 对话框。为了改善用户体验，我们来在后台线程上运行此操作。

首先，我们来看一下 Repository 类，了解它是如何发起网络请求的：

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)
    }
}

使用之前的代码，LoginViewModel 在发起网络请求时会阻塞界面线程。将执行从主线程移开的最简单解决方案是创建新的协程并在 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 是一个预定义的 CoroutineScope，随 ViewModel KTX 扩展程序一起提供。请注意，所有协程都必须在作用域内运行。一个 CoroutineScope 管理一个或多个相关的协程。
launch 是一个用于创建协程并将函数主体执行分派给相应调度器的函数。
Dispatchers.IO 表示此协程应在为 I/O 操作预留的线程上执行。

login 函数的执行方式如下：

应用从主线程上的 View 层调用 login 函数。
launch 创建一个新协程，并且网络请求会在为 I/O 操作预留的线程上独立发起。
协程运行时，login 函数继续执行并返回，可能在网络请求完成之前。请注意，为求简洁，此处暂不处理网络响应。

由于此协程是使用 viewModelScope 启动的，因此它在 ViewModel 的作用域内执行。如果 ViewModel 因用户离开屏幕而被销毁，viewModelScope 会自动取消，所有正在运行的协程也会取消。

上一个示例的一个问题是，任何调用 makeLoginRequest 的代码都需要记住显式地将执行移出主线程。我们来看看如何修改 Repository 来解决此问题。

使用协程实现主线程安全

当函数不阻塞主线程上的界面更新时，我们认为它主线程安全。makeLoginRequest 函数不是主线程安全的，因为从主线程调用 makeLoginRequest 会阻塞界面。使用协程库中的 withContext() 函数将协程的执行移动到其他线程：

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 线程，使我们的调用函数主线程安全，并根据需要启用界面更新。

makeLoginRequest 还标有 suspend 关键字。此关键字是 Kotlin 强制函数从协程内调用的方式。

在以下示例中，协程是在 LoginViewModel 中创建的。由于 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 函数都必须在协程中执行。

此代码与之前的 login 示例有几点不同：

launch 不接受 Dispatchers.IO 参数。当您不向 launch 传递 Dispatcher 时，从 viewModelScope 启动的任何协程都会在主线程中运行。
现在，会处理网络请求的结果以显示成功或失败界面。

登录函数现在执行如下：

应用从主线程上的 View 层调用 login() 函数。
launch 在主线程上创建一个新协程，协程开始执行。
在协程中，对 loginRepository.makeLoginRequest() 的调用现在会挂起协程的进一步执行，直到 makeLoginRequest() 中的 withContext 代码块执行完毕。
在 withContext 代码块完成后，login() 中的协程会在主线程上恢复执行，并返回网络请求的结果。

处理异常

要处理 Repository 层可能抛出的异常，请使用 Kotlin 内置的异常支持。在以下示例中，我们使用 try-catch 代码块：

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

    fun login(username: String, token: String) {
        viewModelScope.launch {
            val jsonBody = "{ username: \"$username\", token: \"$token\"}"
            val result = try {
                loginRepository.makeLoginRequest(jsonBody)
            } catch(e: Exception) {
                Result.Error(Exception("Network request failed"))
            }
            when (result) {
                is Result.Success<LoginResponse> -> // Happy path
                else -> // Show error in UI
            }
        }
    }
}

在此示例中，makeLoginRequest() 调用抛出的任何意外异常都会作为界面中的错误进行处理。