读书笔记：WorkManager的使用

本笔记来自第一行代码第三版第13章，作者郭霖，各大平台均可购买。

前言

WorkManger为了解决开发者需要在后台执行一些耗时性或周期性的独立的任务。WorkManger不属于Android的四大组件，是独立的任务，在应用退出时，仍然可能会执行。

WorkManager具有以下特点：
1、周期任务不一定会准时执行，可能受到系统其它策略的影响（省电等等）；
2、兼容性好，会根据系统版本自动选择使用AlarmManager或是JobScheduler；
2、国内厂商可能会删除此功能，无法使用WorkManager；

正文

基本用法

首先需要在gradl文件中添加依赖：

dependencies {
	......
    implementation 'androidx.work:work-runtime:2.3.4'
}

创建一个后台任务，继承Worker：

class SimpleWorker(context: Context, workerParams: WorkerParameters) :
    Worker(context, workerParams) {
    override fun doWork(): Result {
        Log.d("SimpleWorker", "doWork")
        return Result.success()
    }
}

自定义Worker，需要注意一下问题：

1. SimpleWorker不可以直接实例化，后续内容会介绍；
2. 重写doWork方法可以执行耗时任务，不必再创建新的线程；
3. doWork执行完毕，需要返回此次执行任务的结果， Result.success()/ Result.failure()/ Result.retry()，方便监听任务的执行状态。

实例化自定义Worker：

// 执行一次的任务
val request = OneTimeWorkRequest.Builder(SimpleWorker::class.java).build()
// 周期任务，循环周期不可小于15分钟
val request2 = PeriodicWorkRequest.Builder(SimpleWorker::class.java, 15, TimeUnit.MINUTES).build()

执行Worker：

WorkManager.getInstance(this).enqueue(request)

高级用法

上面介绍的是WorkManager的基本用法，为了丰富WorkManager的应用场景，它还有很多的个性设置，下面介绍常用的几种：

1、设置请求的首次延迟时间

val request = OneTimeWorkRequest.Builder(SimpleWorker::class.java)
                .setInitialDelay(3, TimeUnit.MINUTES) // 设置任务延迟3分钟开始执行
                .build()

2、设置请求的标签

val request = OneTimeWorkRequest.Builder(SimpleWorker::class.java)
                .addTag("Simple")  // 为任务添加标记位，方便统一取消
                .build()

3、设置请求的失败的重试策略

val request = OneTimeWorkRequest.Builder(SimpleWorker::class.java)
                .setBackoffCriteria(BackoffPolicy.LINEAR, 1, TimeUnit.MINUTES) // 表示任务失败后，会以延迟的方式执行
                .build()

如果任务失败了，适当的延迟任务的下次执行时间，有助于节省手机消耗。
BackoffPolicy.LINEAR：线性的方式延迟；
BackoffPolicy.EXPONENTIAL：指数的方式延迟
该设置需要dowWork返回Result.retry()。

4、监听任务的执行状态

// 监听任务的执行状态
WorkManager.getInstance(this).getWorkInfoByIdLiveData(request.id)
       .observe(this, Observer {
              when (it.state) {
                   WorkInfo.State.SUCCEEDED -> {}
                   WorkInfo.State.FAILED -> {}
                   else -> {}
              }
       })

5、创建链式任务

需要三个任务顺序执行：A - B - C，如果中间的某个任务失败了，剩下的任务不会得到执行。

 // 创建链式任务, 如果在前面的人任务失败，之后的任务不会得到在执行
 WorkManager.getInstance(this)
         .beginWith(request)
         .then(request)
         .then(request).enqueue()

beginWith： 开始的任务；
then：接下来的任务；

6、执行唯一任务

WorkManager.getInstance(this).enqueueUniqueWork("test1", ExistingWorkPolicy.APPEND, request)

第一个参数为任务的名称；
第二个参数为任务执行的策略（ExistingWorkPolicy枚举类）：替换，保持，添加
第三个参数为创建的任务

6、取消任务

// 取消任务的方式
WorkManager.getInstance(this).cancelAllWork()
WorkManager.getInstance(this).cancelAllWorkByTag("Simple")
WorkManager.getInstance(this).cancelWorkById(request.id)
WorkManager.getInstance(this).enqueueUniqueWork("test1", ExistingWorkPolicy.APPEND, request)
WorkManager.getInstance(this).cancelUniqueWork("test1")

总结

WorkManager适合做一些业务无关的功能，例如同步数据等等，即使无法得到执行也不会对app的使用有影响，加上国内厂商定制，暂时还是保留起来吧。