Tasks API

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

ด้ายกำจัดขน

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

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

การใช้งาน

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

Guava ListenableFuture

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

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