As APIs Tasks

A API Task é a maneira padrão de processar operações assíncronas no Google Play Services. Ele oferece uma maneira flexível e poderosa de gerenciar chamadas assimétricas, substituindo o padrão PendingResult mais antigo. Com Task, é possível encadear várias chamadas, processar fluxos complexos e escrever processadores de sucesso e de falha claros.

Processar resultados de tarefas

Muitas APIs nos serviços do Google Play e no Firebase retornam um objeto Task para representar operações assíncronas. Por exemplo, FirebaseAuth.signInAnonymously() retorna um Task<AuthResult> que representa o resultado da operação de login. O Task<AuthResult> indica que, quando a tarefa for concluída com sucesso, ela vai retornar um objeto AuthResult.

É possível processar o resultado de uma Task anexando listeners que respondem a conclusão bem-sucedida, falha ou ambos:

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

Para processar a conclusão de uma tarefa, anexe um OnSuccessListener:

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

Para processar uma tarefa com falha, anexe um OnFailureListener:

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

Para processar sucesso e 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();
        }
    }
});

Gerenciar linhas de execução

Por padrão, os listeners anexados a um Task são executados na linha de execução principal (UI) do aplicativo. Isso significa que você precisa evitar operações de longa duração em listeners. Se você precisar realizar uma operação de longa duração, especifique um Executor que seja usado para programar listeners em uma linha de execução em segundo plano.

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

Usar listeners no escopo da atividade

Quando você precisa processar os resultados da tarefa em uma Activity, é importante gerenciar o ciclo de vida dos listeners para evitar que eles sejam chamados quando a Activity não estiver mais visível. Para isso, use listeners no escopo da atividade. Esses listeners são removidos automaticamente quando o método onStop do Activity é chamado, para que não sejam executados depois que o Activity é interrompido.

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

Encadear tarefas

Se você estiver usando um conjunto de APIs que retornam objetos Task em uma função complexa, é possível encadeá-los usando continuações. Isso ajuda a evitar callbacks anexados e consolida o processamento de erros para várias tarefas conectadas.

Por exemplo, considere um cenário em que você tem um método doSomething que retorna um Task<String>, mas exige um AuthResult como parâmetro. É possível acessar esse AuthResult de forma assíncrona em outro Task:

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

Usando o método Task.continueWithTask, você pode encadear estas 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.
        // ...
    }
});

Bloquear uma tarefa

Se o programa já estiver sendo executado em uma linha de execução em segundo plano, você poderá bloquear a linha de execução atual e aguardar a conclusão da tarefa, em vez de usar um 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.
    // ...
}

Também é possível especificar um tempo limite ao bloquear uma tarefa para evitar que o aplicativo fique preso indefinidamente se a tarefa demorar muito para ser concluída:

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

O Task foi projetado para funcionar bem com outros padrões de programação assíncrona comuns do Android. Ele pode ser convertido de e para outras primitivas, como ListenableFuture e corrotinas do Kotlin, que são recomendadas pelo AndroidX, permitindo que você use a abordagem que melhor se adapta às suas necessidades.

Confira um exemplo de uso de Task:

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

Corrotina do Kotlin

Para usar corrotinas do Kotlin com Task, adicione a dependência a seguir ao projeto e use o snippet de código para converter de um Task.

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

Para usar o ListenableFuture do Guava com Task, adicione a dependência a seguir ao seu projeto e use o snippet de código para converter de um Task.

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

RxJava2 Observable

Adicione a dependência a seguir, além da biblioteca assíncrona relativa de escolha, ao seu projeto e use o snippet de código para converter de um Task.

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

Próximas etapas

• Referência Task
• Referência Tasks