在您的 Android 应用中使用 Kotlin 协程

1. 开始之前

在本 Codelab 中，您将学习如何在 Android 应用中使用 Kotlin 协程 - 这是一种推荐的管理后台线程的方式，它可以通过减少对回调的需求来简化代码。

协程是 Kotlin 的一项功能，它将长时间运行任务（例如数据库或网络访问）的异步回调转换为顺序代码。

以下是一个代码片段，让您了解您将要做什么

// Async callbacks
networkRequest { result ->
   // Successful network request
   databaseSave(result) { rows ->
     // Result saved
   }
}

基于回调的代码将使用协程转换为顺序代码

// The same code with coroutines
val result = networkRequest()
// Successful network request
databaseSave(result)
// Result saved

您将从一个现有的应用开始，该应用使用架构组件构建，并且使用回调样式来处理长时间运行的任务。

在本 Codelab 结束时，您将拥有足够的经验，可以在您的应用中使用协程从网络加载数据，并且能够将协程集成到应用中。您还将熟悉协程的最佳实践，以及如何针对使用协程的代码编写测试。

先决条件

熟悉架构组件 ViewModel、LiveData、Repository 和 Room。
了解 Kotlin 语法，包括扩展函数和 Lambda 表达式。
基本了解在 Android 上使用线程，包括主线程、后台线程和回调。

您将要做什么

调用使用协程编写的代码并获取结果。
使用挂起函数使异步代码变为顺序代码。
使用 launch 和 runBlocking 来控制代码执行方式。
学习使用 suspendCoroutine 将现有 API 转换为协程的技术。
将协程与架构组件一起使用。
学习协程测试的最佳实践。

您需要什么

Android Studio 4.1（本 Codelab 可能适用于其他版本，但有些内容可能丢失或看起来不同）。

如果您在完成本 Codelab 时遇到任何问题（代码错误、语法错误、措辞不清等），请通过 Codelab 左下角的“报告错误”链接报告问题。

2. 设置

下载代码

单击以下链接下载本 Codelab 的所有代码

... 或者使用以下命令从命令行克隆 GitHub 代码库

$ git clone https://github.com/android/codelab-kotlin-coroutines.git

常见问题解答

3. 运行初始示例应用

首先，让我们看看初始示例应用是什么样的。按照以下说明在 Android Studio 中打开示例应用。

如果您下载了 kotlin-coroutines zip 文件，请解压缩该文件。
在 Android Studio 中打开 coroutines-codelab 项目。
选择 start 应用模块。
单击运行按钮，然后选择模拟器或连接您的 Android 设备，该设备必须能够运行 Android Lollipop（支持的最低 SDK 为 21）。Kotlin 协程屏幕应出现

此入门应用使用线程在您按下屏幕后短时间延迟后递增计数。它还将从网络获取新的标题并在屏幕上显示。现在试一试，您应该会看到计数和消息在短时间延迟后发生变化。在本 Codelab 中，您将把此应用转换为使用协程。

此应用使用架构组件将 MainActivity 中的 UI 代码与 MainViewModel 中的应用逻辑分开。花点时间熟悉项目的结构。

MainActivity 显示 UI，注册点击监听器，并且可以显示 Snackbar。它将事件传递给 MainViewModel，并根据 MainViewModel 中的 LiveData 更新屏幕。
MainViewModel 处理 onMainViewClicked 中的事件，并将使用 LiveData 与 MainActivity 通信。
Executors 定义 BACKGROUND，它可以在后台线程上运行内容。
TitleRepository 从网络获取结果并将它们保存到数据库。

在项目中添加协程

要在 Kotlin 中使用协程，您必须在项目的 build.gradle (Module: app) 文件中包含 coroutines-core 库。Codelab 项目已经为您完成了此操作，因此您无需执行此操作来完成 Codelab。

Android 上的协程作为核心库和 Android 特定扩展提供

kotlinx-coroutines-core — 在 Kotlin 中使用协程的主要接口
kotlinx-coroutines-android — 支持协程中的 Android 主线程

入门应用已在 build.gradle 中包含依赖项。在创建新的应用项目时，您需要打开 build.gradle (Module: app) 并将协程依赖项添加到项目中。

dependencies {
  ...
  implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:x.x.x"
  implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:x.x.x"
}

您可以在 Kotlin 协程发布页面上找到要替换为“x.x.x”的协程库的最新版本号。

4. Kotlin 中的协程

在 Android 上，避免阻塞主线程至关重要。主线程是处理所有 UI 更新的单个线程。它也是调用所有点击处理程序和其他 UI 回调的线程。因此，它必须平稳运行，才能保证良好的用户体验。

为了让您的应用在没有明显暂停的情况下向用户显示，主线程必须大约每 16 毫秒更新一次屏幕，这大约相当于每秒 60 帧。许多常见任务都需要更长的时间，例如解析大型 JSON 数据集、将数据写入数据库或从网络获取数据。因此，从主线程调用此类代码会导致应用暂停、卡顿，甚至冻结。如果您阻塞主线程的时间过长，应用甚至可能崩溃并显示“应用程序无响应”对话框。

观看以下视频，了解协程如何在 Android 上通过引入主线程安全性来解决此问题。

回调模式

在不阻塞主线程的情况下执行长时间运行任务的一种模式是回调。通过使用回调，您可以在后台线程上启动长时间运行的任务。任务完成后，将调用回调，以便在主线程上通知您结果。

来看一个回调模式的示例。

// Slow request with callbacks
@UiThread
fun makeNetworkRequest() {
    // The slow network request runs on another thread
    slowFetch { result ->
        // When the result is ready, this callback will get the result
        show(result)
    }
    // makeNetworkRequest() exits after calling slowFetch without waiting for the result
}

