API задач

Начиная с версии сервисов Google Play 9.0.0, вы можете использовать Task API и ряд методов, которые возвращают Task или его подклассы. Task — это API, который представляет асинхронные вызовы методов, аналогичный PendingResult в предыдущих версиях сервисов Google Play.

Обработка результатов задач

Распространенным методом, возвращающим Task , является FirebaseAuth.signInAnonymously() . Он возвращает Task<AuthResult> , что означает, что задача вернет объект AuthResult в случае успеха:

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

Чтобы получить уведомление об успешном выполнении задачи, прикрепите OnSuccessListener :

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

Чтобы получить уведомление в случае сбоя задачи, прикрепите OnFailureListener :

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

Чтобы обрабатывать успех и неудачу в одном и том же прослушивателе, прикрепите 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();
        }
    }
});

Резьба

Прослушиватели, прикрепленные к потоку, по умолчанию запускаются в основном потоке (UI) приложения. При подключении прослушивателя вы также можете указать Executor , который будет использоваться для планирования прослушивателей.

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

Слушатели на уровне активности

Если вы прослушиваете результаты задачи в Activity , вы можете добавить к задаче прослушиватели на уровне активности. Эти прослушиватели удаляются во время метода onStop вашего действия, чтобы ваши прослушиватели не вызывались, когда действие больше не отображается.

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

Цепочка

Если вы используете несколько API, которые возвращают Task , вы можете объединить их вместе, используя продолжение. Это помогает избежать глубоко вложенных обратных вызовов и консолидирует обработку ошибок для цепочек задач.

Например, метод doSomething возвращает Task<String> но требует AuthResult , который мы получим асинхронно из задачи:

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

Используя метод Task.continueWithTask , мы можем связать эти две задачи:

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

Блокировка

Если ваша программа уже выполняется в фоновом потоке, вы можете заблокировать задачу, чтобы получить результат синхронно и избежать обратных вызовов:

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

Вы также можете указать таймаут при блокировке задачи, чтобы ваше приложение не зависало:

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

Совместимость

Task концептуально соответствует нескольким популярным подходам Android к управлению асинхронным кодом, а Task можно напрямую преобразовать в другие примитивы, включая сопрограммы ListenableFuture и Kotlin, рекомендованные AndroidX .

Вот пример использования Task :

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

Котлин Корутина

Применение

Добавьте следующую зависимость в свой проект и используйте приведенный ниже код для преобразования из Task .

Gradle ( build.gradle на уровне модуля, обычно 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'
Фрагмент
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}

Гуава для прослушиванияБудущее

Добавьте следующую зависимость в свой проект и используйте приведенный ниже код для преобразования из Task .

Gradle ( build.gradle на уровне модуля, обычно app/build.gradle )
implementation "androidx.concurrent:concurrent-futures:1.1.0"
Фрагмент
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 наблюдаемый

Добавьте в свой проект следующую зависимость в дополнение к выбранной относительной асинхронной библиотеке и используйте приведенный ниже код для преобразования из Task .

Gradle ( build.gradle на уровне модуля, обычно app/build.gradle )
// Source: https://github.com/ashdavies/rx-tasks
implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'
Фрагмент
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }

Следующие шаги