L'API Tasks

A partire dalla versione 9.0.0 di Google Play Services, puoi utilizzare un'API Task e un numero di metodi che restituiscono Task o i suoi sottoclassi. Task è un'API che rappresenta chiamate di metodi asincrone, simile a PendingResult nelle versioni precedenti di Google Play Services.

Gestione dei risultati delle attività

Un metodo comune che restituisce un Task è FirebaseAuth.signInAnonymously(). Restituisce un Task<AuthResult>, il che significa che l'attività restituirà un oggetto AuthResult se ha esito positivo:

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

Per ricevere una notifica al termine dell'attività, allega un OnSuccessListener:

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

Per ricevere una notifica in caso di errore dell'attività, allega un OnFailureListener:

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

Per gestire l'esito positivo e quello negativo nello stesso listener, allega un 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();
        }
    }
});

Depilazione con filo

Per impostazione predefinita, gli ascoltatori associati a un thread vengono eseguiti sul thread principale (UI) dell'applicazione. Quando colleghi un ascoltatore, puoi anche specificare un Executor utilizzato per programmare gli ascoltatori.

// 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 basati sulle attività

Se stai ascoltando i risultati di un'attività in un Activity, ti consigliamo di aggiungere all'attività ascoltatori basati sulle attività. Questi ascoltatori vengono rimossi durante il metodo onStop dell'attività in modo che non vengano chiamati quando l'attività non è più visibile.

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

Catena

Se utilizzi più API che restituiscono Task, puoi collegarle tra loro utilizzando un'istruzione di continuazione. In questo modo si evitano callback nidificati in modo complesso e si consolida la gestione degli errori per le catene di attività.

Ad esempio, il metodo doSomething restituisce un Task<String>, ma richiede un AuthResult, che otteniamo in modo asincrono da un'attività:

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

Utilizzando il metodo Task.continueWithTask, possiamo concatenare queste due attività:

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

Blocco

Se il programma è già in esecuzione in un thread in background, puoi bloccare un'attività per ottenere il risultato in modo sincrono ed evitare i callback:

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.
    // ...
}

Puoi anche specificare un timeout quando blocchi un'attività in modo che l'applicazione non si blocchi:

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à

Un Task è concettualmente in linea con diversi approcci Android comuni per la gestione del codice asincrono e può essere convertito facilmente in altre primitive, tra cui le coroutine ListenableFuture e Kotlin, che sono consigliate da AndroidX.Task

Ecco un esempio di utilizzo di un Task:

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

Coroutine Kotlin

Utilizzo

Aggiungi la seguente dipendenza al progetto e utilizza il codice riportato di seguito per eseguire la conversione da un Task.

Gradle (build.gradle a livello di modulo, in genere 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

Aggiungi la seguente dipendenza al progetto e utilizza il codice riportato di seguito per eseguire la conversione da un Task.

Gradle (build.gradle a livello di modulo, in genere 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

Osservabile RxJava2

Aggiungi la seguente dipendenza, oltre alla relativa libreria asincrona di scelta, al tuo progetto e utilizza il codice riportato di seguito per convertire da un Task.

Gradle (build.gradle a livello di modulo, in genere 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

Passaggi successivi