由于这段代码用@UiThread注释，所以它必须足够快地在主线程上执行。这意味着它需要快速返回，以便不会延迟下一个屏幕更新。然而，由于slowFetch将花费数秒甚至数分钟才能完成，因此主线程无法等待结果。 show(result)回调允许 slowFetch在后台线程上运行并在准备就绪时返回结果。

使用协程来移除回调

回调是一种很棒的模式，但它们也有一些缺点。过度使用回调的代码可能会变得难以阅读和理解。此外，回调不允许使用某些语言特性，例如异常。

Kotlin 协程允许你将基于回调的代码转换为顺序代码。顺序编写的代码通常更容易阅读，甚至可以使用异常等语言特性。

最终，它们的作用完全相同：等待从长时间运行的任务获得结果，然后继续执行。然而，在代码中，它们看起来非常不同。

关键字 suspend 是 Kotlin 用于标记可用于协程的函数或函数类型的方式。当一个协程调用一个标记为 suspend 的函数时，它不会像普通函数调用那样阻塞直到该函数返回，而是挂起执行，直到结果准备就绪，然后恢复它离开的位置，并使用结果。当它被挂起等待结果时，它会解除正在运行的线程的阻塞，以便其他函数或协程可以运行。

例如，在下面的代码中，makeNetworkRequest() 和 slowFetch() 都是 suspend 函数。

// Slow request with coroutines
@UiThread
suspend fun makeNetworkRequest() {
    // slowFetch is another suspend function so instead of 
    // blocking the main thread  makeNetworkRequest will `suspend` until the result is 
    // ready
    val result = slowFetch()
    // continue to execute after the result is ready
    show(result)
}

// slowFetch is main-safe using coroutines
suspend fun slowFetch(): SlowResult { ... }

就像回调版本一样，makeNetworkRequest 必须立即从主线程返回，因为它被标记为 @UiThread。这意味着它通常不能调用阻塞方法，例如 slowFetch。这就是 suspend 关键字发挥作用的地方。

与基于回调的代码相比，协程代码使用更少的代码实现了相同的结果，即解除当前线程的阻塞。由于其顺序风格，它很容易将多个长时间运行的任务链接起来，而无需创建多个回调。例如，从两个网络端点获取结果并将其保存到数据库的代码可以作为协程中的一个函数编写，而无需回调。就像这样

// Request data from network and save it to database with coroutines

// Because of the @WorkerThread, this function cannot be called on the
// main thread without causing an error.
@WorkerThread
suspend fun makeNetworkRequest() {
    // slowFetch and anotherFetch are suspend functions
    val slow = slowFetch()
    val another = anotherFetch()
    // save is a regular function and will block this thread
    database.save(slow, another)
}

// slowFetch is main-safe using coroutines
suspend fun slowFetch(): SlowResult { ... }
// anotherFetch is main-safe using coroutines
suspend fun anotherFetch(): AnotherResult { ... }

你将在下一节中将协程引入示例应用程序。

5. 使用协程控制 UI

在本练习中，你将编写一个协程，在延迟后显示一条消息。要开始，请确保你在 Android Studio 中打开了 start 模块。

了解 CoroutineScope

在 Kotlin 中，所有协程都在一个 CoroutineScope 中运行。范围通过其作业控制协程的生存期。当你取消范围的作业时，它会取消在该范围内启动的所有协程。在 Android 上，你可以使用范围来取消所有正在运行的协程，例如，当用户从 Activity 或 Fragment 导航离开时。范围还允许你指定默认调度程序。调度程序控制协程运行的线程。

对于由 UI 启动的协程，通常应该在 Dispatchers.Main 上启动它们，它是在 Android 上的主线程。在 Dispatchers.Main 上启动的协程在挂起时不会阻塞主线程。由于 ViewModel 协程几乎总是更新主线程上的 UI，因此在主线程上启动协程可以节省额外的线程切换。在主线程上启动的协程可以在启动后随时切换调度程序。例如，它可以使用另一个调度程序在主线程之外解析大型 JSON 结果。

使用 viewModelScope

AndroidX lifecycle-viewmodel-ktx 库为 ViewModel 添加了一个 CoroutineScope，该范围配置为启动与 UI 相关的协程。要使用此库，你必须在项目的 build.gradle (Module: start) 文件中包含它。此步骤已经在代码实验室项目中完成。

dependencies {
  ...
  // replace x.x.x with latest version
  implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:x.x.x"
}

该库添加了一个 viewModelScope 作为 ViewModel 类的扩展函数。此范围绑定到 Dispatchers.Main，并在 ViewModel 被清除时自动取消。

从线程切换到协程

在 MainViewModel.kt 中找到下一个 TODO 以及这段代码

MainViewModel.kt

/**
* Wait one second then update the tap count.
*/
private fun updateTaps() {
   // TODO: Convert updateTaps to use coroutines
   tapCount++
   BACKGROUND.submit {
       Thread.sleep(1_000)
       _taps.postValue("$tapCount taps")
   }
}

这段代码使用 BACKGROUND ExecutorService（在 util/Executor.kt 中定义）在后台线程中运行。由于 sleep 会阻塞当前线程，因此如果它在主线程上调用，则会冻结 UI。用户点击主视图一秒后，它会请求一个 Snackbar。

你可以通过从代码中删除 BACKGROUND 并再次运行它来看到这种情况发生。加载微调器不会显示，并且所有内容会在一秒后“跳到”最终状态。

MainViewModel.kt

/**
* Wait one second then update the tap count.
*/
private fun updateTaps() {
   // TODO: Convert updateTaps to use coroutines
   tapCount++
   Thread.sleep(1_000)
   _taps.postValue("$tapCount taps")
}

用这段基于协程的代码替换 updateTaps，它执行相同的操作。你将不得不导入 launch 和 delay。

