API Tasks

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

Gestione dei risultati delle attività

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

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

Per ricevere una notifica quando l'attività va a buon fine, allega un OnSuccessListener:

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

Per ricevere una notifica quando l'attività ha esito negativo, allega un OnFailureListener:

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

Per gestire i operazioni riuscite e non riuscite 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, i listener collegati a un thread vengono eseguiti sul thread dell'applicazione principale (UI). 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) {
        // ...
    }
});

Ascoltatori con ambito attività

Se stai ascoltando i risultati delle attività in un Activity, potresti voler aggiungere listener con ambito attività all'attività. Questi listener 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) {
        // ...
    }
});

Concatenazione

Se utilizzi più API che restituiscono Task, puoi concatenarle utilizzando una continuazione. In questo modo è possibile evitare callback nidificati e consolidare la gestione degli errori per catene di attività.

Ad esempio, il metodo doSomething restituisce Task<String>, ma richiede 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.
        // ...
    }
});

Traffico bloccato

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 venga bloccata:

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 è in linea concettualmente diversi approcci di Android molto diffusi per la gestione del codice asincrono e un Task può essere convertito facilmente in altre priorità, tra cui le coroutine ListenableFuture e Kotlin, consigliate da AndroidX.

Ecco un esempio con l'utilizzo di Task:

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

Coroutine Kotlin

Utilizzo

Aggiungi la seguente dipendenza al tuo progetto e utilizza il codice seguente per eseguire la conversione da un elemento Task.

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

Aggiungi la seguente dipendenza al tuo progetto e utilizza il codice seguente per eseguire la conversione da un elemento Task.

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

Osservabile RxJava2

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

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