Tasks API

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

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

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

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 เป็นพารามิเตอร์ คุณสามารถรับ AuthResult นี้แบบอะซิงโครนัสจาก Task อื่นได้โดยทำดังนี้

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

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

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

โครูทีน 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'
build.gradle

ตัวอย่างข้อมูล

import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}
MainActivity.kt

ชมพูกวาวา ListenableFuture

หากต้องการใช้ Guava ListenableFuture กับ Task ให้เพิ่มทรัพยากร 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 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'
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