Począwszy od Usług Google Play w wersji 9.0.0 możesz używać interfejsu Task API i wielu metod zwracających klasę Task lub jej podklasy. Task to interfejs API reprezentujący wywołania metod asynchronicznych, podobnie jak metody PendingResult występujące w poprzednich wersjach usług Google Play.
Obsługa wyników zadania
Popularną metodą zwracaną przez funkcję Task jest FirebaseAuth.signInAnonymously().
Zwraca wartość Task<AuthResult>, co oznacza, że zadanie zwróci obiekt AuthResult, gdy zostanie on zrealizowany:
Task<AuthResult> task = FirebaseAuth.getInstance().signInAnonymously();
Aby otrzymywać powiadomienia po wykonaniu zadania, załącz OnSuccessListener:
task.addOnSuccessListener(new OnSuccessListener<AuthResult>() {
@Override
public void onSuccess(AuthResult authResult) {
// Task completed successfully
// ...
}
});
Aby otrzymywać powiadomienia, gdy zadanie się nie powiedzie, dołącz OnFailureListener:
task.addOnFailureListener(new OnFailureListener() {
@Override
public void onFailure(@NonNull Exception e) {
// Task failed with an exception
// ...
}
});
Aby obsłużyć sukces i niepowodzenie w tym samym odbiorniku, dołącz OnCompleteListener:
task.addOnCompleteListener(new OnCompleteListener<AuthResult>() {
@Override
public void onComplete(@NonNull Task<AuthResult> task) {
if (task.isSuccessful()) {
// Task completed successfully
AuthResult result = task.getResult();
} else {
// Task failed with an exception
Exception exception = task.getException();
}
}
});
Regulacja brwi nitką
Słuchacze załączone do wątku są domyślnie uruchamiane w głównym wątku aplikacji (UI). Podczas dołączania detektora możesz też określić właściwość Executor, która służy do planowania odbiorników.
// Create a new ThreadPoolExecutor with 2 threads for each processor on the
// device and a 60 second keep-alive time.
int numCores = Runtime.getRuntime().availableProcessors();
ThreadPoolExecutor executor = new ThreadPoolExecutor(numCores * 2, numCores *2,
60L, TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>());
task.addOnCompleteListener(executor, new OnCompleteListener<AuthResult>() {
@Override
public void onComplete(@NonNull Task<AuthResult> task) {
// ...
}
});
Słuchacze ograniczone do aktywności
Jeśli nasłuchujesz wyników zadania w polu Activity, możesz dodać do zadania detektory ograniczone do aktywności. Te detektory są usuwane w ramach metody onStop Twojej aktywności, dzięki czemu nie są one wywoływane, gdy aktywność nie jest już widoczna.
Activity activity = MainActivity.this;
task.addOnCompleteListener(activity, new OnCompleteListener<AuthResult>() {
@Override
public void onComplete(@NonNull Task<AuthResult> task) {
// ...
}
});
Łańcuchowe
Jeśli używasz wielu interfejsów API, które zwracają Task, możesz łączyć je w łańcuch, posługując się kontynuacją. Pomaga to uniknąć głęboko zagnieżdżonych wywołań zwrotnych i konsoliduje obsługę błędów w łańcuchach zadań.
Na przykład metoda doSomething zwraca Task<String>, ale wymaga AuthResult, który uzyskamy asynchronicznie z zadania:
public Task<String> doSomething(AuthResult authResult) {
// ...
}
Korzystając z metody Task.continueWithTask, możemy połączyć te 2 zadania:
Task<AuthResult> signInTask = FirebaseAuth.getInstance().signInAnonymously();
signInTask.continueWithTask(new Continuation<AuthResult, Task<String>>() {
@Override
public Task<String> then(@NonNull Task<AuthResult> task) throws Exception {
// Take the result from the first task and start the second one
AuthResult result = task.getResult();
return doSomething(result);
}
}).addOnSuccessListener(new OnSuccessListener<String>() {
@Override
public void onSuccess(String s) {
// Chain of tasks completed successfully, got result from last task.
// ...
}
}).addOnFailureListener(new OnFailureListener() {
@Override
public void onFailure(@NonNull Exception e) {
// One of the tasks in the chain failed with an exception.
// ...
}
});
Blokowanie
Jeśli Twój program wykonuje już wątek w tle, możesz zablokować jego zadanie, by synchronicznie wyświetlił się wynik:
try {
// Block on a task and get the result synchronously. This is generally done
// when executing a task inside a separately managed background thread. Doing this
// on the main (UI) thread can cause your application to become unresponsive.
AuthResult authResult = Tasks.await(task);
} catch (ExecutionException e) {
// The Task failed, this is the same exception you'd get in a non-blocking
// failure handler.
// ...
} catch (InterruptedException e) {
// An interrupt occurred while waiting for the task to complete.
// ...
}
Możesz też określić czas oczekiwania na zablokowanie zadania, aby aplikacja się nie zawieszała:
try {
// Block on the task for a maximum of 500 milliseconds, otherwise time out.
AuthResult authResult = Tasks.await(task, 500, TimeUnit.MILLISECONDS);
} catch (ExecutionException e) {
// ...
} catch (InterruptedException e) {
// ...
} catch (TimeoutException e) {
// Task timed out before it could complete.
// ...
}
Interoperacyjność
Typ Task jest zgodny z kilkoma popularnymi metodami Androida przy zarządzaniu kodem asynchronicznym, a element Task można w prosty sposób przekształcić w inne elementy podstawowe, takie jak korelacje ListenableFuture i Kotlin, które są zalecane przez Androida X.
Oto przykład użycia znacznika Task:
// ...
simpleTask.addOnCompleteListener(this) {
completedTask -> textView.text = completedTask.result
}
Kotlin
Wykorzystanie
Dodaj poniższą zależność do projektu i użyj poniższego kodu do konwersji z Task.
Gradle (build.gradle na poziomie modułu, zwykle app/build.gradle)
// Source: https://github.com/Kotlin/kotlinx.coroutines/tree/master/integration/kotlinx-coroutines-play-services implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.4.1'
Krótki opis
import kotlinx.coroutines.tasks.await // ... textView.text = simpleTask.await() }
Guava ListenableFuture
Dodaj poniższą zależność do projektu i użyj poniższego kodu do konwersji z Task.
Gradle (build.gradle na poziomie modułu, zwykle app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.1.0"
Krótki opis
import com.google.common.util.concurrent.ListenableFuture
// ...
/** Convert Task to ListenableFuture. */
fun <T> taskToListenableFuture(task: Task<T>): ListenableFuture<T> {
return CallbackToFutureAdapter.getFuture { completer ->
task.addOnCompleteListener { completedTask ->
if (completedTask.isCanceled) {
completer.setCancelled()
} else if (completedTask.isSuccessful) {
completer.set(completedTask.result)
} else {
val e = completedTask.exception
if (e != null) {
completer.setException(e)
} else {
throw IllegalStateException()
}
}
}
}
}
// ...
this.listenableFuture = taskToListenableFuture(simpleTask)
this.listenableFuture?.addListener(
Runnable {
textView.text = listenableFuture?.get()
},
ContextCompat.getMainExecutor(this)
)
RxJava2 Dostrzegalne
Dodaj do projektu oprócz zależności względnej wybranej asynchronicznej biblioteki i użyj poniższego kodu do konwertowania z Task.
Gradle (build.gradle na poziomie modułu, zwykle app/build.gradle)
// Source: https://github.com/ashdavies/rx-tasks implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'
Krótki opis
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }