使用 WorkManager 处理须要马上执行的后台任务

时间 2021-04-03

标签 java android git github app 异步 async ide 函数优化栏目 Java 繁體版

原文原文链接

当须要执行长时间运行的任务，而应用处于后台状态时，您会遇到后台执行限制，该特性是在 Android 8.0 以后增长的。咱们鼓励开发者进行行为变动以提高整个平台的用户体验。java

为了避免同的使用场景更易于适配，咱们经过对 WorkManager 添加功能，提高了开发者在遵循后台任务限制方面的体验。android

咱们推荐使用 WorkManager 处理需当即执行的长时间运行任务。git

阅读本文，了解经过 WorkManager 处理的需长时间运行而且当即执行的任务的好处以及如何进行配置。github

API 介绍

自 WorkManager 版本 2.3.0 起，每一个 Worker 均可以在前台服务中调用方法。ListenableWorker 做为 Worker 的基类，提供了新的 setForegroundAsync() 函数。app

本文以 CoroutineWorker 为例。在 CoroutineWorker 中，setForegroundAsync() 被封装在一个挂起的 setForeground() 函数中。该类也提供挂起的 doWork 函数，它支持代码脱离主线程运行。可是，本文的所有内容一样适用于其余 Worker 类的相关函数。异步

当调用 setForeground(Async) 时，一旦知足约束条件，预约的任务将会在前台服务中当即执行。此外，WorkManager 会负责处理服务的生命周期。而在前台服务的 Worker 中运行的任务也不会受到后台任务十分钟的限制。async

从当即执行开始

让咱们来看一下如何让一个已存在的 worker 在前台服务中执行任务。ide

咱们从一个很是简单的 doWork() 函数开始。代码是异步执行的，不管成功或失败，都会有相应的 Result 返回。函数

/* Copyright 2020 Google LLC.
   SPDX-License-Identifier: Apache-2.0 */

override suspend fun doWork(): Result {
    try {
       //要执行的代码
        return Result.success()
    } catch (throwable: Throwable) {
       //进行清理并输出
        return Result.failure()
    }
}

在 doWork() 中，您也须要告知 WorkManager 该任务应该在前台服务中当即执行。优化

为此，您须要建立一个 ForegroundInfo 对象做为 setForeground() 的参数。ForegroundInfo 须要两个参数，一个是 Notification ID，另外一个是将要被显示的 Notification。

当约束条件知足时，下列信息可用于建立和运行前台服务。

建立 ForegroundInfo

正确建立 ForegroundInfo 只需以下三步:

建立一个 Notification
建立一个 Notification Channel
将通知引入 ForegroundInfo

在下列代码中，createForegroundInfo() 调用 createForegroundInfo()，createNotification() 函数会对 notification 进行填充并建立相应的 channel。

/* Copyright 2020 Google LLC.  
   SPDX-License-Identifier: Apache-2.0 */

/**
  *为前台服务运行的 Worker 建立 ForegroundInfo 
  */
private fun createForegroundInfo(): ForegroundInfo {
    //每个 Notification 须要使用不一样的 id
    val notificationId = 1
    return ForegroundInfo(notificationId, createNotification())
}


/**
  * 为前台服务运行任务建立 Notification 和所需的 channel (Andrid O版本以上)
  */
private fun createNotification(): Notification {
    //PendingIntent 可用来取消 Worker
    val intent = WorkManager.getInstance(context).createCancelPendingIntent(id)

    val builder = Builder(context, channelId)
        .setContentTitle(title)
        .setTicker(title)
        .setSmallIcon(R.drawable.baseline_gradient)
        .setOngoing(true)
        .addAction(drawable.ic_delete, cancel, intent)
    if (VERSION.SDK_INT >= VERSION_CODES.O) {
        createNotificationChannel(channelId, name).also {
            builder.setChannelId(it.id)
        }
    }
    return builder.build()
}

/**
  * 为 Android O 及以上版本的设备建立所需的 notification channel
 */
@TargetApi(VERSION_CODES.O)
private fun createNotificationChannel(
    channelId: String,
    name: String
): NotificationChannel {
    return NotificationChannel(
        channelId, name, NotificationManager.IMPORTANCE_LOW
    ).also { channel ->
        notificationManager.createNotificationChannel(channel)
    }
}

在前台服务中执行任务

如今把这些整合起来。咱们已经实现了 doWork 函数，咱们能够调用 setForeground()，而且经过调用 createForegroundInfo() 来传递所需的信息。

/* Copyright 2020 Google LLC.
   SPDX-License-Identifier: Apache-2.0 */

override suspend fun doWork(): Result {
    try {
        setForeground(createForegroundInfo())
        //须要执行的代码
        return Result.success(workDataOf(KEY_RESULT to result))
    } catch (throwable: Throwable) {
        //进行清理而且输出日志
        return Result.failure()
    }
}

⚠️⚠️⚠️

在长时间运行任务开始以前，先调用 setForeground()。

不然在 setForeground() 被调用以前，您的 Worker 将会被视为非前台服务，这样可能会致使这个任务被取消或引发其他不但愿出现的结果。

⚠️⚠️⚠️

下一步

如今你们已经知道什么时候以及如何利用长时间运行的 worker 了，那么能够进行下一步，开始在应用中实现它们。获取更多相关信息，请参阅如下资源:

在 GitHub 中查看 WorkManager 示例代码:

在前台服务中执行任务的代码，请查阅:

关于长时间运行 worker 和前台服务的详细指南，以及主题更多信息，请查阅:

WorkManager 系列文章助您了解 WorkManager 从基础到高级的各项特性:

Google IssueTracker 提交所遇到的任何问题，这将帮助咱们第一时间优化特性和修复漏洞。