A API Tasks

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

A partir da versão 9.0.0 do Google Play Services, é possível usar uma API Task e vários métodos que retornam Task ou as subclasses dela. Task é uma API que representa chamadas de método assíncronas, semelhante a PendingResult em versões anteriores do Google Play Services.

Como processar resultados de tarefas

Um método comum que retorna um Task é FirebaseAuth.signInAnonymously(). Ela retorna um Task<AuthResult>, o que significa que a tarefa retornará um objeto AuthResult quando for bem-sucedida:

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

Para receber uma notificação quando a tarefa for bem-sucedida, anexe um OnSuccessListener:

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

Para receber uma notificação quando a tarefa falhar, anexe um OnFailureListener:

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

Para gerenciar o sucesso e a falha no mesmo listener, anexe um 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();
        }
    }
});

Linha de execução

Os listeners anexados a uma linha de execução são executados na linha de execução principal do app (IU) por padrão. Ao anexar um listener, você também pode especificar um Executor usado para programar listeners.

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

Listeners com escopo de atividade

Se você estiver detectando resultados da tarefa em uma Activity, talvez queira adicionar listeners com escopo de atividade à tarefa. Esses listeners são removidos durante o método onStop da atividade para que eles não sejam chamados quando a atividade não estiver mais visível.

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

Encadeamento

Se você usar várias APIs que retornam Task, poderá encadeá-las junto com uma continuação. Isso ajuda a evitar callbacks aninhados profundamente e consolida o tratamento de erros para cadeias de tarefas.

Por exemplo, o método doSomething retorna um Task<String>, mas requer um AuthResult, que receberemos de maneira assíncrona de uma tarefa:

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

Com o método Task.continueWithTask, podemos encadear essas duas tarefas:

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

Bloqueio de conteúdo

Se o programa já estiver em execução em uma linha de execução em segundo plano, você poderá bloquear uma tarefa para receber o resultado de maneira síncrona e evitar callbacks:

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

Também é possível especificar um tempo limite ao bloquear uma tarefa para que o aplicativo não trave:

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

Interoperabilidade

Um Task se alinha conceitualmente a várias abordagens conhecidas do Android para gerenciar códigos assíncronos, e um Task pode ser facilmente convertido em outros primitivos, incluindo as corrotinas ListenableFuture e Kotlin, que são recomendados pelo AndroidX.

Veja um exemplo com um Task:

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

Corrotinas do Kotlin

Uso

Adicione a dependência abaixo ao seu projeto e use o código abaixo para converter de um Task.

Gradle (build.gradle no nível do módulo, normalmente 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()
}

ListenableFuture Guava

Adicione a dependência abaixo ao seu projeto e use o código abaixo para converter de um Task.

Gradle (build.gradle no nível do módulo, normalmente 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 observável

Adicione a seguinte dependência ao seu projeto, além da biblioteca assíncrona relativa, e use o código abaixo para converter a função Task.

Gradle (build.gradle no nível do módulo, normalmente 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 }

Próximas etapas