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

当您使用 WorkManager 库 2.5.0 或更高版本时,后台任务检查器 (Background Task Inspector) 可帮助您可视化、监控和调试应用的后台工作器。

开始使用

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

  1. 在模拟器或连接的设备上运行您的应用(需运行 API 26 或更高级别)。

  2. 从菜单栏中选择 View > Tool Windows > App Inspection

  3. 选择 Background Task Inspector 标签页。

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

  5. 当前运行的应用中的工作器会显示在 Background Task Inspector 窗格中。点击您想要深入检查的工作器。

查看和检查工作器

当您在运行 API 26 或更高级别的设备上部署使用 WorkManager 2.5.0 或更高版本的应用时,Background Task Inspector 标签页会显示活动的工作器。Background Task Inspector(在后续部分的图 3 中展示)列出了所有作业的类名、当前状态、开始时间和重试次数,无论它们是正在运行、失败还是已完成。

工作详情

点击列表中的作业以打开 Work Details(工作详情)面板,该面板会显示有关工作器的详细信息,如图 1 所示。

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

取消工作器

要停止当前正在运行或已加入队列的工作器,请选中该工作器并点击工具栏中的 Cancel Selected Worker

查看图形视图

由于工作器可以串联在一起,有时将工作器依赖关系可视化为图形会很有用。

要查看工作器链的视觉表现,请从表中选择一个工作器,然后点击工具栏中的 Show Graph View 。只有工作器会绘制在图形中。

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

该图形让您可以快速查看工作器之间的关系,并监控它们在复杂链式关系中的进度。

要返回列表视图,请点击 Show List View

查看和检查作业、闹钟和唤醒锁

后台任务检查器还允许您检查应用的作业 (Jobs)、闹钟 (Alarms) 和唤醒锁 (Wakelocks)。每种类型的异步任务都会显示在检查器标签页的相应标题下,方便您监控其状态和进度。

与工作器类似,您可以选择一个作业、闹钟或唤醒锁,在“任务详情”面板中检查其详细信息。

要查看工作器、作业、闹钟或唤醒锁的详细信息,请在右侧的 Task Details(任务详情)面板中将其选中。

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

其他资源

要了解有关后台任务检查器的更多信息,请参阅以下其他资源:

文档

Codelabs

博文