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 在发出网络请求时会阻塞 UI 线程。将执行移出主线程的最简单解决方案是创建一个新的协程并在 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来为我们解决这个问题。

使用协程确保主线程安全

当函数不阻塞主线程上的 UI 更新时，我们认为该函数是主线程安全的。 makeLoginRequest 函数不是主线程安全的，因为从主线程调用 makeLoginRequest 会阻塞 UI。使用协程库中的 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 线程，使我们的调用函数成为主线程安全的，并使 UI 能够根据需要更新。

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 启动的任何协程都将在主线程上运行。
  • 网络请求的结果现在被处理以显示成功或失败的 UI。

登录函数现在按如下方式执行

  • 应用程序从主线程上的 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() 调用抛出的任何意外异常都将在 UI 中作为错误处理。

其他协程资源

要更详细地了解 Android 上的协程，请参阅 使用 Kotlin 协程提高应用性能。

有关更多协程资源，请参阅以下链接