Tasks API

ตั้งแต่บริการ Google Play เวอร์ชัน 9.0.0 เป็นต้นไป คุณจะใช้ API Task และเมธอดที่แสดง Task หรือคลาสย่อยของ API ได้หลายรายการ 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 coroutines ที่ 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.4.1'
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.1.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

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