Interfejsy API zadań

Interfejs API Task to standardowy sposób obsługi operacji asynchronicznych w usługach Google Play. Zapewnia on zaawansowany i elastyczny sposób zarządzania wywołaniami asynchronicznymi, zastępując starszy wzorzec PendingResult. Dzięki Task możesz łączyć wiele wywołań, obsługiwać złożone przepływy i pisać przejrzyste moduły obsługi sukcesów i błędów.

Obsługa wyników zadania

Wiele interfejsów API w usługach Google Play i Firebase zwraca obiekt Task, który reprezentuje operacje asynchroniczne. Na przykład: FirebaseAuth.signInAnonymously() zwraca Task<AuthResult>, który reprezentuje wynik operacji logowania. Task<AuthResult> wskazuje, że po pomyślnym zakończeniu zadania zwróci ono obiekt AuthResult.

Wynik działania Task możesz obsłużyć, dołączając detektory, które reagują na pomyślne zakończenie, niepowodzenie lub oba te zdarzenia:

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

Aby obsłużyć pomyślne ukończenie zadania, dołącz OnSuccessListener:

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

Aby obsłużyć nieudane zadanie, dołącz OnFailureListener:

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

Aby obsłużyć zarówno powodzenie, jak 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();
        }
    }
});

Zarządzanie wątkami

Domyślnie detektory dołączone do obiektu Task są uruchamiane w głównym wątku aplikacji (UI). Oznacza to, że należy unikać wykonywania długo trwających operacji w detektorach. Jeśli musisz wykonać długo trwającą operację, możesz określić Executor, który będzie używany do planowania detektorów w wątku w tle.

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

Używanie detektorów o zakresie aktywności

Gdy musisz obsłużyć wyniki zadania w obiekcie Activity, ważne jest, aby zarządzać cyklem życia detektorów, aby zapobiec ich wywoływaniu, gdy obiekt Activity nie jest już widoczny. Możesz to zrobić za pomocą detektorów o zakresie aktywności. Te detektory są automatycznie usuwane po wywołaniu metody onStop obiektu Activity, dzięki czemu nie są wykonywane po zatrzymaniu obiektu Activity.

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

Zadania związane z siecią

Jeśli w złożonej funkcji używasz zestawu interfejsów API, które zwracają obiekty Task, możesz je połączyć za pomocą kontynuacji. Dzięki temu unikniesz głęboko zagnieżdżonych wywołań zwrotnych i skonsolidujesz obsługę błędów w przypadku wielu połączonych zadań.

Rozważmy na przykład sytuację, w której masz metodę doSomething zwracającą Task<String>, ale wymagającą parametru AuthResult. Możesz uzyskać ten AuthResult asynchronicznie z innego Task:

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

Za pomocą metody Task.continueWithTask możesz 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 zadania

Jeśli program jest już wykonywany w wątku w tle, możesz zablokować bieżący wątek i poczekać na zakończenie zadania, zamiast używać wywołania zwrotnego:

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 podczas blokowania zadania, aby zapobiec nieokreślonemu zawieszeniu aplikacji, jeśli zadanie trwa zbyt długo:

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 dobrze współpracuje z innymi popularnymi wzorcami programowania asynchronicznego na Androidzie. Można go przekonwertować na inne elementy podstawowe, takie jak ListenableFuture i współprogramy Kotlin, które są zalecane przez AndroidX, co pozwala na stosowanie podejścia, które najlepiej odpowiada Twoim potrzebom.

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

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

Współprogram Kotlin

Aby używać współprogramów Kotlin z Task, dodaj do projektu tę zależność, a następnie użyj fragmentu kodu, aby przekonwertować z 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.7.3'
Krótki opis
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}

Gujawa ListenableFuture

Aby używać Guava ListenableFuture z Task, dodaj do projektu tę zależność, a następnie użyj fragmentu kodu do konwersji z Task.

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

RxJava2 Observable

Dodaj do projektu tę zależność oraz wybraną względną bibliotekę asynchroniczną, a następnie użyj fragmentu kodu, aby przekonwertować 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'
Krótki opis
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }

Dalsze kroki