MainViewModel.kt

/**
* Wait one second then display a snackbar.
*/
fun updateTaps() {
   // launch a coroutine in viewModelScope
   viewModelScope.launch {
       tapCount++
       // suspend this coroutine for one second
       delay(1_000)
       // resume in the main dispatcher
       // _snackbar.value can be called directly from main thread
       _taps.postValue("$tapCount taps")
   }
}

这段代码执行相同的操作，等待一秒钟，然后显示一个 Snackbar。然而，有一些重要的区别

viewModelScope. launch 将在 viewModelScope 中启动一个协程。这意味着当我们传递给 viewModelScope 的作业被取消时，此作业/范围中的所有协程都将被取消。如果用户在 delay 返回之前离开了 Activity，那么当 ViewModel 被销毁时调用 onCleared 时，此协程将自动被取消。
由于 viewModelScope 的默认调度程序是 Dispatchers.Main，因此此协程将在主线程中启动。我们稍后将看到如何使用不同的线程。
函数 delay 是一个 suspend 函数。这在 Android Studio 中用左侧边距中的图标显示。即使此协程在主线程上运行，delay 也不会阻塞线程一秒钟。相反，调度程序将在下一条语句处计划协程在 1 秒后恢复。

继续运行它。当你在主视图上点击时，你应该在一秒钟后看到一个 Snackbar。

在下一节中，我们将考虑如何测试此函数。

6. 通过行为测试协程

在本练习中，你将为刚刚编写的代码编写一个测试。本练习向你展示如何使用 kotlinx-coroutines-test 库测试在 Dispatchers.Main 上运行的协程。稍后在本代码实验室中，你将实现一个直接与协程交互的测试。

查看现有代码

在 test 文件夹中打开 MainViewModelTest.kt。

MainViewModelTest.kt

class MainViewModelTest {
   @get:Rule
   val coroutineScope =  MainCoroutineScopeRule()
   @get:Rule
   val instantTaskExecutorRule = InstantTaskExecutorRule()

   lateinit var subject: MainViewModel

   @Before
   fun setup() {
       subject = MainViewModel(
           TitleRepository(
                   MainNetworkFake("OK"),
                   TitleDaoFake("initial")
           ))
   }
}

规则是一种在 JUnit 中测试执行之前和之后运行代码的方式。两个规则用于允许我们在非设备测试中测试 MainViewModel

InstantTaskExecutorRule 是一个 JUnit 规则，它配置 LiveData 以同步地执行每个任务
MainCoroutineScopeRule 是此代码库中的一个自定义规则，它配置 Dispatchers.Main 以使用来自 kotlinx-coroutines-test 的 TestCoroutineDispatcher。这允许测试为测试推进一个虚拟时钟，并允许代码在单元测试中使用 Dispatchers.Main。

在 setup 方法中，使用测试替身创建了一个新的 MainViewModel 实例 - 这些是启动代码中提供的网络和数据库的虚假实现，有助于在不使用真实网络或数据库的情况下编写测试。

对于此测试，替身仅用于满足 MainViewModel 的依赖项。在本代码实验室的后面部分，您将更新替身以支持协程。

编写一个控制协程的测试。

添加一个新的测试，以确保在主视图被点击后一秒钟更新点击次数。

MainViewModelTest.kt

@Test
fun whenMainClicked_updatesTaps() {
   subject.onMainViewClicked()
   Truth.assertThat(subject.taps.getValueForTest()).isEqualTo("0 taps")
   coroutineScope.advanceTimeBy(1000)
   Truth.assertThat(subject.taps.getValueForTest()).isEqualTo("1 taps")
}

通过调用 onMainViewClicked，我们将创建的协程将被启动。此测试检查 onMainViewClicked 被调用后立即点击文本是否仍然是 "0 taps"，然后在一秒钟后更新为 "1 taps"。

此测试使用 **虚拟时间** 来控制由 onMainViewClicked 启动的协程的执行。 MainCoroutineScopeRule 允许您暂停、恢复或控制在 Dispatchers.Main 上启动的协程的执行。这里我们正在调用 advanceTimeBy(1_000)，它将导致主调度程序立即执行计划在 1 秒后恢复的协程。

此测试是完全确定的，这意味着它将始终以相同的方式执行。而且，因为它完全控制了在 Dispatchers.Main 上启动的协程的执行，所以它不必等待一秒钟才能设置值。

运行现有的测试。

在编辑器中右键点击类名 MainViewModelTest 以打开上下文菜单。
在上下文菜单中选择 运行 ‘MainViewModelTest’
对于将来的运行，您可以在工具栏中的按钮旁边的配置中选择此测试配置。默认情况下，配置将被称为 **MainViewModelTest**。

您应该看到测试通过！而且运行时间应该远小于一秒钟。

在下一节练习中，您将学习如何从现有的回调 API 转换为使用协程。

7. 从回调迁移到协程

在此步骤中，您将开始将一个资源库转换为使用协程。为此，我们将协程添加到 ViewModel、Repository、Room 和 Retrofit 中。

在我们将它们切换到使用协程之前，了解体系结构的每个部分负责什么是一个好主意。

MainDatabase 使用 Room 实现了一个数据库，用于保存和加载 Title。
MainNetwork 实现了一个网络 API，用于获取新的标题。它使用 Retrofit 来获取标题。 Retrofit 被配置为随机返回错误或模拟数据，但在其他方面表现得像是在进行真实的网络请求。
TitleRepository 实现了一个用于通过组合来自网络和数据库的数据来获取或刷新标题的单个 API。
MainViewModel 代表屏幕的状态并处理事件。当用户点击屏幕时，它将告诉资源库刷新标题。

由于网络请求是由 UI 事件驱动的，我们希望基于它们启动一个协程，因此从 ViewModel 开始使用协程是自然的选择。

