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

ในการจัดการความสำเร็จและความล้มเหลวใน Listener เดียวกัน ให้แนบ 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();
        }
    }
});

ด้ายกำจัดขน

Listener ที่แนบกับเทรดจะทำงานบนเทรดหลัก (UI) ของแอปพลิเคชัน โดยค่าเริ่มต้น เมื่อแนบ Listener คุณยังสามารถระบุ 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 คุณอาจต้องเพิ่ม ที่กำหนดขอบเขตระดับกิจกรรมให้กับงาน ระบบจะนำ Listener เหล่านี้ออกระหว่าง เมธอด onStop ของกิจกรรมเพื่อไม่ให้ระบบเรียกผู้ฟังของคุณ เมื่อกิจกรรมไม่ปรากฏอีกต่อไป

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

แบบโซ่

หากใช้ API หลายรายการที่แสดง Task คุณสามารถเชื่อมโยง API เหล่านั้นเข้าด้วยกันได้ โดยใช้ความต่อเนื่อง วิธีนี้จะช่วยหลีกเลี่ยง Callback ที่ซ้อนกันและการรวม การจัดการข้อผิดพลาดสำหรับงานต่อๆ ไป

ตัวอย่างเช่น เมธอด doSomething จะแสดง Task<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.
        // ...
    }
});

จะมีการบล็อก

หากโปรแกรมกำลังทำงานในเทรดในเบื้องหลังอยู่แล้ว คุณจะบล็อกได้ งานเพื่อให้ได้ผลลัพธ์พร้อมกันและหลีกเลี่ยงการ 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.
    // ...
}

คุณยังระบุระยะหมดเวลาเมื่อบล็อกงานเพื่อให้แอปพลิเคชัน ไม่แขวน:

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
}
MainActivity.kt

โครูทีน Kotlin

การใช้งาน

เพิ่มทรัพยากร Dependency ต่อไปนี้ในโปรเจ็กต์แล้วใช้โค้ดด้านล่างเพื่อแปลง จาก 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

อนาคตที่ฟังได้ของฝรั่ง

เพิ่มทรัพยากร Dependency ต่อไปนี้ในโปรเจ็กต์แล้วใช้โค้ดด้านล่างเพื่อแปลง จาก 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 สังเกตได้

เพิ่มทรัพยากร Dependency ต่อไปนี้นอกเหนือจากไลบรารีที่ไม่พร้อมกันแบบสัมพัทธ์ของ เป็นโปรเจ็กต์ของคุณ และใช้รหัสด้านล่างเพื่อแปลงจาก 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

ขั้นตอนถัดไป

• ข้อมูลอ้างอิง Task รายการ
• ข้อมูลอ้างอิง Tasks รายการ