探索Jetpack:使用WorkManager调度任务

原文地址：https://android.jlelse.eu/exploring-jetpack-scheduling-tasks-with-work-manager-fba20d7c69bf

18年I/O大会，google发布了 Android Jetpack.它是一些列的库，工具和架构指南，可以帮助你轻松快速的构建以优秀的App。在Android Jetpack中，Google团队中发布了一个专门用于调度和管理后台任务的库，它被称为WorkManager。

在这部分中，你将了解调度程序的演变，什么是工作管理器，如何使用它以及何时使用。在西一部分，你将了解如何连接所有的任务并且有序的执行。

你可能会说，我们在Android操作系统内部安排了Job Scheduler API来调度任务。我们还有GCM网络管理员，Firebase Job Dispatcher，Evernote的Android Job以及许多其他库，可以调度后台任务。为什么我们需要另一个新库来调度任务？

为了回答这个任务，我相处了后台任务调度器进化矩阵，将此视为时间便的四大支柱

image.png

让我们一个一个开始讨论:
1. 易于调度

• 后台工作程序只能在特定条件下调度任务(例如只有设备处于充电状态，该任务才会运行)
• 一旦你调度了任务，就可以忘记任务的存在，调度程序应该提供在所需条件匹配的情况下保证任务运行。
• 每个任务可以与另外一个任务并行链接，以并行或顺序运行多个任务。

易于取消

• 你必须拥有对任务的控制权，调度程序应该提供API以轻松取消计划任务。

易于查询

• 你的应用程序可能会需要显示任务的状态。
• 假设你要上传照片并且需要在界面上显示上传的百分比。
• 调度程序必须提供API以轻松获取任务的当前状态，如果任务完成之后可以传递一些结果数据，那就更棒了！

支持所有的Android版本

• 调度程序API应该在所有的Android版本中都一样。

让我们根据上面的标准来评估WorkManager。

WorkManager API的不同之处

根据官方文档
1. 易于调度

• WorkManager API可以轻松创建可延迟的异步任务，并允许您指定应该何时执行。
• 你可以创建任务并将该任务交给WorkManager，以便立即或在设备处于特定条件下运行该任务。
• WorkManager提供了保证，即使您的应用程序强制退出或设备重新启动，你的任务仍会在特定条件匹配时执行。

2. 易于取消
WorkManager给每个任务分配了UUID，使用这个唯一的ID你就可以随时取消任务。

3.易于查询

• 你可以使用分配给每个任务的唯一标识来询问任务的状态，无论是正在运行，挂起还是已完成。
• WorkManager API超越了任务的当前状态，允许任务一键值对格式返回数据。
• WorkManager使用LiveData来干会任务的数据和状态，所以，你的Activity可以观察这个LiveData，并且每当任务完成时都会得到通知。

4.支持Android所有版本

• WorkManager支持Android API 14及以上
• WorkManager根据设备API级别和应用程序状态等因素选择适当的方式来运行你的任务。
• 如果应用程序正在运行，WorkManager将创建新的线程来运行任务。
• 如果应用程序没有运行，那么他将使用JobScheduler API或Firebase Job APIs调度者或Alarm manager API运行调度任务。

image.png

类和概念

Work manager APIs建立在几个类上，你必须继承一些抽象类来安排任务。

• Worker：在WorkManager世界中，Worker等同于需要在后台执行的任务或作业。这是一个抽象类。你需要继承它。您的Worker类包含有关如何执行该任务的信息，但它没有关于何时运行的信息。
• WorkRequest：它代表了工作调度请求。每个工作必须在安排工作之前创建工作请求。 WorkRequest将包含工作的唯一标识，约束条件说明应在哪种情况下执行任务。这是一个抽象类。该库提供了这个类的两个直接子类：OneTimeWorkRequest和PeriodicWorkRequest。
• WorkManager：它是基于WorkRequest中定义的约束来管理和调度任务的类。
• WorkStatus：这个类包装了任何work请求的状态，你可以通过唯一的id来查询任何work的状态。

工作流程

让我们了解如何创建和安排新的work

1.创建work：

