API tác vụ

API Task là cách tiêu chuẩn để xử lý các thao tác không đồng bộ trong Dịch vụ Google Play. Phương thức này cung cấp một cách linh hoạt và mạnh mẽ để quản lý các lệnh gọi không đồng bộ, thay thế mẫu PendingResult cũ. Với Task, bạn có thể tạo chuỗi nhiều lệnh gọi, xử lý các luồng phức tạp và viết rõ trình xử lý thành công và không thành công.

Xử lý kết quả tác vụ

Nhiều API trong Dịch vụ Google Play và Firebase trả về một đối tượng Task để đại diện cho các thao tác không đồng bộ. Ví dụ: FirebaseAuth.signInAnonymously() trả về một Task<AuthResult> đại diện cho kết quả của thao tác đăng nhập. Task<AuthResult> cho biết rằng khi hoàn tất thành công, tác vụ sẽ trả về một đối tượng AuthResult.

Bạn có thể xử lý kết quả của Task bằng cách đính kèm trình nghe phản hồi việc hoàn tất thành công, không thành công hoặc cả hai:

Task<AuthResult> task = FirebaseAuth.getInstance().signInAnonymously();

Để xử lý việc hoàn thành tác vụ thành công, hãy đính kèm OnSuccessListener:

task.addOnSuccessListener(new OnSuccessListener<AuthResult>() {
    @Override
    public void onSuccess(AuthResult authResult) {
        // Task completed successfully
        // ...
    }
});

Để xử lý một tác vụ không thành công, hãy đính kèm OnFailureListener:

task.addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception e) {
        // Task failed with an exception
        // ...
    }
});

Để xử lý cả trường hợp thành công và không thành công trong cùng một trình nghe, hãy đính kèm 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();
        }
    }
});

Quản lý luồng

Theo mặc định, trình nghe đính kèm vào Task sẽ chạy trên luồng chính (giao diện người dùng) của ứng dụng. Điều này có nghĩa là bạn nên tránh thực hiện các thao tác chạy trong thời gian dài trong trình nghe. Nếu cần thực hiện một thao tác dài hạn, bạn có thể chỉ định một Executor dùng để lên lịch trình cho trình nghe trên luồng ở chế độ nền.

// 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) {
        // ...
    }
});

Sử dụng trình nghe trong phạm vi hoạt động

Khi cần xử lý kết quả tác vụ trong Activity, điều quan trọng là bạn phải quản lý vòng đời của trình nghe để ngăn việc gọi trình nghe khi Activity không còn hiển thị. Để làm việc này, bạn có thể sử dụng trình nghe trong phạm vi hoạt động. Các trình nghe này sẽ tự động bị xoá khi phương thức onStop của Activity được gọi để không được thực thi sau khi Activity bị dừng.

Activity activity = MainActivity.this;
task.addOnCompleteListener(activity, new OnCompleteListener<AuthResult>() {
    @Override
    public void onComplete(@NonNull Task<AuthResult> task) {
        // ...
    }
});

Tác vụ theo chuỗi

Nếu đang sử dụng một tập hợp API trả về các đối tượng Task trong một hàm phức tạp, bạn có thể nối các API đó với nhau bằng cách sử dụng các phần tiếp tục. Điều này giúp bạn tránh các lệnh gọi lại lồng nhau sâu và hợp nhất việc xử lý lỗi cho nhiều tác vụ theo chuỗi.

Ví dụ: hãy xem xét trường hợp bạn có một phương thức doSomething trả về Task<String>, nhưng phương thức này yêu cầu AuthResult làm tham số. Bạn có thể lấy AuthResult này một cách không đồng bộ từ một Task khác:

public Task<String> doSomething(AuthResult authResult) {
    // ...
}

Khi sử dụng phương thức Task.continueWithTask, bạn có thể tạo chuỗi cho hai tác vụ này:

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.
        // ...
    }
});

Chặn một tác vụ

Nếu chương trình của bạn đang thực thi trong một luồng ở chế độ nền, bạn có thể chặn luồng hiện tại và đợi tác vụ hoàn tất, thay vì sử dụng lệnh gọi lại:

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.
    // ...
}

Bạn cũng có thể chỉ định thời gian chờ khi chặn một tác vụ để ngăn ứng dụng bị treo vô thời hạn nếu tác vụ đó mất quá nhiều thời gian để hoàn thành:

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.
    // ...
}

Khả năng tương tác

Task được thiết kế để hoạt động hiệu quả với các mẫu lập trình không đồng bộ phổ biến khác của Android. Bạn có thể chuyển đổi từ và sang các loại dữ liệu gốc khác như ListenableFuture và coroutine Kotlin (được AndroidX đề xuất) để sử dụng phương pháp phù hợp nhất với nhu cầu của mình.

Sau đây là ví dụ về cách sử dụng Task:

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

Coroutine Kotlin

Để sử dụng coroutine Kotlin với Task, hãy thêm phần phụ thuộc sau vào dự án của bạn, sau đó sử dụng đoạn mã để chuyển đổi từ Task.

Gradle (build.gradle cấp mô-đun, thường là 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
Đoạn trích
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}
MainActivity.kt

Ổi ListenableFuture

Để sử dụng Guava ListenableFuture với Task, hãy thêm phần phụ thuộc sau vào dự án của bạn, sau đó sử dụng đoạn mã để chuyển đổi từ Task.

Gradle (build.gradle cấp mô-đun, thường là app/build.gradle)
implementation "androidx.concurrent:concurrent-futures:1.2.0"
build.gradle
Đoạn trích
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

Thêm phần phụ thuộc sau đây (ngoài thư viện không đồng bộ tương đối mà bạn chọn) vào dự án, sau đó sử dụng đoạn mã để chuyển đổi từ Task.

Gradle (build.gradle cấp mô-đun, thường là app/build.gradle)
// Source: https://github.com/ashdavies/rx-tasks
implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'
build.gradle
Đoạn trích
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }
MainActivity.kt

Các bước tiếp theo