Cập nhật tác vụ đã được thêm vào hàng đợi

WorkManager cho phép bạn cập nhật WorkRequest sau khi bạn đã thêm vào hàng đợi. Điều này thường cần thiết trong các ứng dụng lớn hơn, thường xuyên thay đổi các quy tắc ràng buộc hoặc cần cập nhật worker một cách nhanh chóng. Kể từ WorkManager phiên bản 2.8.0, API updateWork() là phương tiện để thực hiện việc này.

Phương thức updateWork() cho phép bạn thay đổi một số khía cạnh của WorkRequest một cách nhanh chóng mà không cần phải thực hiện quy trình huỷ và thêm một yêu cầu mới vào hàng đợi theo cách thủ công. Điều này giúp đơn giản hoá đáng kể quy trình phát triển.

Tránh huỷ công việc

Nhìn chung, bạn nên tránh huỷ WorkRequest hiện có và đưa một WorkRequest mới vào hàng đợi. Việc này có thể khiến ứng dụng lặp lại một số tác vụ nhất định và có thể yêu cầu bạn viết thêm một lượng mã đáng kể.

Hãy xem xét các ví dụ sau đây về trường hợp việc huỷ WorkRequest có thể gây ra khó khăn:

  • Yêu cầu phụ trợ: Nếu bạn huỷ một Worker trong khi nó đang tính toán tải trọng để gửi đến máy chủ, thì Worker mới cần bắt đầu lại và tính toán lại tải trọng có thể tốn kém.
  • Lập lịch biểu: Nếu huỷ một PeriodicWorkRequest và muốn PeriodicWorkRequest mới thực thi theo cùng một lịch biểu, bạn cần tính toán độ lệch thời gian để đảm bảo rằng thời gian thực thi mới phù hợp với yêu cầu công việc trước đó.

API updateWork() cho phép bạn cập nhật các quy tắc ràng buộc và tham số khác của yêu cầu công việc mà không gặp rắc rối khi huỷ và đưa yêu cầu mới vào hàng đợi.

Thời điểm huỷ công việc

Có những trường hợp bạn nên trực tiếp huỷ WorkRequest thay vì gọi updateWork(). Bạn nên làm việc này khi muốn thay đổi bản chất cơ bản của công việc mà bạn đã đưa vào hàng đợi.

Thời điểm cập nhật công việc

Hãy tưởng tượng một ứng dụng ảnh sao lưu ảnh của người dùng hằng ngày. Hệ thống đã đưa một PeriodicWorkRequest vào hàng đợi để thực hiện việc này. WorkRequest có các quy tắc ràng buộc yêu cầu thiết bị phải đang sạc và kết nối với Wi-Fi.

Tuy nhiên, người dùng chỉ sạc thiết bị trong 20 phút mỗi ngày bằng bộ sạc nhanh. Trong trường hợp này, ứng dụng có thể muốn cập nhật WorkRequest để nới lỏng quy tắc ràng buộc về việc sạc, nhờ đó ứng dụng vẫn có thể tải ảnh lên ngay cả khi thiết bị chưa được sạc đầy.

Trong trường hợp này, bạn có thể sử dụng phương thức updateWork() để cập nhật các quy tắc ràng buộc của yêu cầu công việc.

Cách cập nhật công việc

Phương thức updateWork() cung cấp một phương tiện đơn giản để cập nhật WorkRequest hiện có mà không cần phải huỷ và đưa một mới vào hàng đợi.

Để sử dụng công việc đã đưa vào hàng đợi cập nhật, hãy làm theo các bước sau:

  1. Lấy mã hiện có cho công việc trong hàng đợi: Lấy mã của WorkRequest mà bạn muốn cập nhật. Bạn có thể truy xuất mã nhận dạng này bằng bất kỳ API getWorkInfo nào hoặc bằng cách duy trì mã nhận dạng theo cách thủ công từ WorkRequest ban đầu để truy xuất sau bằng thuộc tính công khai WorkRequest.id, trước khi đưa mã nhận dạng vào hàng đợi.
  2. Tạo WorkRequest mới: Tạo một WorkRequest mới và sử dụng WorkRequest.Builder.setID() để đặt mã nhận dạng của WorkRequest mới khớp với mã nhận dạng của WorkRequest hiện có.
  3. Đặt quy tắc ràng buộc: Sử dụng WorkRequest.Builder.setConstraints() để truyền các quy tắc ràng buộc mới cho WorkManager.
  4. Gọi updateWork: Truyền WorkRequest mới đến updateWork().

