使用 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.2.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.2.0")

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

取得 ListenableFuture 的結果

新增回呼

使用 Futures.addCallback(...) 輔助方法，將成功和失敗回呼附加至 ListenableFuture。

Kotlin

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
)

Java

ListenableFuture<QueryResult> future = ...
Futures.addCallback(
    future,
    new FutureCallback<QueryResult>() {
        public void onSuccess(QueryResult result) {
            // handle success
        }

        public void onFailure(@NonNull Throwable thrown) {
            // handle failure
        }
    },
    // causes the callbacks to be executed on the main (UI) thread
    context.getMainExecutor()
);

在 Kotlin 中暫停

使用 Kotlin 時，最簡單的方式是等待 ListenableFuture 的結果 是使用 await()。

import kotlinx.coroutines.guava.await

...

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

與 RxJava 的互通性

RxJava Single 可以從 ListenableFuture 建立，方法是在 SingleEmitter。

Kotlin

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

Java

ListenableFuture<QueryResult> future = ...
Single<QueryResult> single = Single.create(
        e -> Futures.addCallback(future, new FutureCallback<QueryResult>() {
            @Override
            public void onSuccess(QueryResult result) {
                e.onSuccess(result);
            }

            @Override
            public void onFailure(@NonNull Throwable thrown) {
                e.onError(thrown);
            }
        }, executor));

建立 ListenableFuture

建立立即的未來

如果 API 並非非同步，但您需要包裝已完成的 將作業傳入 ListenableFuture，您可以建立 ImmediateFuture。這個 可以使用 Futures.immediateFuture(...) 方法。

Kotlin

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

Java

public ListenableFuture<QueryResult> getResult() {
    try {
        QueryResult queryResult = getQueryResult();
        return Futures.immediateFuture(queryResult);
    } catch (Exception e) {
        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。

Kotlin

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

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

Java

public ListenableFuture<QueryResult> getResult() {
    Single<QueryResult> single = ...

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