L'API Tasks

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

Gestione dei risultati dell'attività

Un metodo comune che restituisce un Task è FirebaseAuth.signInAnonymously(). Restituisce 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 quando l'attività ha esito positivo, allega un OnSuccessListener:

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

Per ricevere una notifica quando l'attività non va a buon fine, 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 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

I listener collegati a un thread vengono eseguiti sul thread principale dell'applicazione (UI) per impostazione predefinita. Quando colleghi un listener, puoi anche specificare un Executor da utilizzare per pianificare i listener.

// 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 con ambito attività

Se stai ascoltando i risultati dell'attività in un Activity, ti consigliamo di aggiungere all'attività listener con ambito di attività. Questi listener vengono rimossi durante il metodo onStop della tua 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) {
        // ...
    }
});

Concatenazione

Se utilizzi più API che restituiscono Task, puoi concatenarle utilizzando una continuazione. In questo modo si evitano callback molto nidificati e si consolida la gestione degli errori per catene di attività.

Ad esempio, il metodo doSomething restituisce 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 tuo programma è già in esecuzione in un thread in background, puoi bloccare un'attività per ottenere il risultato in modo sincrono ed evitare 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 elemento Task si allinea concettualmente a diversi approcci Android popolari alla gestione del codice asincrono e un elemento Task può essere convertito facilmente in altre primitive, tra cui le coroutine ListenableFuture e Kotlin, che sono consigliate da AndroidX.

Ecco un esempio utilizzando un Task:

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

Coroutine di Kotlin

Utilizzo

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

Gradle (a livello di modulo build.gradle, di solito 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'
Snippet
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}

Guava AscoltaableFuture

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

Gradle (a livello di modulo build.gradle, di solito app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.1.0"
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)
)

RxJava2 osservabile

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

Gradle (a livello di modulo build.gradle, di solito app/build.gradle)
// Source: https://github.com/ashdavies/rx-tasks
implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'
Snippet
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }

Passaggi successivi