使用 ListenableFuture

ListenableFuture 表示异步计算的结果:计算可能已完成或尚未完成。它是一种 Future,可让您注册在计算完成后或计算已完成时立即执行的回调。

ListenableFuture 不是 Android 框架的一部分,而是由 Guava 提供。如需详细了解此类的实现,请参阅 ListenableFuture 说明。

许多现有的 Jetpack 库(例如 CameraX 或健康服务)都具有异步方法,其返回值类型为 ListenableFuture,表示执行状态。在某些情况下,您可能需要实现一个返回 ListenableFuture 的方法,例如为了满足 TileService 的要求。

必需的库

Groovy

dependencies {
    implementation "com.google.guava:guava:31.0.1-android"

    // To use CallbackToFutureAdapter
    implementation "androidx.concurrent:concurrent-futures:1.3.0"

    // Kotlin
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-guava:1.6.0"
}

Kotlin

dependencies {
    implementation("com.google.guava:guava:31.0.1-android")

    // To use CallbackToFutureAdapter
    implementation("androidx.concurrent:concurrent-futures:1.3.0")

    // Kotlin
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-guava:1.6.0")
}

获取 ListenableFuture 的结果

添加回调

使用 Futures.addCallback(...) 辅助方法将成功和失败回调附加到 ListenableFuture。

val future: ListenableFuture<QueryResult> = ...
Futures.addCallback(
    future,
    object : FutureCallback<QueryResult> {
        override fun onSuccess(result: QueryResult) {
            // handle success.
        }

        override fun onFailure(t: Throwable) {
            // handle failure.
        }
    },
    // causes the callbacks to be executed on the main (UI) thread.
    context.mainExecutor
)

Kotlin 中的挂起

使用 Kotlin 时,等待 ListenableFuture 结果的最简单方法是使用 await()。

// import kotlinx.coroutines.guava.await

// ...

val future: ListenableFuture<QueryResult> = ...
val queryResult = future.await() // suspends awaiting success.

与 RxJava 的互操作

通过在 SingleEmitter 中注册回调,可以从 ListenableFuture 创建 RxJava Single。

val future: ListenableFuture<QueryResult> = ...
val single = Single.create<QueryResult> {
    Futures.addCallback(future, object : FutureCallback<QueryResult> {
        override fun onSuccess(result: QueryResult) {
            it.onSuccess(result)
        }

        override fun onFailure(t: Throwable) {
            it.onError(t)
        }
    }, executor)
}

创建 ListenableFuture

打造触手可及的未来

如果您的 API 不是异步的,但您需要将已完成操作的结果封装到 ListenableFuture 中,则可以创建 ImmediateFuture。这可以使用 Futures.immediateFuture(...) 工厂方法完成。

fun getResult(): ListenableFuture<QueryResult> {
    try {
        val queryResult = getQueryResult()
        return Futures.immediateFuture(queryResult)
    } catch (e: Exception) {
        return Futures.immediateFailedFuture(e)
    }
}

使用协程

在 Kotlin 中,future{ ... } 可用于将挂起函数的结果转换为 ListenableFuture。

// import kotlinx.coroutines.guava.future

suspend fun getResultAsync(): QueryResult = /* ... */

fun getResultFuture(): ListenableFuture<QueryResult> {
    return coroutineScope.future {
        getResultAsync()
    }
}

转换回调

如需将基于回调的 API 转换为使用 ListenableFuture 的 API,请使用 CallbackToFutureAdapter。此 API 由 androidx.concurrent:concurrent-futures 工件提供。

如需了解详情,请参阅 androidx.concurrent。

从 RxJava Single 转换

使用 RxJava 时,Single 可以转换为 SettableFuture,后者会实现 ListenableFuture。

fun getResult(): ListenableFuture<QueryResult> {
    val single: Single<QueryResult> = ...

    val future = SettableFuture.create<QueryResult>()
    single.subscribe(future::set, future::setException)
    return future
}