使用协程和 Flow 简化 API 设计

如果您是库作者，您也许希望用户在使用 Kotlin 协程与 Flow 时可以更加轻松地调用您基于 Java 或回调的 API。另外，如果您是 API 的使用者，则可能愿意将第三方 API 界面适配协程，以使它们对 Kotlin 更友好。

本文将会介绍如何使用协程和 Flow 简化 API，以及如何使用 suspendCancellableCoroutine 和 callbackFlow API 创建您自己的适配器。针对那些富有好奇心的读者，本文还会对这些 API 进行剖析，以帮您了解它们底层的工作原理。

如果您更喜欢观看视频，可以 点击这里。

检查现有协程适配器

在您为现有 API 编写自己的封装之前，请检查是否已经存在针对您的用例的适配器或者 扩展方法。下面是一些包含常见类型协程适配器的库。

Future 类型

对于 future 类型，Java 8 集成了 CompletableFuture，而 Guava 集成了 ListenableFuture。这里提到的并不是全部，您可以在线搜索以确定是否存在适用于您的 future 类型的适配器。

// 等待 CompletionStage 的执行完成而不阻塞线程
suspend fun <T> CompletionStage<T>.await(): T 
 
// 等待 ListenableFuture 的执行完成而不阻塞线程
suspend fun <T> ListenableFuture<T>.await(): T

使用这些函数，您可以摆脱回调并挂起协程直到 future 的结果被返回。

Reactive Stream

对于响应式流的库，有针对 RxJava、Java 9 API 与 响应式流库 的集成:

// 将给定的响应式 Publisher 转换为 Flow
fun <T : Any> Publisher<T>.asFlow(): Flow<T>

这些函数将响应式流转换为了 Flow。

Android 专用 API

对于 Jetpack 库或 Android 平台 API，您可以参阅 Jetpack KTX 库 列表。现有超过 20 个库拥有 KTX 版本，构成了您所熟悉的 Java API。其中包括 SharedPreferences、ViewModels、SQLite 以及 Play Core。

回调

回调是实现异步通讯时非常常见的做法。事实上，我们在 后台线程任务运行指南 中将回调作为 Java 编程语言的默认解决方案。然而，回调也有许多缺点: 这一设计会导致令人费解的回调嵌套。同时，由于没有简单的传播方式，错误处理也更加复杂。在 Kotlin 中，您可以简单地使用