ListenableFuture reprezentuje wynik obliczeń asynchronicznych, czyli obliczeń, które mogły jeszcze nie zostać zakończone. Jest to typ Future, który umożliwia rejestrowanie wywołań zwrotnych do wykonania po zakończeniu obliczeń lub natychmiast, jeśli obliczenia zostały już zakończone.
ListenableFuture nie jest częścią platformy Androida, ale jest dostarczany przez Guava. Więcej informacji o implementacji tej klasy znajdziesz w artykule ListenableFuture explained (w języku angielskim).
Wiele istniejących bibliotek Jetpack, takich jak CameraX czy funkcje dotyczące zdrowia, ma metody asynchroniczne, w których zwracany typ to ListenableFuture reprezentujący stan wykonania. W niektórych przypadkach może być konieczne zaimplementowanie metody, która zwraca ListenableFuture, np. aby spełnić wymagania TileService.
Wymagane biblioteki
Odlotowe
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") }
Uzyskiwanie wyniku ListenableFuture
Dodawanie wywołania zwrotnego
Użyj metody pomocniczej Futures.addCallback(...), aby dołączyć do obiektu ListenableFuture wywołania zwrotne dotyczące powodzenia i niepowodzenia.
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 )
Zawieszanie w języku Kotlin
Jeśli używasz Kotlina, najprostszym sposobem na oczekiwanie na wynik ListenableFuture jest użycie await().
// import kotlinx.coroutines.guava.await // ... val future: ListenableFuture<QueryResult> = ... val queryResult = future.await() // suspends awaiting success.
Interoperacyjność z RxJava
Obiekt Single RxJava można utworzyć z obiektu ListenableFuture, rejestrując wywołania zwrotne w obiekcie SingleEmitter.
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) }
Tworzenie: ListenableFuture
Tworzenie natychmiastowej przyszłości
Jeśli interfejs API nie jest asynchroniczny, ale musisz opakować wynik ukończonej operacji w obiekt ListenableFuture, możesz utworzyć obiekt ImmediateFuture. Można to zrobić za pomocą metody fabrycznej Futures.immediateFuture(...).
fun getResult(): ListenableFuture<QueryResult> { try { val queryResult = getQueryResult() return Futures.immediateFuture(queryResult) } catch (e: Exception) { return Futures.immediateFailedFuture(e) } }
Używanie współprogramu
W Kotlinie można użyć future{ ... }, aby przekonwertować wynik funkcji zawieszenia na ListenableFuture.
// import kotlinx.coroutines.guava.future suspend fun getResultAsync(): QueryResult = /* ... */ fun getResultFuture(): ListenableFuture<QueryResult> { return coroutineScope.future { getResultAsync() } }
Konwertowanie wywołania zwrotnego
Aby przekonwertować interfejs API oparty na wywołaniach zwrotnych na interfejs korzystający z ListenableFuture, użyj CallbackToFutureAdapter.
Ten interfejs API jest udostępniany przez artefakt androidx.concurrent:concurrent-futures.
Więcej informacji znajdziesz w sekcji androidx.concurrent.
Konwersja z RxJava Single
Jeśli używasz RxJava, obiekt Single można przekonwertować na obiekt SettableFuture, który implementuje interfejs ListenableFuture.
fun getResult(): ListenableFuture<QueryResult> { val single: Single<QueryResult> = ... val future = SettableFuture.create<QueryResult>() single.subscribe(future::set, future::setException) return future }