回调版本

打开 MainViewModel.kt 以查看 refreshTitle 的声明。

MainViewModel.kt

/**
* Update title text via this LiveData
*/
val title = repository.title


// ... other code ...


/**
* Refresh the title, showing a loading spinner while it refreshes and errors via snackbar.
*/
fun refreshTitle() {
   // TODO: Convert refreshTitle to use coroutines
   _spinner.value = true
   repository.refreshTitleWithCallbacks(object: TitleRefreshCallback {
       override fun onCompleted() {
           _spinner.postValue(false)
       }

       override fun onError(cause: Throwable) {
           _snackBar.postValue(cause.message)
           _spinner.postValue(false)
       }
   })
}

每次用户点击屏幕时都会调用此函数 - 它将导致资源库刷新标题并将新标题写入数据库。

此实现使用回调来执行一些操作。

在它开始查询之前，它使用 _spinner.value = true 显示一个加载微调器。
当它获得结果时，它使用 _spinner.value = false 清除加载微调器。
如果它遇到错误，它会告诉一个 SnackBar 显示并清除微调器。

请注意，onCompleted 回调不会传递 title。由于我们将所有标题写入 Room 数据库，因此 UI 通过观察由 Room 更新的 LiveData 来更新为当前标题。

在更新到协程时，我们将保持完全相同的行为。使用像 Room 数据库这样的可观察数据源来自动保持 UI 最新是一个好模式。

协程版本

让我们用协程重写 refreshTitle！

由于我们马上就会用到它，让我们在资源库 (TitleRespository.kt) 中创建一个空的挂起函数。定义一个使用 suspend 运算符的新函数，告诉 Kotlin 它与协程一起工作。

TitleRepository.kt

suspend fun refreshTitle() {
    // TODO: Refresh from network and write to database
    delay(500)
}

完成本代码实验室后，您将更新它以使用 Retrofit 和 Room 来获取新的标题并使用协程将其写入数据库。现在，它只会花费 500 毫秒假装在工作，然后继续。

在 MainViewModel 中，使用启动新协程的版本替换 refreshTitle 的回调版本。

MainViewModel.kt

/**
* Refresh the title, showing a loading spinner while it refreshes and errors via snackbar.
*/
fun refreshTitle() {
   viewModelScope.launch {
       try {
           _spinner.value = true
           repository.refreshTitle()
       } catch (error: TitleRefreshError) {
           _snackBar.value = error.message
       } finally {
           _spinner.value = false
       }
   }
}

让我们逐步介绍此函数。

viewModelScope.launch {

就像更新点击次数的协程一样，首先在 viewModelScope 中启动一个新的协程。这将使用 Dispatchers.Main，这是可以的。即使 refreshTitle 将进行网络请求和数据库查询，它也可以使用协程来公开一个 **主线程安全的** 接口。这意味着从主线程调用它是安全的。

因为我们使用的是 viewModelScope，所以当用户离开此屏幕时，此协程启动的工作将自动取消。这意味着它不会发出额外的网络请求或数据库查询。

接下来的几行代码实际上是在资源库中调用 refreshTitle。

try {
    _spinner.value = true
    repository.refreshTitle()
}

在此协程执行任何操作之前，它会启动加载微调器 - 然后像调用普通函数一样调用 refreshTitle。但是，由于 refreshTitle 是一个挂起函数，因此它的执行方式与普通函数不同。

我们不必传递回调。协程将暂停，直到它被 refreshTitle 恢复。虽然它 看起来 就像一个普通的阻塞函数调用，但它会自动等待网络和数据库查询完成，然后无需阻塞主线程就恢复。

} catch (error: TitleRefreshError) {
    _snackBar.value = error.message
} finally {
    _spinner.value = false
}

挂起函数中的异常与普通函数中的错误工作方式相同。如果您在挂起函数中抛出错误，它将被抛出到调用者。因此，即使它们的执行方式非常不同，您也可以使用普通的 try/catch 块来处理它们。这很有用，因为您可以依靠内置的语言支持来处理错误，而不是为每个回调构建自定义错误处理。

而且，如果您从协程中抛出异常 - 那个协程会默认取消其父级。这意味着很容易同时取消多个相关任务。

然后，在 finally 块中，我们可以确保在查询运行后始终关闭微调器。

通过选择 **启动** 配置，然后按，您应该看到在您点击任何位置时出现加载微调器。标题将保持不变，因为我们还没有连接我们的网络或数据库。

在下一节练习中，您将更新资源库以实际执行工作。

8. 从阻塞代码创建主线程安全函数

在本练习中，您将学习如何在协程中切换线程的运行方式，以便实现 TitleRepository 的工作版本。

查看 refreshTitle 中现有的回调代码。

打开 TitleRepository.kt 并查看现有的基于回调的实现。

TitleRepository.kt

// TitleRepository.kt

fun refreshTitleWithCallbacks(titleRefreshCallback: TitleRefreshCallback) {
   // This request will be run on a background thread by retrofit
   BACKGROUND.submit {
       try {
           // Make network request using a blocking call
           val result = network.fetchNextTitle().execute()
           if (result.isSuccessful) {
               // Save it to database
               titleDao.insertTitle(Title(result.body()!!))
               // Inform the caller the refresh is completed
               titleRefreshCallback.onCompleted()
           } else {
               // If it's not successful, inform the callback of the error
               titleRefreshCallback.onError(
                       TitleRefreshError("Unable to refresh title", null))
           }
       } catch (cause: Throwable) {
           // If anything throws an exception, inform the caller
           titleRefreshCallback.onError(
                   TitleRefreshError("Unable to refresh title", cause))
       }
   }
}

