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

在 Android Studio Arctic Fox 及更高版本中,在使用 WorkManager 库 2.5.0 或更高版本时,后台任务检查器有助于您直观呈现、监控和调试应用的后台工作器。

开始使用

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

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

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

  3. 选择 Background Task Inspector 标签页。

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

  5. 当前正在运行的应用中的工作器会显示在 Background Task Inspector 窗格中。点击要进一步检查的工作器。

查看和检查工作器

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

Work Details

点击列表中的某项作业,即可打开 Work Details 面板,其中显示了相应工作器的详情。

所选工作器详情的屏幕截图。
图 1. Work Details。
  • Description:此部分列出了包含完全限定软件包的工作器类名,以及此工作器的已分配标记和 UUID。
  • Execution:此部分显示了工作器的约束条件(若有)、运行频率、状态,以及哪个类创建了此工作器并将其加入队列。
  • WorkContuniation:此部分显示了此工作器在工作链中所处的位置。如需查看工作链中另一个工作器的详情,请点击其 UUID。
  • Results:此部分显示了所选工作器的开始时间、重试次数和输出数据。

取消工作器

如需停止当前正在运行的工作器或已加入队列的工作器,请选择相应工作器,然后点击工具栏中的 Cancel Selected Worker 图标

查看图表视图

由于工作器可以链接在一起,因此,以图表形式直观呈现工作器的依赖关系有时会非常有用。如需查看工作器链的直观呈现效果,请从表中选择一个工作器,然后点击工具栏中的 Show Graph View 图标 。图表中只绘制了工作器。

图表视图的屏幕截图。
图 2. 图表视图。

通过该图表,您可以快速查看工作器之间的关系,还可以监控其在复杂链接关系中的进度。

如需返回列表视图,请点击 Show List View 图标

查看和检查作业、警报和唤醒锁

借助后台任务检查器,您还可以检查应用的作业、警报和唤醒锁。现在,每种类型的异步任务都会显示在检查器标签页的相应标题下,便于您轻松监控其状态和进度。与工作器类似,您可以在“Task Details”面板中选择相应作业、警报或唤醒锁,以检查其详细信息。

您可以在右侧的 Task Details 面板中选择相应工作器、作业、警报或唤醒锁,查看其详细信息。

“后台任务检查器”窗口的屏幕截图。
图 3. “后台任务检查器”窗口。

其他资源

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

文档

Codelab

博文