Tasks API

API Task เป็นวิธีมาตรฐานในการจัดการการดำเนินการแบบไม่พร้อมกันในบริการ Google Play โดยมีวิธีที่มีประสิทธิภาพและยืดหยุ่นในการจัดการการเรียกแบบไม่พร้อมกัน ซึ่งจะมาแทนที่รูปแบบ PendingResult แบบเดิม ด้วย Task คุณสามารถเชื่อมโยงการเรียกหลายรายการ จัดการโฟลว์ที่ซับซ้อน และเขียน Handler ที่ชัดเจนสำหรับความสำเร็จและความล้มเหลว

จัดการผลลัพธ์ของงาน

API หลายรายการในบริการ Google Play และ Firebase จะแสดงออบเจ็กต์ Task เพื่อแสดงการดำเนินการแบบไม่พร้อมกัน เช่น FirebaseAuth.signInAnonymously() จะแสดง Task<AuthResult> ซึ่งแสดงผลลัพธ์ของการดำเนินการลงชื่อเข้าใช้ Task<AuthResult> บ่งบอกว่าเมื่อดำเนินการเสร็จสมบูรณ์แล้ว ระบบจะแสดงออบเจ็กต์ AuthResult

คุณสามารถจัดการผลลัพธ์ของ Task ได้โดยการแนบ Listener ที่ตอบสนองต่อการดำเนินการเสร็จสมบูรณ์ ความล้มเหลว หรือทั้ง 2 อย่าง

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

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

ใช้ Listener ที่มีขอบเขตเป็นกิจกรรม

เมื่อต้องการจัดการผลลัพธ์ของงานภายใน Activity คุณต้องจัดการวงจรการทำงานของ Listener เพื่อป้องกันไม่ให้ระบบเรียก Listener เมื่อ Activity ไม่ปรากฏอีกต่อไป คุณสามารถใช้ Listener ที่มีขอบเขตเป็นกิจกรรมเพื่อดำเนินการนี้ได้ ระบบจะนำ Listener เหล่านี้ออกโดยอัตโนมัติเมื่อเรียกใช้เมธอด onStop ของ Activity เพื่อไม่ให้ Listener ทำงานหลังจากหยุด Activity แล้ว

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

เชื่อมโยงงาน

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

ตัวอย่างเช่น ลองพิจารณาสถานการณ์ที่คุณมีเมธอด doSomething ที่ แสดง Task<String> แต่ต้องใช้ AuthResult เป็นพารามิเตอร์ คุณสามารถรับ AuthResult นี้แบบไม่พร้อมกันจาก Task อื่นได้ดังนี้

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

คุณสามารถเชื่อมโยง 2 งานนี้เข้าด้วยกันได้โดยใช้เมธอด 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.
        // ...
    }
});

บล็อกงาน

หากโปรแกรมกำลังดำเนินการในเทรดเบื้องหลังอยู่แล้ว คุณสามารถบล็อกเทรดปัจจุบันและรอให้งานเสร็จสมบูรณ์แทนการใช้ 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 ได้อย่างมีประสิทธิภาพ โดยสามารถแปลงเป็นและจาก Primitive อื่นๆ เช่น ListenableFuture และโครูทีน Kotlin ซึ่ง AndroidX แนะนำให้ใช้ได้, คุณจึงเลือกใช้แนวทางที่เหมาะกับความต้องการของคุณมากที่สุด

ตัวอย่างการใช้ Task

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

โครูทีน Kotlin

หากต้องการใช้โครูทีน Kotlin กับ Task ให้เพิ่มทรัพยากร 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'
ตัวอย่างข้อมูล
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}

ListenableFuture ของ Guava

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

เพิ่มทรัพยากร 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'
ตัวอย่างข้อมูล
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }

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