Tasks API

Google Play 開発者サービス バージョン 9.0.0 以降では、Task API と Task またはそのサブクラスを返すメソッドの数。Task は、 非同期メソッド呼び出しを表します。これは、前のスライドの PendingResult と類似しています。 Google Play 開発者サービスの 2 つのバージョンがあります。

タスクの結果を処理する

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 でタスクの結果をリッスンしている場合は、 タスクへのアクティビティ スコープのリスナー。これらのリスナーは、指定された Activity の onStop メソッド。これにより、リスナーが呼び出されなくなります。 アクティビティを表示できなくなったとき。

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

チェーン

Task を返す複数の API を使用する場合は、それらの API を連結できます。 連続表現ですこれにより、コールバックが深くネストするのを回避でき、 タスクチェーンのエラー処理です。

たとえば、メソッド doSomethingTask<String> を返しますが、 AuthResult: タスクから非同期に取得します。

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 でよく利用されるいくつかの管理アプローチに概念的に沿うものです。 Task を簡単に他の非同期コードに変換できます。 ListenableFuture コルーチンや Kotlin コルーチンなど、 AndroidX がおすすめしています。

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

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

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'
スニペット
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}

Guava ListenableFuture

プロジェクトに次の依存関係を追加し、以下のコードを使用して変換します。 Task から。

Gradle(モジュール レベルの build.gradle、通常は app/build.gradle
implementation "androidx.concurrent:concurrent-futures:1.2.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 オブザーバブル

次の依存関係を追加します。さらに、Terraform の相対非同期ライブラリを 選択し、プロジェクトに追加し、以下のコードを使用して 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 }

次のステップ