La API de Tasks

Stay organized with collections Save and categorize content based on your preferences.

A partir de la versión 9.0.0 de los Servicios de Google Play, puedes usar una API de Task y varios métodos que muestren Task o sus subclases. Task es una API que representa las llamadas de métodos asíncronos, similares a PendingResult en versiones anteriores de los Servicios de Google Play.

Controla los resultados de las tareas

Un método común que muestra un objeto Task es FirebaseAuth.signInAnonymously(). Muestra un Task<AuthResult>, lo que significa que la tarea mostrará un objeto AuthResult cuando se complete correctamente:

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

Para recibir una notificación cuando la tarea se complete correctamente, adjunta una OnSuccessListener:

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

Para recibir una notificación cuando la tarea falle, adjunta un OnFailureListener:

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

Para manejar el éxito y la falla en el mismo objeto de escucha, adjunta 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();
        }
    }
});

Subprocesos

Los objetos de escucha conectados a un subproceso se ejecutan en el subproceso principal de la aplicación (IU) de forma predeterminada. Cuando adjuntas un objeto de escucha, también puedes especificar un Executor que se usa para programar objetos de escucha.

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

Objetos de escucha con alcance de actividad

Si estás escuchando resultados de tareas en una Activity, quizás quieras agregar objetos de escucha con alcance de actividad a la tarea. Estos objetos de escucha se quitan durante el método onStop de tu actividad, de modo que no se los llame cuando la actividad ya no esté visible.

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

Encadenamiento

Si usas varias API que muestran Task, puedes encadenarlas mediante una continuación. Esto ayuda a evitar devoluciones de llamada profundamente anidadas y consolida el manejo de errores para cadenas de tareas.

Por ejemplo, el método doSomething muestra un Task<String>, pero requiere un AuthResult, que obtendremos de forma asíncrona desde una tarea:

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

Con el método Task.continueWithTask, podemos encadenar estas dos tareas:

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

Bloqueado

Si tu programa ya se ejecuta en un subproceso en segundo plano, puedes bloquear una tarea para obtener el resultado de manera síncrona y evitar las devoluciones de llamada:

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

También puedes especificar un tiempo de espera cuando se bloquea una tarea para que tu aplicación no se bloquee:

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

Interoperabilidad

Un Task se alinea conceptualmente con varios enfoques populares de Android para administrar código asíncrono, y un Task se puede convertir directamente en otras primitivas, incluidas las corrutinas de ListenableFuture y Kotlin, que recomienda AndroidX.

A continuación, se muestra un ejemplo con un Task:

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

Corrutina de Kotlin

Uso

Agrega la siguiente dependencia a tu proyecto y usa el siguiente código para convertir un Task.

Gradle (generalmente app/build.gradle, 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'
Fragmento
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}

Guava Listenable del futuro

Agrega la siguiente dependencia a tu proyecto y usa el siguiente código para convertir un Task.

Gradle (generalmente app/build.gradle, build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.1.0"
Fragmento
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

Agrega la siguiente dependencia, además de la biblioteca asíncrona relativa que elijas, a tu proyecto y usa el siguiente código para convertir un Task.

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

Próximos pasos