使用后台任务检查器调试您的 WorkManager worker

后台任务检查器可帮助您在使用 WorkManager 库 2.5.0 或更高版本时,直观显示、监控和调试应用的后台 worker。

开始

要在后台任务检查器中列出 worker,请执行以下操作:

  1. 在运行 API 级别 26 或更高版本的模拟器或已连接设备上运行您的应用

  2. 从菜单栏中选择视图 > 工具窗口 > 应用检查

  3. 选择后台任务检查器标签页。

  4. 从菜单中选择正在运行的应用进程。

  5. 当前运行应用中的 worker 会显示在后台任务检查器面板中。点击您要进一步检查的 worker。

查看和检查 worker

当您将使用 WorkManager 2.5.0 或更高版本的应用部署到运行 API 级别 26 或更高版本的设备上时,后台任务检查器标签页会显示活跃的 worker。后台任务检查器(在后续部分中显示为图 3)会列出所有作业的类名、当前状态、开始时间和重试次数,无论这些作业是正在运行、失败还是已完成。

工作详情

点击列表中的某个作业可打开工作详情面板,其中显示了关于 worker 的详细信息,如图 1 所示。

Screenshot of the selected Worker's details.
图 1. 工作详情面板。
  • 说明:本部分列出了 worker 的类名(包含完全限定包)、分配的标签以及 worker 的 UUID。
  • 执行:本部分显示了 worker 的约束条件(如果有)、运行频率和状态,以及创建并排队 worker 的类。
  • WorkContinuation:本部分显示 worker 在工作链中的位置。如需查看工作链中另一个 worker 的详细信息,请点击其 UUID。
  • 结果:本部分显示了所选 worker 的开始时间、重试次数和输出数据。

取消 worker

要停止当前正在运行或已排队的 worker,请选择该 worker,然后点击工具栏中的取消选中的 Worker

查看图表视图

由于 worker 可以相互链接,因此有时将 worker 依赖项可视化为图表会很有用。

要查看 worker 链的图形表示,请从表格中选择一个 worker,然后点击工具栏中的显示图表视图 。图中只绘制 worker。

Screenshot of the Graph view.
图 2. 图表视图。

该图表可让您快速查看 worker 之间的关系,并监控它们在复杂链接关系中的进度。

要返回列表视图,请点击显示列表视图

查看和检查 Job、Alarm 和 Wakelock

后台任务检查器还允许您检查应用的 Job、Alarm 和 Wakelock。每种异步任务类型都显示在检查器标签页中的相应标题下,让您可以轻松监控其状态和进度。

与 worker 类似,您可以选择 Job、Alarm 或 Wakelock,以在任务详情面板中检查其详细信息。

要查看 Worker、Job、Alarm 或 Wakelock 的详细信息,请在右侧的任务详情面板中选择它。

Screenshot of the Background Task Inspector window.
图 3. 后台任务检查器窗口。

更多资源

要详细了解后台任务检查器,请参阅以下其他资源:

文档

Codelab

博文