Tasks API

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

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

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

คุณจัดการผลลัพธ์ของ Task ได้โดยแนบ Listeners ที่ตอบสนองต่อการดำเนินการที่เสร็จสมบูรณ์ ไม่สำเร็จ หรือทั้ง 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();
        }
    }
});

จัดการชุดข้อความ

โดยค่าเริ่มต้น โปรแกรมฟังที่แนบอยู่กับ Task จะทํางานในเธรดหลัก (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) {
        // ...
    }
});

ใช้ Listener ระดับกิจกรรม

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

ตัวอย่างเช่น สมมติว่าคุณมีเมธอด 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.
        // ...
    }
});

บล็อกงาน

หากโปรแกรมกำลังทำงานอยู่ในเธรดแบ็กกราวด์อยู่แล้ว คุณสามารถบล็อกเธรดปัจจุบันและรอให้งานเสร็จสมบูรณ์แทนที่จะใช้การเรียกกลับได้ ดังนี้

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

Coroutine ของ Kotlin

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

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