Interfejs Tasks API

Począwszy od Usług Google Play w wersji 9.0.0 możesz używać interfejsu API Task i wielu metod, które zwracają klasę Task lub jej podklasy. Task to interfejs API, który reprezentuje asynchroniczne wywołania metod, podobnie jak PendingResult w poprzednich wersjach Usług Google Play.

Obsługa wyników zadań

Typową metodą zwracającą wartości Task jest FirebaseAuth.signInAnonymously(). Zwraca on Task<AuthResult>, co oznacza, że zadanie zwróci obiekt AuthResult, jeśli zakończy się powodzeniem:

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

Aby otrzymać powiadomienie o wykonaniu zadania, dołącz dokument OnSuccessListener:

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

Aby otrzymać powiadomienie, gdy zadanie się nie powiedzie, dołącz dokument OnFailureListener:

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

Aby obsługiwać sukces i niepowodzenie w tym samym detektorze, 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ą

Detektory dołączone do wątku są domyślnie uruchamiane w głównym wątku aplikacji. Gdy dołączasz detektor, możesz też podać element Executor, który będzie używany 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) {
        // ...
    }
});

Detektory ograniczone do aktywności

Jeśli nasłuchujesz wyników zadania w postaci Activity, możesz dodać do niego detektory ograniczone do aktywności. Te detektory są usuwane w trakcie korzystania z metody onStop 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ńcuchy

Jeśli używasz wielu interfejsów API, które zwracają ciąg Task, możesz je połączyć w łańcuch, łącząc je dalej. Pomaga to uniknąć głęboko zagnieżdżonych wywołań zwrotnych i skonsoliduje obsługę błędów w łańcuchach zadań.

Na przykład metoda doSomething zwraca wartość Task<String>, ale wymaga metody AuthResult, która zostanie pobrana asynchronicznie z zadania:

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

Korzystając z metody Task.continueWithTask, można 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.
        // ...
    }
});

Blokuje

Jeśli Twój program wykonuje już działanie w wątku w tle, możesz zablokować zadanie, aby synchronicznie pobierać wyniki 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ć czas oczekiwania przy blokowaniu 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ść

Element Task jest zgodny koncepcyjnie z kilkoma popularnymi sposobami zarządzania kodem asynchronicznym w Androidzie. Element Task można w prosty sposób przekonwertować na inne podstawowe elementy, w tym koronty ListenableFuture i Kotlin, które są zalecane w AndroidzieX.

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

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

Kortyna Kotlin

Wykorzystanie

Dodaj do swojego projektu podaną zależność i użyj podanego niżej kodu, aby przeprowadzić konwersję z komponentu 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'
build.gradle
Krótki opis
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}
MainActivity.kt

Guava ListenableFuture.

Dodaj do swojego projektu podaną zależność i użyj podanego niżej kodu, aby przeprowadzić konwersję z komponentu Task.

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

Obserwowalna wartość RxJava2

Dodaj poniższą zależność do względnej biblioteki asynchronicznej do wyboru i użyj podanego niżej kodu, aby przeprowadzić konwersję 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'
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