Interfejs Tasks API

Począwszy od wersji 9.0.0 Usług Google Play możesz używać interfejsu API Task oraz kilku metod, które zwracają obiekt Task lub jego podklasy. Task to interfejs API, który reprezentuje asynchroniczne wywołania metody, podobne do PendingResult w poprzednich wersjach Usług Google Play.

Obsługa wyników zadań

Typową metodą zwracającą wartość Task jest FirebaseAuth.signInAnonymously(). Zwraca obiekt Task<AuthResult>, co oznacza, że po wykonaniu zadania zwróci on obiekt AuthResult:

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

Aby otrzymywać powiadomienia o udanym wykonaniu zadania, załącz OnSuccessListener:

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

Aby otrzymywać powiadomienia o nieudanych zadaniach, dołącz OnFailureListener:

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

Aby obsłużyć powodzenie i niepowodzenie w tym samym odbiorcy, 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ą

Odbiorniki dołączone do wątku są domyślnie uruchamiane w głównym wątku aplikacji (UI). Podczas dołączania słuchacza możesz też określić Executor, który jest używany do planowania słuchaczy.

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

Detektory ograniczone do aktywności

Jeśli nasłuchujesz wyników zadania w Activity, możesz dodać do zadania słuchaczy ograniczonych do zakresu aktywności. Te odbiorcy są usuwani podczas wywoływania metody onStop aktywności, aby nie byli wywoływani, 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ńcuchowanie

Jeśli używasz wielu interfejsów API, które zwracają Task, możesz je połączyć za pomocą parametru continuation. Pomaga to uniknąć głęboko zagnieżdżonych wywołań zwrotnych i skonsolidować obsługę błędów w łańcu zadań.

Na przykład metoda doSomething zwraca Task<String>, ale wymaga AuthResult, który otrzymamy asynchronicznie z zadania:

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

Za pomocą 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 program jest już wykonywany w wątku tlenowym, możesz zablokować zadanie, aby uzyskać wynik synchronicznie i uniknąć wywołań zwrotnych:

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ć limit czasu blokowania zadania, aby aplikacja nie zawieszała się:

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ść

Task jest zgodny pod względem koncepcyjnym z kilkoma popularnymi podejściami do zarządzania kodem asynchronicznym na Androidzie. Task można łatwo przekonwertować na inne prymitywy, w tym ListenableFuture i korzenie Kotlina, które są zalecane przez AndroidX.

Oto przykład użycia właściwości Task:

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

Współprogram Kotlin

Wykorzystanie

Dodaj do projektu podane niżej zależności i użyj kodu poniżej, aby przekształcić Task.

Gradle (na poziomie modułu build.gradle, 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.7.3'
build.gradle
Krótki opis
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}
MainActivity.kt

Guava ListenableFuture

Dodaj do projektu podane niżej zależności i użyj kodu poniżej, aby przekształcić Task.

Gradle (na poziomie modułu build.gradle, zwykle app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.2.0"
build.gradle
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)
)
MainActivity.kt

RxJava2 Observable

Dodaj do projektu ten element zależny (oraz wybraną przez siebie bibliotekę asynchroniczną) i użyj kodu poniżej, aby przekształcić Task.

Gradle (na poziomie modułu build.gradle, zwykle app/build.gradle)
// Source: https://github.com/ashdavies/rx-tasks
implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'
build.gradle
Krótki opis
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }
MainActivity.kt

Dalsze kroki