Gỡ lỗi WorkManager

Nếu bạn nhận thấy rằng các trình thực thi (worker) của mình chạy quá thường xuyên hoặc không hề chạy, thì sau đây là một số bước gỡ lỗi có thể giúp bạn tìm hiểu vấn đề đang xảy ra.

Bật tính năng ghi nhật ký

Việc xem nhật ký chi tiết của WorkManager sẽ rất hữu ích để xác định nguyên nhân khiến các worker không hoạt động đúng cách. Để bật tính năng ghi nhật ký, bạn cần sử dụng tính năng khởi chạy tuỳ chỉnh. Trước tiên, hãy vô hiệu hoá WorkManagerInitializer mặc định trong AndroidManifest.xml bằng cách tạo một nhà cung cấp WorkManager mới có áp dụng quy tắc hợp nhất tệp kê khai remove:

<provider
    android:name="androidx.work.impl.WorkManagerInitializer"
    android:authorities="${applicationId}.workmanager-init"
    tools:node="remove"/>

Giờ đây, khi trình khởi chạy mặc định của WorkManager đã bị vô hiệu hoá, bạn có thể sử dụng tính năng khởi chạy theo yêu cầu. Để thực hiện việc này, lớp android.app.Application cần cung cấp phương thức triển khai cho androidx.work.Configuration.Provider.

Kotlin

class MyApplication() : Application(), Configuration.Provider {
    override fun getWorkManagerConfiguration() =
        Configuration.Builder()
            .setMinimumLoggingLevel(android.util.Log.DEBUG)
            .build()
}

Java

public class MyApplication extends Application implements Configuration.Provider {
    @NonNull
    @Override
    public Configuration getWorkManagerConfiguration() {
        return new Configuration.Builder()
                .setMinimumLoggingLevel(android.util.Log.DEBUG)
                .build();
    }
}

Khi bạn khai báo một cấu hình WorkManager tuỳ chỉnh, WorkManager sẽ khởi động khi bạn gọi WorkManager.getInstance(Context) thay vì tự động bắt đầu trong quá trình khởi động ứng dụng. Xem bài viết Cấu hình và tính năng khởi chạy tuỳ chỉnh của WorkManagerđể biết thêm thông tin, chẳng hạn như tính năng hỗ trợ cho các phiên bản WorkManager trước 2.1.0.

Khi bật tính năng ghi nhật ký DEBUG, bạn sẽ thấy nhiều hơn các nhật ký có tiền tố thẻ nhật ký WM-.

Sử dụng adb shell dumpsys jobscheduler

Trên API cấp 23 trở lên, bạn có thể chạy lệnh adb shell dumpsys jobscheduler để xem danh sách các công việc được quy cho gói của bạn.

Bạn sẽ thấy như sau:

JOB #u0a172/4: 6412553 com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService
  u0a172 tag=*job*/com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService
  Source: uid=u0a172 user=0 pkg=com.google.android.youtube
  JobInfo:
    Service: com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService
    Requires: charging=false batteryNotLow=false deviceIdle=false
    Extras: mParcelledData.dataSize=180
    Network type: NetworkRequest [ NONE id=0, [ Capabilities: NOT_METERED&INTERNET&NOT_RESTRICTED&TRUSTED&VALIDATED Uid: 10172] ]
    Minimum latency: +1h29m59s687ms
    Backoff: policy=1 initial=+30s0ms
    Has early constraint
  Required constraints: TIMING_DELAY CONNECTIVITY [0x90000000]
  Satisfied constraints: DEVICE_NOT_DOZING BACKGROUND_NOT_RESTRICTED WITHIN_QUOTA [0x3400000]
  Unsatisfied constraints: TIMING_DELAY CONNECTIVITY [0x90000000]
  Tracking: CONNECTIVITY TIME QUOTA
  Implicit constraints:
    readyNotDozing: true
    readyNotRestrictedInBg: true
  Standby bucket: RARE
  Base heartbeat: 0
  Enqueue time: -51m29s853ms
  Run time: earliest=+38m29s834ms, latest=none, original latest=none
  Last run heartbeat: 0
  Ready: false (job=false user=true !pending=true !active=true !backingup=true comp=true)