在 TitleRepository.kt 中，方法 refreshTitleWithCallbacks 使用回调来向调用者传达加载和错误状态。

此函数为了实现刷新执行了相当多的操作。

使用 BACKGROUND ExecutorService 切换到另一个线程。
使用阻塞的 execute() 方法运行 fetchNextTitle 网络请求。这将在线程中运行网络请求，在本例中是在 BACKGROUND 中的一个线程中运行。
如果结果成功，则使用 insertTitle 将其保存到数据库并调用 onCompleted() 方法。
如果结果不成功或出现异常，则调用 onError 方法告诉调用者刷新失败。

这种基于回调的实现是 **主线程安全的**，因为它不会阻塞主线程。但是，它必须使用回调在工作完成时通知调用者。它还在切换到的 BACKGROUND 线程上调用回调。

从协程中调用阻塞调用。

在不将协程引入到网络或数据库的情况下，我们可以使用协程使此代码 **主线程安全**。这将使我们能够摆脱回调，并允许我们将结果传回最初调用它的线程。

当您需要从协程内部执行阻塞或 CPU 密集型工作（例如对大型列表进行排序和过滤或从磁盘读取）时，可以使用此模式。

要切换到任何调度器，协程使用 withContext。调用 withContext 将切换到另一个调度器 *仅适用于 lambda*，然后使用该 lambda 的结果返回到调用它的调度器。

默认情况下，Kotlin 协程提供三个调度器：Main、IO 和 Default。IO 调度器针对从网络或磁盘读取等 IO 工作进行了优化，而 Default 调度器针对 CPU 密集型任务进行了优化。

TitleRepository.kt

suspend fun refreshTitle() {
   // interact with *blocking* network and IO calls from a coroutine
   withContext(Dispatchers.IO) {
       val result = try {
           // Make network request using a blocking call
           network.fetchNextTitle().execute()
       } catch (cause: Throwable) {
           // If the network throws an exception, inform the caller
           throw TitleRefreshError("Unable to refresh title", cause)
       }
      
       if (result.isSuccessful) {
           // Save it to database
           titleDao.insertTitle(Title(result.body()!!))
       } else {
           // If it's not successful, inform the callback of the error
           throw TitleRefreshError("Unable to refresh title", null)
       }
   }
}

此实现使用网络和数据库的阻塞调用，但它仍然比回调版本简单一些。

此代码仍然使用 **阻塞** 调用。调用 execute() 和 insertTitle(...) 都会阻塞此协程运行的线程。但是，通过使用 withContext 切换到 Dispatchers.IO，我们正在阻塞 IO 调度器中的一个线程。可能在 Dispatchers.Main 上运行的调用此协程的协程将被挂起，直到 withContext lambda 完成。

与回调版本相比，有两个重要的区别。

withContext 将其结果传回调用它的调度器，在本例中为 Dispatchers.Main。回调版本在 BACKGROUND 执行器服务中的一个线程上调用回调。
调用者不必为此函数传递回调。他们可以依靠挂起和恢复来获取结果或错误。

再次运行应用程序。

如果您再次运行应用程序，您会看到新的基于协程的实现正在从网络中加载结果！

在下一步中，您将把协程集成到 Room 和 Retrofit 中。

9. Room 和 Retrofit 中的协程。

为了继续协程集成，我们将使用 Room 和 Retrofit 稳定版本中对挂起函数的支持，然后通过使用挂起函数大幅简化我们刚刚编写的代码。

Room 中的协程。

首先打开 MainDatabase.kt 并将 insertTitle 更改为挂起函数。

MainDatabase.kt。

// add the suspend modifier to the existing insertTitle

@Insert(onConflict = OnConflictStrategy.REPLACE)
suspend fun insertTitle(title: Title)

当您执行此操作时，Room 将使您的查询 **主线程安全** 并自动在后台线程上执行它。但是，这也意味着您只能从协程内部调用此查询。

就是这样，这就是您在 Room 中使用协程所需要做的全部操作。非常棒。

Retrofit 中的协程。

接下来，让我们看看如何将协程与 Retrofit 集成。打开 MainNetwork.kt 并将 fetchNextTitle 更改为挂起函数。还要将返回类型从 Call<String> 更改为 String。

MainNetwork.kt。

// add suspend modifier to the existing fetchNextTitle
// change return type from Call<String> to String

interface MainNetwork {
   @GET("next_title.json")
   suspend fun fetchNextTitle(): String
}

要使用 Retrofit 的挂起函数，您需要做两件事。

向函数添加一个挂起修饰符。
从返回类型中删除 Call 包装器。这里我们返回 String，但您也可以返回复杂的 JSON 支持类型。如果您仍然想要提供对 Retrofit 的完整 Result 的访问，则可以返回 Result<String> 而不是 String 从挂起函数。

Retrofit 将自动使挂起函数 **主线程安全**，因此您可以直接从 Dispatchers.Main 调用它们。

使用 Room 和 Retrofit。

既然 Room 和 Retrofit 支持挂起函数，我们可以从我们的存储库中使用它们。打开 TitleRepository.kt，看看使用挂起函数如何极大地简化逻辑，即使与阻塞版本相比也是如此。

TitleRepository.kt。

suspend fun refreshTitle() {
   try {
       // Make network request using a blocking call
       val result = network.fetchNextTitle()
       titleDao.insertTitle(Title(result))
   } catch (cause: Throwable) {
       // If anything throws an exception, inform the caller
       throw TitleRefreshError("Unable to refresh title", cause)
   }
}

哇，这要 *短得多*。发生了什么事？事实证明，依靠挂起和恢复可以使代码更短。Retrofit 使我们能够在这里使用 String 或 User 对象等返回类型，而不是 Call。这样做是安全的，因为在挂起函数内部，Retrofit 能够在后台线程上运行网络请求，并在调用完成时恢复协程。

