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

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

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

โครูทีน Kotlin

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

ฝรั่ง ListenableFuture

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

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

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