Die Tasks APIs

Die Task API ist die Standardmethode für die Verarbeitung asynchroner Vorgänge in Google Play-Diensten. Sie bietet eine leistungsstarke und flexible Möglichkeit, asynchrone Aufrufe zu verwalten, und ersetzt das ältere PendingResult-Muster. Mit Task können Sie mehrere Aufrufe verketten, komplexe Abläufe verarbeiten und übersichtliche Erfolgs- und Fehlerhandler schreiben.

Aufgabenergebnisse verarbeiten

Viele APIs in Google Play-Diensten und Firebase geben ein Task-Objekt zurück, um asynchrone Vorgänge darzustellen. Beispiel: FirebaseAuth.signInAnonymously() gibt ein Task<AuthResult> zurück, das das Ergebnis des Anmeldevorgangs darstellt. Das Task<AuthResult> gibt an, dass bei erfolgreichem Abschluss der Aufgabe ein AuthResult-Objekt zurückgegeben wird.

Sie können das Ergebnis eines Task verarbeiten, indem Sie Listener anhängen, die auf erfolgreichen Abschluss, Fehler oder beides reagieren:

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

Hängen Sie ein OnSuccessListener an, um den erfolgreichen Abschluss einer Aufgabe zu verarbeiten:

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

Um eine fehlgeschlagene Aufgabe zu verarbeiten, hängen Sie eine OnFailureListener an:

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

Wenn Sie sowohl Erfolg als auch Fehler im selben Listener verarbeiten möchten, hängen Sie ein OnCompleteListener an:

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

Threads verwalten

Standardmäßig werden Listener, die an ein Task angehängt sind, im Haupt-Thread (UI) der Anwendung ausgeführt. Das bedeutet, dass Sie in Listenern keine Vorgänge mit langer Ausführungszeit ausführen sollten. Wenn Sie einen lang andauernden Vorgang ausführen müssen, können Sie einen Executor angeben, der zum Planen von Listenern in einem Hintergrundthread 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) {
        // ...
    }
});

Aktivitätsbezogene Listener verwenden

Wenn Sie Task-Ergebnisse in einem Activity verarbeiten müssen, ist es wichtig, den Lebenszyklus der Listener zu verwalten, damit sie nicht aufgerufen werden, wenn das Activity nicht mehr sichtbar ist. Dazu können Sie Listener mit Aktivitätsbereich verwenden. Diese Listener werden automatisch entfernt, wenn die onStop-Methode Ihres Activity aufgerufen wird. Sie werden also nicht ausgeführt, nachdem das Activity beendet wurde.

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

Aufgaben verketten

Wenn Sie eine Reihe von APIs verwenden, die Task-Objekte in einer komplexen Funktion zurückgeben, können Sie sie mit Fortsetzungen verketten. So lassen sich tief verschachtelte Callbacks vermeiden und die Fehlerbehandlung für mehrere verkettete Aufgaben konsolidieren.

Stellen Sie sich beispielsweise ein Szenario vor, in dem Sie eine Methode doSomething haben, die ein Task<String> zurückgibt, aber ein AuthResult als Parameter erfordert. Sie können diese AuthResult asynchron von einem anderen Task abrufen:

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

Mit der Methode Task.continueWithTask können Sie 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.
        // ...
    }
});

Aufgabe blockieren

Wenn Ihr Programm bereits in einem Hintergrundthread ausgeführt wird, können Sie den aktuellen Thread blockieren und warten, bis die Aufgabe abgeschlossen ist, anstatt einen Callback zu verwenden:

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 angeben, wenn Sie eine Aufgabe blockieren, um zu verhindern, dass Ihre Anwendung auf unbestimmte Zeit hängen bleibt, wenn die Aufgabe zu lange dauert:

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

Task ist so konzipiert, dass es gut mit anderen gängigen asynchronen Programmiermustern für Android funktioniert. Sie kann in andere Primitiven wie ListenableFuture und Kotlin-Coroutinen konvertiert werden und umgekehrt. Kotlin-Coroutinen werden von AndroidX empfohlen. So können Sie den Ansatz verwenden, der Ihren Anforderungen am besten entspricht.

Hier ein Beispiel mit einem Task:

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

Kotlin-Koroutine

Wenn Sie Kotlin-Coroutinen mit Task verwenden möchten, fügen Sie Ihrem Projekt die folgende Abhängigkeit hinzu und verwenden Sie dann das Code-Snippet, um von einem 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

Wenn Sie Guava ListenableFuture mit Task verwenden möchten, fügen Sie Ihrem Projekt die folgende Abhängigkeit hinzu und verwenden Sie dann das Code-Snippet, um eine Konvertierung von Task vorzunehmen.

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 relativen asynchronen Bibliothek Ihrer Wahl die folgende Abhängigkeit hinzu und verwenden Sie dann das Code-Snippet, um eine 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