Tasks API

Ab Version 9.0.0 der Google Play-Dienste können Sie eine Task API und eine Reihe von Methoden verwenden, die Task oder seine Unterklassen zurückgeben. Task ist eine API, die asynchrone Methodenaufrufe darstellt, ähnlich wie PendingResult in früheren Versionen der Google Play-Dienste.

Umgang mit Aufgabenergebnissen

Eine gängige Methode, die eine Task zurückgibt, ist FirebaseAuth.signInAnonymously(). Es gibt eine Task<AuthResult> zurück, was bedeutet, dass die Aufgabe bei Erfolg ein AuthResult-Objekt zurückgibt:

Task<AuthResult> task = FirebaseAuth.getInstance().signInAnonymously();

Wenn Sie benachrichtigt werden möchten, wenn die Aufgabe erfolgreich war, hängen Sie eine OnSuccessListener an:

task.addOnSuccessListener(new OnSuccessListener<AuthResult>() {
    @Override
    public void onSuccess(AuthResult authResult) {
        // Task completed successfully
        // ...
    }
});

Wenn Sie benachrichtigt werden möchten, wenn die Aufgabe fehlschlägt, hängen Sie eine OnFailureListener an:

task.addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception e) {
        // Task failed with an exception
        // ...
    }
});

Wenn Sie Erfolg und Fehler im selben Listener behandeln möchten, fügen Sie eine OnCompleteListener hinzu:

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

Haarentfernung mit Faden

An einen Thread angehängte Listener werden standardmäßig im Haupt-UI-Thread der Anwendung ausgeführt. Wenn Sie einen Listener anhängen, können Sie auch einen Executor angeben, der zum Planen von Listeners verwendet wird.

// 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) {
        // ...
    }
});

Listener auf Aktivitätsebene

Wenn Sie in einer Activity auf Aufgabenergebnisse warten, sollten Sie der Aufgabe Listener auf Aktivitätsebene hinzufügen. Diese Listener werden während der onStop-Methode Ihrer Aktivität entfernt, damit sie nicht aufgerufen werden, wenn die Aktivität nicht mehr sichtbar ist.

Activity activity = MainActivity.this;
task.addOnCompleteListener(activity, new OnCompleteListener<AuthResult>() {
    @Override
    public void onComplete(@NonNull Task<AuthResult> task) {
        // ...
    }
});

Verkettung

Wenn Sie mehrere APIs verwenden, die Task zurückgeben, können Sie sie mithilfe einer Fortsetzung verketten. So lassen sich tief verschachtelte Callbacks vermeiden und die Fehlerbehandlung für Aufgabenketten konsolidieren.

Angenommen, die Methode doSomething gibt eine Task<String> zurück, benötigt aber eine AuthResult, die wir asynchron von einer Aufgabe abrufen:

public Task<String> doSomething(AuthResult authResult) {
    // ...
}

Mit der Methode Task.continueWithTask können wir diese beiden Aufgaben verketten:

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.
        // ...
    }
});

Blockierungen

Wenn Ihr Programm bereits in einem Hintergrund-Thread ausgeführt wird, können Sie eine Aufgabe blockieren, um das Ergebnis synchron abzurufen und Callbacks zu vermeiden:

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.
    // ...
}

Sie können auch ein Zeitlimit für das Blockieren einer Aufgabe angeben, damit Ihre Anwendung nicht hängt:

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.
    // ...
}

Interoperabilität

Ein Task entspricht konzeptionell mehreren gängigen Android-Ansätzen zur Verwaltung von asynchronem Code. Außerdem kann ein Task problemlos in andere Primitive konvertiert werden, einschließlich ListenableFuture und Kotlin-Coroutinen, die von AndroidX empfohlen werden.

Hier ein Beispiel mit einem Task:

// ...
simpleTask.addOnCompleteListener(this) {
  completedTask -> textView.text = completedTask.result
}
MainActivity.kt

Kotlin-Koroutine

Nutzung

Fügen Sie Ihrem Projekt die folgende Abhängigkeit hinzu und verwenden Sie den folgenden Code, um von einer Task zu konvertieren.

Gradle (build.gradle auf Modulebene, in der Regel 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.7.3'
build.gradle
Snippet
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}
MainActivity.kt

Guava ListenableFuture

Fügen Sie Ihrem Projekt die folgende Abhängigkeit hinzu und verwenden Sie den folgenden Code, um von einer Task-Datei zu konvertieren.

Gradle (build.gradle auf Modulebene, in der Regel app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.2.0"
build.gradle
Snippet
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)
)
MainActivity.kt

RxJava2 Observable

Fügen Sie Ihrem Projekt zusätzlich zur gewünschten relativen asynchronen Bibliothek die folgende Abhängigkeit hinzu und verwenden Sie den folgenden Code, um von einer Task zu konvertieren.

Gradle (build.gradle auf Modulebene, in der Regel app/build.gradle)
// Source: https://github.com/ashdavies/rx-tasks
implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'
build.gradle
Snippet
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }
MainActivity.kt

Nächste Schritte