更好的是，我们摆脱了 withContext。由于 Room 和 Retrofit 都提供 **主线程安全** 的挂起函数，因此从 Dispatchers.Main 编排此异步工作是安全的。

修复编译器错误。

迁移到协程确实涉及更改函数签名，因为您不能从普通函数中调用挂起函数。当您在此步骤中添加 suspend 修饰符时，会生成一些编译器错误，这些错误显示了如果在真实项目中将函数更改为挂起函数会发生什么。

遍历项目并通过将函数更改为已创建的挂起函数来修复编译器错误。以下是每个错误的快速解决方法。

TestingFakes.kt。

更新测试模拟以支持新的挂起修饰符。

TitleDaoFake。

按 Alt-Enter（在 Mac 上为 Option-Enter），将挂起修饰符添加到层次结构中的所有函数。

MainNetworkFake。

按 Alt-Enter，将挂起修饰符添加到层次结构中的所有函数。
将 fetchNextTitle 替换为以下函数。

override suspend fun fetchNextTitle() = result

MainNetworkCompletableFake。

按 Alt-Enter，将挂起修饰符添加到层次结构中的所有函数。
将 fetchNextTitle 替换为以下函数。

override suspend fun fetchNextTitle() = completable.await()

TitleRepository.kt

删除 refreshTitleWithCallbacks 函数，因为它不再使用。

运行应用程序。

再次运行应用程序，一旦它编译完成，您将看到它正在使用协程加载数据，从 ViewModel 一直加载到 Room 和 Retrofit！

恭喜，您已完全将此应用程序切换到使用协程！为了总结，我们将简要讨论如何测试我们刚刚完成的操作。

10. 直接测试协程。

在本练习中，您将编写一个直接调用 suspend 函数的测试。

由于 refreshTitle 作为公共 API 公开，因此将直接对其进行测试，展示如何从测试中调用协程函数。

以下是您在上一个练习中实现的 refreshTitle 函数。

TitleRepository.kt

suspend fun refreshTitle() {
   try {
       // Make network request using a blocking call
       val result = network.fetchNextTitle()
       titleDao.insertTitle(Title(result))
   } catch (cause: Throwable) {
       // If anything throws an exception, inform the caller
       throw TitleRefreshError("Unable to refresh title", cause)
   }
}

编写一个调用挂起函数的测试。

打开 TitleRepositoryTest.kt（位于 test 文件夹中），其中有两个 TODO。

尝试从第一个测试 whenRefreshTitleSuccess_insertsRows 中调用 refreshTitle。

@Test
fun whenRefreshTitleSuccess_insertsRows() {
   val subject = TitleRepository(
       MainNetworkFake("OK"),
       TitleDaoFake("title")
   )

   subject.refreshTitle()
}

由于 refreshTitle 是一个 suspend 函数，Kotlin 不知道如何调用它，除非从协程或另一个 suspend 函数调用，否则您将收到编译器错误，例如“Suspend 函数 refreshTitle 只能从协程或另一个 suspend 函数中调用。”

测试运行程序对协程一无所知，因此我们无法将此测试设为 suspend 函数。我们可以使用 CoroutineScope 在 ViewModel 中 launch 一个协程，但是测试需要在返回之前运行协程到完成。一旦测试函数返回，测试就结束了。使用 launch 启动的协程是异步代码，可能在将来的某个时间点完成。因此，要测试该异步代码，您需要某种方法来告诉测试等待您的协程完成。由于 launch 是一个非阻塞调用，这意味着它会立即返回，并且可以在函数返回后继续运行协程 - 它不能在测试中使用。例如

@Test
fun whenRefreshTitleSuccess_insertsRows() {
   val subject = TitleRepository(
       MainNetworkFake("OK"),
       TitleDaoFake("title")
   )

   // launch starts a coroutine then immediately returns
   GlobalScope.launch {
       // since this is asynchronous code, this may be called *after* the test completes
       subject.refreshTitle()
   }
   // test function returns immediately, and
   // doesn't see the results of refreshTitle
}

此测试将 **有时** 失败。对 launch 的调用将立即返回，并与测试用例的其余部分同时执行。测试无法知道 refreshTitle 是否已运行 - 并且任何断言（如检查数据库是否已更新）都将是不可靠的。此外，如果 refreshTitle 抛出异常，它不会在测试调用堆栈中抛出。相反，它将被抛到 **GlobalScope** 的未捕获异常处理程序中。

库 kotlinx-coroutines-test 具有 runBlockingTest 函数，该函数在调用 suspend 函数时阻塞。当 runBlockingTest 调用 suspend 函数或 launches 新的协程时，它默认情况下会立即执行它。您可以将其视为将 suspend 函数和协程转换为普通函数调用的方法。

此外，runBlockingTest 会为您重新抛出未捕获的异常。这使得在协程抛出异常时更容易进行测试。

实现一个包含一个协程的测试

将对 refreshTitle 的调用用 runBlockingTest 包裹，并从 subject.refreshTitle() 中删除 GlobalScope.launch 包装器。

TitleRepositoryTest.kt

@Test
fun whenRefreshTitleSuccess_insertsRows() = runBlockingTest {
   val titleDao = TitleDaoFake("title")
   val subject = TitleRepository(
           MainNetworkFake("OK"),
           titleDao
   )

   subject.refreshTitle()
   Truth.assertThat(titleDao.nextInsertedOrNull()).isEqualTo("OK")
}

此测试使用提供的模拟来检查 refreshTitle 是否将“OK”插入数据库。

当测试调用 runBlockingTest 时，它将阻塞，直到由 runBlockingTest 启动的协程完成。然后在内部，当我们调用 refreshTitle 时，它会使用常规的 suspend 和恢复机制来等待将数据库行添加到我们的模拟中。

测试协程完成后，runBlockingTest 返回。

编写一个超时测试

我们希望在网络请求中添加一个短暂的超时。让我们先编写测试，然后实现超时。创建一个新的测试

TitleRepositoryTest.kt

@Test(expected = TitleRefreshError::class)
fun whenRefreshTitleTimeout_throws() = runBlockingTest {
   val network = MainNetworkCompletableFake()
   val subject = TitleRepository(
           network,
           TitleDaoFake("title")
   )

   launch {
       subject.refreshTitle()
   }

   advanceTimeBy(5_000)
}

此测试使用提供的模拟 MainNetworkCompletableFake，这是一个网络模拟，旨在将调用者挂起，直到测试继续它们。当 refreshTitle 尝试发出网络请求时，它将永远挂起，因为我们希望测试超时。

然后，它启动一个单独的协程来调用 refreshTitle。这是测试超时的关键部分，超时应该发生在与 runBlockingTest 创建的协程不同的协程中。通过这样做，我们可以调用下一行 advanceTimeBy(5_000)，它将时间提前 5 秒，并导致另一个协程超时。

这是一个完整的超时测试，一旦我们实现超时，它就会通过。

现在运行它，看看会发生什么

Caused by: kotlinx.coroutines.test.UncompletedCoroutinesError: Test finished with active jobs: ["...]

runBlockingTest 的一项功能是它不允许您在测试完成后泄漏协程。如果在测试结束时有任何未完成的协程（如我们的 launch 协程），它将使测试失败。

添加一个超时

打开 TitleRepository，并在网络获取中添加一个五秒钟的超时。您可以使用 withTimeout 函数来做到这一点

TitleRepository.kt

suspend fun refreshTitle() {
   try {
       // Make network request using a blocking call
       val result = withTimeout(5_000) {
           network.fetchNextTitle()
       }
       titleDao.insertTitle(Title(result))
   } catch (cause: Throwable) {
       // If anything throws an exception, inform the caller
       throw TitleRefreshError("Unable to refresh title", cause)
   }
}

运行测试。当您运行测试时，您应该看到所有测试都通过了！

在下一个练习中，您将学习如何使用协程编写高阶函数。

11. 在高阶函数中使用协程

在本练习中，您将重构 MainViewModel 中的 refreshTitle 以使用通用数据加载函数。这将教会您如何构建使用协程的高阶函数。

当前的 refreshTitle 实现有效，但我们可以创建一个通用的数据加载协程，它始终显示加载指示器。这在响应多个事件加载数据的代码库中可能很有用，并且希望确保始终显示加载指示器。

查看当前的实现，除了 repository.refreshTitle() 之外的每一行都是显示加载指示器和显示错误的样板代码。

// MainViewModel.kt

fun refreshTitle() {
   viewModelScope.launch {
       try {
           _spinner.value = true
           // this is the only part that changes between sources
           repository.refreshTitle() 
       } catch (error: TitleRefreshError) {
           _snackBar.value = error.message
       } finally {
           _spinner.value = false
       }
   }
}

在高阶函数中使用协程

将此代码添加到 MainViewModel.kt 中

MainViewModel.kt

private fun launchDataLoad(block: suspend () -> Unit): Job {
   return viewModelScope.launch {
       try {
           _spinner.value = true
           block()
       } catch (error: TitleRefreshError) {
           _snackBar.value = error.message
       } finally {
           _spinner.value = false
       }
   }
}

现在重构 refreshTitle() 以使用此高阶函数。

MainViewModel.kt

fun refreshTitle() {
   launchDataLoad {
       repository.refreshTitle()
   }
}

通过抽象显示加载指示器和显示错误周围的逻辑，我们简化了加载数据所需的实际代码。显示加载指示器或显示错误是易于推广到任何数据加载的，而实际数据源和目标需要在每次使用时指定。

为了构建此抽象，launchDataLoad 接受一个参数 block，它是一个 suspend lambda。suspend lambda 允许您调用 suspend 函数。这就是 Kotlin 实现我们一直在本代码实验室中使用的协程构建器 launch 和 runBlocking 的方式。

// suspend lambda

block: suspend () -> Unit

要创建一个 suspend lambda，请从 suspend 关键字开始。函数箭头和返回类型 Unit 完成声明。

您并不经常需要声明自己的 suspend lambda，但它们可以帮助创建像这样的封装重复逻辑的抽象！

12. 将协程与 WorkManager 一起使用

在本练习中，您将学习如何从 WorkManager 中使用基于协程的代码。

什么是 WorkManager

Android 上有许多用于可延迟后台工作的选项。本练习将向您展示如何将 WorkManager 与协程集成。WorkManager 是一个兼容、灵活且简单的库，用于可延迟后台工作。WorkManager 是 Android 上这些用例的推荐解决方案。

WorkManager 是 Android Jetpack 的一部分，也是用于需要将机会性执行和保证执行相结合的后台工作的架构组件。机会性执行意味着 WorkManager 将尽快完成您的后台工作。保证执行意味着 WorkManager 将负责在各种情况下启动工作的逻辑，即使您离开应用程序也是如此。

因此，WorkManager 是完成工作最终必须完成的任务的理想选择。

以下是一些适合使用 WorkManager 的任务示例

上传日志
将过滤器应用于图像并保存图像
定期将本地数据与网络同步

将协程与 WorkManager 一起使用

WorkManager 为其基本 ListenableWorker 类提供了不同的实现，用于不同的用例。

最简单的 Worker 类允许我们让 WorkManager 执行一些同步操作。但是，既然我们已经将代码库转换为使用协程和 suspend 函数，那么使用 WorkManager 的最佳方法是通过 CoroutineWorker 类，它允许我们将 doWork() 函数定义为 suspend 函数。

要开始，请打开 RefreshMainDataWork。它已经扩展了 CoroutineWorker，您需要实现 doWork。

在 suspend doWork 函数内部，从存储库调用 refreshTitle() 并返回适当的结果！

完成 TODO 后，代码将如下所示

override suspend fun doWork(): Result {
   val database = getDatabase(applicationContext)
   val repository = TitleRepository(network, database.titleDao)

   return try {
       repository.refreshTitle()
       Result.success()
   } catch (error: TitleRefreshError) {
       Result.failure()
   }
}

请注意，CoroutineWorker.doWork() 是一个挂起函数。与更简单的 Worker 类不同，此代码不会在 WorkManager 配置中指定的 Executor 上运行，而是使用 Dispatchers.Default。您可以使用 withContext() 切换到其他调度程序。

测试我们的 CoroutineWorker

任何代码库都不应该没有测试。

WorkManager 提供了几种不同的方法来测试您的 Worker 类，要详细了解原始测试基础结构，您可以阅读文档。

WorkManager v2.1 引入了一组新的 API 来支持更简单的方式来测试 ListenableWorker 类，因此也包括 CoroutineWorker。在我们的代码中，我们将使用这些新 API 之一：TestListenableWorkerBuilder。

要添加我们的新测试，请更新 androidTest 文件夹下的 RefreshMainDataWorkTest 文件。

文件的内容是

package com.example.android.kotlincoroutines.main

import android.content.Context
import androidx.test.core.app.ApplicationProvider
import androidx.work.ListenableWorker.Result
import androidx.work.testing.TestListenableWorkerBuilder
import com.example.android.kotlincoroutines.fakes.MainNetworkFake
import com.google.common.truth.Truth.assertThat
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.runners.JUnit4

@RunWith(JUnit4::class)
class RefreshMainDataWorkTest {

@Test
fun testRefreshMainDataWork() {
   val fakeNetwork = MainNetworkFake("OK")

   val context = ApplicationProvider.getApplicationContext<Context>()
   val worker = TestListenableWorkerBuilder<RefreshMainDataWork>(context)
           .setWorkerFactory(RefreshMainDataWork.Factory(fakeNetwork))
           .build()

   // Start the work synchronously
   val result = worker.startWork().get()

   assertThat(result).isEqualTo(Result.success())
}

}

在我们开始测试之前，我们告诉 WorkManager 关于工厂，以便我们可以注入模拟网络。

测试本身使用 TestListenableWorkerBuilder 创建我们的工作者，然后我们可以调用 startWork() 方法运行它。

WorkManager 只是协程如何简化 API 设计的一个例子。

13. 恭喜！

在这个 codelab 中，我们涵盖了在您的应用程序中开始使用协程所需的基本知识！

我们涵盖了

如何将协程集成到 Android 应用程序中，从 UI 和 WorkManager 作业到简化异步编程，
如何在 ViewModel 内使用协程从网络获取数据并将其保存到数据库，而不会阻塞主线程。
以及如何在 ViewModel 完成时取消所有协程。

为了测试基于协程的代码，我们涵盖了通过测试行为以及直接从测试中调用 suspend 函数两种方式。

了解更多

查看“ Kotlin Flow 和 LiveData 的高级协程”codelab 以了解有关 Android 上更高级的协程用法的更多信息。

要了解有关协程中取消和异常的更多信息，请查看以下文章系列：第 1 部分：协程、第 2 部分：协程中的取消以及第 3 部分：协程中的异常。

Kotlin 协程具有许多在此 codelab 中未涵盖的功能。如果您有兴趣了解有关 Kotlin 协程的更多信息，请阅读由 JetBrains 发布的协程指南。此外，请查看“ 使用 Kotlin 协程提高应用程序性能”以了解有关 Android 上协程更多使用模式的信息。

在您的 Android 应用中使用 Kotlin 协程

1. 开始之前

先决条件

您将要做什么

您需要什么

2. 设置

下载代码

常见问题解答

3. 运行初始示例应用

在项目中添加协程

4. Kotlin 中的协程

回调模式

使用协程来移除回调

5. 使用协程控制 UI

了解 CoroutineScope

使用 viewModelScope

从线程切换到协程

MainViewModel.kt

MainViewModel.kt

MainViewModel.kt

6. 通过行为测试协程

查看现有代码

MainViewModelTest.kt

编写一个控制协程的测试。

MainViewModelTest.kt

运行现有的测试。

7. 从回调迁移到协程

回调版本

MainViewModel.kt

协程版本

TitleRepository.kt

MainViewModel.kt

8. 从阻塞代码创建主线程安全函数

查看 refreshTitle 中现有的回调代码。

TitleRepository.kt

从协程中调用阻塞调用。

TitleRepository.kt

再次运行应用程序。

9. Room 和 Retrofit 中的协程。

Room 中的协程。

MainDatabase.kt。

Retrofit 中的协程。

MainNetwork.kt。

使用 Room 和 Retrofit。

Title**Repository.kt**。

修复编译器错误。

TestingFakes.kt。

TitleDaoFake。

MainNetworkFake。

MainNetworkCompletableFake。

TitleRepository.kt

运行应用程序。

10. 直接测试协程。

TitleRepository.kt

编写一个调用挂起函数的测试。

实现一个包含一个协程的测试

TitleRepositoryTest.kt

编写一个超时测试

TitleRepositoryTest.kt

添加一个超时

TitleRepository.kt

11. 在高阶函数中使用协程

在高阶函数中使用协程

MainViewModel.kt

MainViewModel.kt

12. 将协程与 WorkManager 一起使用

将协程与 WorkManager 一起使用

测试我们的 CoroutineWorker

13. 恭喜！

了解更多

TitleRepository.kt。