從 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) { // ... } });
鏈結
如果您使用多個會傳回 Task
的 API,則可以將這些 API 鏈結在一起
就會以接續的方式使用這有助於避免建立過多巢狀結構的回呼,並整合
工作鏈的錯誤處理。
舉例來說,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 }
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 可觀察項目
除了 Cloud 的相對非同步程式庫外,新增下列依附元件
並加入以下程式碼,從 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 }