• 创建一个Worker的子类，这个类有一个抽象方法doWork()，顾名思义，你需要在后台执行你想要做的工作，该方法将在后台/工作线程中调用，编写以执行此方法中的任务。
• 在返回中，你必须返回WorkerResult。返回WorkerResult.SUCCESS表明您执行的任务已成功完成。返回WorkerResult.RETRY告诉WorkManager再次重试该工作。返回WorkerResult.FAILURE表示发生了一个或多个错误。

class DownloadWorker : Worker() {

    // Define the parameter keys:
    private val KEY_X_ARG = "X"
    private val KEY_Y_ARG = "Y"
    private val KEY_Z_ARG = "Z"

    // The result key:
    private val KEY_RESULT = "result"

    /**
     * This will be called whenever work manager run the work.
     */
    override fun doWork(): WorkerResult {
        // Fetch the arguments (and specify default values):
        val x = inputData.getLong(KEY_X_ARG, 0)
        val y = inputData.getLong(KEY_Y_ARG, 0)
        val z = inputData.getLong(KEY_Z_ARG, 0)

        val timeToSleep = x  + y + z
        Thread.sleep(timeToSleep)

        //...set the output, and we're done!
        val output = Data.Builder()
                .putInt(KEY_RESULT, timeToSleep.toInt())
                .build()

        outputData = output
        // Indicate success or failure with your return value.
        return WorkerResult.SUCCESS
    }
}

2.定义约束：

• 定义约束条件以告诉WorkManager合适安排任务执行，如果没有提供任何约束条件，那么该任务将立即运行。
• 以下是仅在设备充电和限制时才运行任务的约束。

val myConstraints = Constraints.Builder()
        .setRequiresDeviceIdle(true)
        .setRequiresCharging(true)
        .build()

3.创建work request

• 你可以创建OneTimeWorkRequest来运行一次任务。

val request = OneTimeWorkRequest.Builder(DownloadWorker::class.java)
     .setConstraints(myConstraints)
     .build()

• 如果你想定期运行一个任务，那么创建一个PeriodicWorkRequest并设置工作的时间间隔。

val request = PeriodicWorkRequest
         .Builder(DownloadWorker::class.java, 1, TimeUnit.HOURS)
         .setConstraints(myConstraints)
         .build()

4.执行请求

WorkManager.getInstance().enqueue(request)

image.png

输入参数和返回值：

设置输入参数

• 在创建工作请求时，可以将输入参数的androidx.work.Data传递给工作(可以将数据映像为Bundle类型，它将数据保存在键值对中。)
• 使用必须的键值对创建新的Data，然后通过调用setInputData创建工作请求时设置数据。

val myData = Data.Builder()
        .putLong(KEY_X_ARG, 42)
        .putLong(KEY_Y_ARG, 421)
        .putLong(KEY_Z_ARG, 8675309)
        .build()
val request = OneTimeWorkRequest.Builder(DownloadWorker::class.java)
        .setInputData(myData)
        .build()

你可以通过调用getInputData来读取所有这些输入参数，执行完任务后，可以调用setOutputData为该worker设置输出数据。

class DownloadWorker : Worker() {

    // Define the parameter keys:
    private val KEY_X_ARG = "X"
    private val KEY_Y_ARG = "Y"
    private val KEY_Z_ARG = "Z"

    // The result key:
    private val KEY_RESULT = "result"

    /**
     * This will be called whenever work manager run the work.
     */
    override fun doWork(): WorkerResult {
        // Fetch the arguments (and specify default values):
        val x = inputData.getLong(KEY_X_ARG, 0)
        val y = inputData.getLong(KEY_Y_ARG, 0)
        val z = inputData.getLong(KEY_Z_ARG, 0)

        val timeToSleep = x  + y + z
        Thread.sleep(timeToSleep)

        //...set the output, and we're done!
        val output = Data.Builder()
                .putInt(KEY_RESULT, timeToSleep.toInt())
                .build()

        outputData = output
        // Indicate success or failure with your return value.
        return WorkerResult.SUCCESS
    }
}

观察输出数据

• Work manager为所有工作请求管理工作状态和LiveData，应用程序可以观察到LiveData在工作状态发生变化时得到通知。
• 你也可以通过调用getOutputData()来读取输出数据。

什么时候使用work manager？

你可能会觉得work manager APIs使用起来如此简单，如果我们使用它来运行我的所有后台任务，该怎么办？请学习下一篇。