Ví dụ về cập nhật công việc

Dưới đây là đoạn mã ví dụ bằng Kotlin minh hoạ cách sử dụng phương thức updateWork() để thay đổi các quy tắc ràng buộc về pin của WorkRequest dùng để tải ảnh lên:

suspend fun updatePhotoUploadWork() {
    // Get instance of WorkManager.
    val workManager = WorkManager.getInstance(context)

    // Retrieve the work request ID. In this example, the work being updated is unique
    // work so we can retrieve the ID using the unique work name.
    val photoUploadWorkInfoList = workManager.getWorkInfosForUniqueWork(
        PHOTO_UPLOAD_WORK_NAME
    ).await()

    val existingWorkRequestId = photoUploadWorkInfoList.firstOrNull()?.id ?: return

    // Update the constraints of the WorkRequest to not require a charging device.
    val newConstraints = Constraints.Builder()
        // Add other constraints as required here.
        .setRequiresCharging(false)
        .build()

    // Create new WorkRequest from existing Worker, new constraints, and the id of the old WorkRequest.
    val updatedWorkRequest: WorkRequest =
        OneTimeWorkRequestBuilder<MyWorker>()
            .setConstraints(newConstraints)
            .setId(existingWorkRequestId)
            .build()

    // Pass the new WorkRequest to updateWork().
    workManager.updateWork(updatedWorkRequest)
}

Xử lý kết quả

updateWork() trả về ListenableFuture<UpdateResult>. UpdateResult đã cho có thể có một trong nhiều giá trị cho biết liệu WorkManager có thể áp dụng các thay đổi của bạn hay không. Nó cũng cho biết thời điểm có thể áp dụng thay đổi.

Để biết thêm thông tin, hãy xem updateWork() và UpdateResult tài liệu tham khảo.

Theo dõi công việc với các thế hệ

Mỗi lần bạn cập nhật một WorkRequest, thế hệ của tệp đó sẽ tăng thêm một. Điều này cho phép bạn theo dõi chính xác WorkRequest nào hiện đang được đưa vào hàng đợi. Thế hệ giúp bạn kiểm soát chặt chẽ hơn khi quan sát, theo dõi và kiểm thử các yêu cầu công việc.

Để lấy thông tin về quá trình tạo WorkRequest, hãy làm theo các bước sau:

  1. WorkInfo: Gọi WorkManager.getWorkInfoById() để truy xuất một thực thể của WorkInfo tương ứng với WorkRequest của bạn.
  2. getGeneration: Gọi getGeneration() trên thực thể của WorkInfo. Int được trả về tương ứng với hoạt động tạo WorkRequest.
    • Xin lưu ý rằng không có trường hoặc thuộc tính tạo, chỉ có phương thức WorkInfo.getGeneration().

Ví dụ về quá trình tạo bản nhạc

Sau đây là ví dụ về cách triển khai quy trình làm việc được mô tả ở trên để truy xuất thế hệ của WorkRequest.

// Get instance of WorkManager.
val workManager = WorkManager.getInstance(context)

// Retrieve WorkInfo instance.
val workInfo = workManager.getWorkInfoById(oldWorkRequestId)

// Call getGeneration to retrieve the generation.
val generation = workInfo.getGeneration()

Chính sách cập nhật tác phẩm

Trước đây, giải pháp được đề xuất để cập nhật công việc định kỳ là đưa PeriodicWorkRequest vào hàng đợi bằng chính sách ExistingPeriodicWorkPolicy.REPLACE. Nếu có một PeriodicWorkRequest đang chờ xử lý có cùng id duy nhất, thì yêu cầu công việc mới sẽ huỷ và xoá yêu cầu đó. Chính sách này hiện không còn được dùng nữa để ưu tiên quy trình sử dụng ExistingPeriodicWorkPolicy.UPDATE.

Ví dụ: khi sử dụng enqueueUniquePeriodicWork với PeriodicWorkRequest, bạn có thể khởi động PeriodicWorkRequest mới bằng chính sách ExistingPeriodicWorkPolicy.UPDATE. Nếu có một PeriodicWorkRequest đang chờ xử lý có cùng tên riêng, WorkManager sẽ cập nhật công việc đó theo thông số kỹ thuật mới. Theo quy trình công việc này, bạn không cần sử dụng updateWork().