ListenableFuture
は、非同期計算(結果の生成がまだ完了していない計算)の結果を表します。これは Future
の一種であり、計算が完了したとき、または計算がすでに完了している場合はすぐに実行されるコールバックを登録できます。
ListenableFuture
は Android フレームワークの一部ではなく、Guava によって提供されます。このクラスの実装の詳細については、ListenableFuture の説明をご覧ください。
CameraX や Health Services など、既存の多くの Jetpack ライブラリには非同期メソッドがあり、戻り値の型は ListenableFuture
であり、実行のステータスを表します。TileService
の要件を満たすなど、ListenableFuture
を返すメソッドの実装が必要になる場合があります。
必要なライブラリ
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
は、SingleEmitter
内にコールバックを登録することで ListenableFuture
から作成できます。
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{ ... }
を使用して、suspend 関数の結果を 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
を、ListenableFuture
を実装する SettableFuture
に変換できます。
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; }