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 ของกิจกรรม เพื่อไม่ให้ระบบเรียกผู้ฟังของคุณเมื่อกิจกรรมไม่แสดงอีกต่อไป

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 Cortine ซึ่งแนะนําโดย AndroidX

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

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

โครูทีน 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'
ตัวอย่างข้อมูล
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}

Guava ListenableFuture

เพิ่มทรัพยากร Dependency ต่อไปนี้ลงในโปรเจ็กต์ แล้วใช้รหัสด้านล่างเพื่อแปลงจาก Task

Gradle (ระดับโมดูล build.gradle มักอยู่ที่ app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.1.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

เพิ่มทรัพยากร 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'
ตัวอย่างข้อมูล
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }

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