Tasks API

Ab Version 9.0.0 der Google Play-Dienste können Sie eine Task API und einen Anzahl von Methoden, die Task oder seine abgeleiteten Klassen zurückgeben. Task ist eine API, die stellt asynchrone Methodenaufrufe dar, ähnlich wie PendingResult in den vorherigen Versionen der Google Play-Dienste.

Aufgabenergebnisse verarbeiten

Eine gängige Methode, die eine Task zurückgibt, ist FirebaseAuth.signInAnonymously(). Sie gibt ein Task<AuthResult> zurück, was bedeutet, dass die Aufgabe ein AuthResult-Objekt, wenn die Ausführung erfolgreich war:

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

Um bei erfolgreicher Aufgabe benachrichtigt zu werden, hängen Sie ein OnSuccessListener an:

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

Um benachrichtigt zu werden, wenn die Aufgabe fehlschlägt, hängen Sie ein OnFailureListener an:

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

Um Erfolg und Misserfolg im selben Listener zu verarbeiten, hängen Sie ein 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();
        }
    }
});

Haarentfernung mit Faden

An einen Thread angehängte Listener werden im Hauptthread der Anwendung (UI) ausgeführt. ist standardmäßig aktiviert. Beim Anhängen eines Listeners können Sie auch einen Executor angeben, der zum Planen von Listenern.

// 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 einem Activity auf Aufgabenergebnisse warten, sollten Sie aktivitätsbezogene Listener für die Aufgabe. Diese Listener werden während die onStop-Methode Ihrer Activity, damit Ihre Listener 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 diese verketten. mit einer Fortsetzung. Dadurch werden tief verschachtelte Callbacks vermieden und Fehlerbehandlung bei Aufgabenketten.

Die Methode doSomething gibt beispielsweise ein Task<String> zurück, erfordert jedoch Ein AuthResult, das asynchron aus einer Aufgabe abgerufen wird:

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 Hintergrundthread ausgeführt wird, können Sie eine Aufgabe, um das Ergebnis synchron abzurufen und Rückrufe 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 beim Blockieren einer Aufgabe angeben, damit Ihre Anwendung bleibt nicht hängen:

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 orientiert sich konzeptionell an mehreren beliebten Android-Ansätzen für das Management asynchronen Code und ein Task kann einfach in andere Primitive, einschließlich der ListenableFuture- und Kotlin-Koroutinen, die empfohlen von AndroidX

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 Code unten zum Konvertieren von einem Task.

Gradle (build.gradle auf Modulebene, normalerweise 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
Ausschnitt
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 Code unten zum Konvertieren von einem Task.

Gradle (build.gradle auf Modulebene, normalerweise app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.2.0"
build.gradle
Ausschnitt
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-Beobachtbar

Fügen Sie die folgende Abhängigkeit zusätzlich zur relativen asynchronen Bibliothek von in Ihr Projekt und konvertieren Sie mit dem folgenden Code von einem Task.

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

Nächste Schritte