Khi sử dụng WorkManager, thành phần chịu trách nhiệm quản lý quá trình thực hiện của Worker là SystemJobService (trên API cấp 23 trở lên). Bạn nên tìm kiếm các thực thể của công việc được quy cho tên gói và androidx.work.impl.background.systemjob.SystemJobService.

Đối với mọi công việc, kết quả từ lệnh này liệt kê các giới hạn bắt buộc, hài lòng và không hài lòng. Bạn nên kiểm tra xem các giới hạn của worker có được đáp ứng đầy đủ hay không.

Bạn có thể sử dụng mã này để kiểm tra xem SystemJobService có được gọi gần đây hay không. Kết quả cũng bao gồm nhật ký công việc của các công việc đã thực thi gần đây:

Job history:
     -1h35m26s440ms   START: #u0a107/9008 com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService
     -1h35m26s362ms  STOP-P: #u0a107/9008 com.google.android.youtube/androidx.work.impl.background.systemjob.SystemJobService app called jobFinished

Yêu cầu thông tin chẩn đoán từ WorkManager phiên bản 2.4.0 trở lên

Trên các bản gỡ lỗi của ứng dụng, bạn có thể yêu cầu thông tin chẩn đoán từ WorkManager 2.4.0+ bằng cách sử dụng:

adb shell am broadcast -a "androidx.work.diagnostics.REQUEST_DIAGNOSTICS" -p "<your_app_package_name>"

Lệnh này cung cấp thông tin về:

  • Yêu cầu công việc đã hoàn thành trong 24 giờ qua.
  • Yêu cầu công việc hiện đang chạy.
  • Yêu cầu công việc đã lên lịch.

Kết quả trả về có thể có dạng như sau (logcat sẽ cho thấy kết quả):

adb shell am broadcast -a "androidx.work.diagnostics.REQUEST_DIAGNOSTICS" -p "androidx.work.integration.testapp"

adb logcat
...
2020-02-13 14:21:37.990 29528-29660/androidx.work.integration.testapp I/WM-DiagnosticsWrkr: Recently completed work:
2020-02-13 14:21:38.083 29528-29660/androidx.work.integration.testapp I/WM-DiagnosticsWrkr: Id  Class Name   State  Unique Name Tags
    08be261c-2def-4bd6-a716-1e4410968dc4     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    48ce04f1-8df9-450b-96ec-6eceabb9c690     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    c46f4699-c384-440c-a10e-26d56ce02963     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    ce125372-046e-484e-949f-9abb35ce62c3     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    72887ddd-8ed1-4018-b798-fac218e95e16     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    dcff3d61-320d-4996-8644-5d97944bd09c     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    acab0bf7-6087-43ad-bdb5-be0df9195acb     androidx.work.impl.workers.DiagnosticsWorker    SUCCEEDED  null    androidx.work.impl.workers.DiagnosticsWorker
    23136bcd-01dd-46eb-b910-0fe8a140c2a4     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    245f4879-c6d2-4997-8130-e4e90e1cab4c     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    17d05835-bb61-429a-ad11-fe43fc320a54     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    e95f12be-4b0c-4e64-88da-8ee07a31e42f     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    431c3ec2-4a55-469b-b50b-4072d35f1232     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    883a388f-f911-4098-9143-37bd8fbc098a     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    b904163c-6822-4299-8d5a-78df49b7e53d     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
    453fd7b9-2b16-45b9-abc5-3d2ce7b6a4ba     androidx.work.integration.testapp.ToastWorker   SUCCEEDED  null    androidx.work.integration.testapp.ToastWorker
2020-02-13 14:21:38.083 29528-29660/androidx.work.integration.testapp I/WM-DiagnosticsWrkr: Running work:
2020-02-13 14:21:38.089 29528-29660/androidx.work.integration.testapp I/WM-DiagnosticsWrkr: Id  Class Name   State  Unique Name Tags
    b87c8a4f-4ac6-4e25-ba3e-4cea53ce468a     androidx.work.impl.workers.DiagnosticsWorker    RUNNING    null    androidx.work.impl.workers.DiagnosticsWorker
...