このページは Cloud Translation API によって翻訳されました。

Tasks API

Task API は、Google Play 開発者サービスで非同期オペレーションを処理する標準の方法です。以前の PendingResult パターンに代わる、非同期呼び出しを強力かつ柔軟に管理する方法を提供します。Task を使用すると、複数の呼び出しを連結したり、複雑なフローを処理したり、明確な成功ハンドラと失敗ハンドラを作成したりできます。

タスクの結果を処理する

Google Play 開発者サービスと Firebase の多くの API は、非同期オペレーションを表す Task オブジェクトを返します。たとえば、FirebaseAuth.signInAnonymously() は、ログインオペレーションの結果を表す Task<AuthResult> を返します。Task<AuthResult> は、タスクが正常に完了すると AuthResult オブジェクトが返されることを示します。

Task の結果を処理するには、正常な完了、失敗、またはその両方に応答するリスナーを接続します。

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();
        }
    }
});

スレッドを管理する

デフォルトでは、Task に接続されたリスナーは、アプリのメイン（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 内でタスクの結果を処理する必要がある場合は、Activity が非表示になったときにリスナーが呼び出されないように、リスナーのライフサイクルを管理することが重要です。これを行うには、アクティビティスコープのリスナーを使用します。これらのリスナーは、Activity の onStop メソッドが呼び出されると自動的に削除されるため、Activity の停止後に実行されることはありません。

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

タスクを連携させる

複雑な関数で Task オブジェクトを返す一連の API を使用している場合は、継続を使用して API を連結できます。これにより、ネストされたコールバックを回避し、複数の連鎖タスクのエラー処理を統合できます。

たとえば、Task<String> を返すメソッド doSomething があり、パラメータとして AuthResult が必要なシナリオについて考えてみましょう。この AuthResult は、別の Task から非同期で取得できます。

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

Task.continueWithTask メソッドを使用すると、次の 2 つのタスクを連結できます。

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 非同期プログラミングパターンと連携して機能するように設計されています。ListenableFuture や Kotlin コルーチン（AndroidX で推奨）などの他のプリミティブとの間で変換できるため、ニーズに最適なアプローチを使用できます。

Task を使用した例を次に示します。

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

Kotlin コルーチン

Task で Kotlin コルーチンを使用するには、次の依存関係をプロジェクトに追加し、コードスニペットを使用して 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.7.3'build.gradle

スニペット

import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}MainActivity.kt

Guava `ListenableFuture`

Task で Guava ListenableFuture を使用するには、次の依存関係をプロジェクトに追加し、コードスニペットを使用して Task から変換します。

Gradle（モジュールレベルの `build.gradle`、通常は `app/build.gradle`）

implementation "androidx.concurrent:concurrent-futures:1.2.0"build.gradle

スニペット

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`

任意の相対非同期ライブラリに加えて、次の依存関係をプロジェクトに追加し、コードスニペットを使用して Task から変換します。

Gradle（モジュールレベルの `build.gradle`、通常は `app/build.gradle`）

// Source: https://github.com/ashdavies/rx-tasks
implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'build.gradle

スニペット

import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }MainActivity.kt

Tasks API コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

タスクの結果を処理する

スレッドを管理する

アクティビティ スコープのリスナーを使用する

タスクを連携させる

タスクをブロックする

相互運用性

Kotlin コルーチン

Gradle（モジュール レベルの build.gradle、通常は app/build.gradle）

スニペット

Guava ListenableFuture

Gradle（モジュール レベルの build.gradle、通常は app/build.gradle）

スニペット

RxJava2 Observable

Gradle（モジュール レベルの build.gradle、通常は app/build.gradle）

スニペット

次のステップ

Tasks API

アクティビティスコープのリスナーを使用する

Gradle（モジュールレベルの `build.gradle`、通常は `app/build.gradle`）

Guava `ListenableFuture`

Gradle（モジュールレベルの `build.gradle`、通常は `app/build.gradle`）

RxJava2 `Observable`

Gradle（モジュールレベルの `build.gradle`、通常は `app/build.gradle`）