Tasks API

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

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 ซึ่งเราจะได้ผลลัพธ์แบบไม่พร้อมกันจากงาน ดังนี้

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

Guava ListenableFuture

เพิ่มทรัพยากร 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

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