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. API này cung cấp một cách mạnh mẽ và linh hoạt để 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ể xâu chuỗi nhiều lệnh gọi, xử lý các luồng phức tạp và viết các trình xử lý thành công và thất bại rõ ràng.

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

Nhiều API trong Dịch vụ Google Play và Firebase trả về một đối tượng Task để biểu thị các thao tác không đồng bộ. Ví dụ: FirebaseAuth.signInAnonymously() trả về một Task<AuthResult> biểu thị kết quả của thao tác đăng nhập. Task<AuthResult> cho biết rằng khi tác vụ hoàn tất thành công, tác vụ này 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 các trình nghe phản hồi khi hoàn tất thành công, thất bại hoặc cả hai:

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

Để xử lý việc hoàn tất 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ý 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 thái thành công và thất bại 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, các trình nghe được đí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 chạy trong thời gian dài, bạn có thể chỉ định một Executor dùng để lên lịch cho các trình nghe trên một luồng 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 có phạm vi hoạt động

Khi cần xử lý kết quả của tác vụ trong một Activity, bạn cần quản lý vòng đời của trình nghe để ngăn không cho trình nghe được gọi khi Activity không còn hiển thị. Để thực hiện việc này, bạn có thể sử dụng trình nghe có 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, để chúng 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) {
        // ...
    }
});

Xâu chuỗi các tác vụ

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ể xâu chuỗi các API đó 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 được lồng sâu và hợp nhất việc xử lý lỗi cho nhiều tác vụ được xâu chuỗi.

Ví dụ: hãy xem xét một tình huống trong đó bạn có một phương thức doSomething mà trả về một Task<String>, nhưng phương thức này yêu cầu một 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) {
    // ...
}

Bằng cách sử dụng phương thức Task.continueWithTask, bạn có thể xâu chuỗi 2 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 tác vụ

Nếu chương trình của bạn đã thực thi trong một luồng 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 của bạn bị kẹt vô thời hạn nếu tác vụ mất quá nhiều thời gian để hoàn tất:

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 tốt với các mẫu lập trình không đồng bộ phổ biến khác của Android. API này có thể được chuyển đổi thành và từ các kiểu dữ liệu nguyên thuỷ khác như ListenableFuture và coroutine Kotlin (do AndroidX đề xuất), cho phép bạn sử dụng phương pháp phù hợp nhất với nhu cầu của mình.

Dưới đây là một ví dụ sử dụng Task:

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

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 (ở cấp mô-đun build.gradle, 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'
Đoạn trích
import kotlinx.coroutines.tasks.await
// ...
  textView.text = simpleTask.await()
}

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

RxJava2 Observable

Ngoài thư viện không đồng bộ tương đối mà bạn chọn, 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 (ở cấp mô-đun build.gradle, thường là app/build.gradle)
// Source: https://github.com/ashdavies/rx-tasks
implementation 'io.ashdavies.rx.rxtasks:rx-tasks:2.2.0'
Đoạn trích
import io.ashdavies.rx.rxtasks.toSingle
import java.util.concurrent.TimeUnit
// ...
simpleTask.toSingle(this).subscribe { result -> textView.text = result }

Các bước tiếp theo