Jetpack——WorkManager

背景

公司自己写的数据分析，额…希望每半小时上报一次。之前是用的Service，但在Android文档关于内存优化部分提到使用完Service后要将其停止，像这种周期性任务功能上来说是肯定不能停的。而Jetpack刚刚好提供了后台任务WorkManager，试着用它实现下。

WorkManager 简介

先看它的使用场景

• 向后端服务发送日志或分析数据
• 定期将应用数据与服务器同步

这个的使用场景与我的需求完全契合。

WorkManager使用

1. 添加依赖

   def work_version = "2.3.1"
   implementation "androidx.work:work-runtime-ktx:$work_version"
   

   提示：可能会报以下错误

   Cannot inline bytecode built with JVM target 1.8 into bytecode that is being built with JVM target
   

   需要在gradle中加入下面代码：

   android{
   	compileOptions {
           sourceCompatibility = '1.8'
           targetCompatibility = '1.8'
       }
       kotlinOptions {
           jvmTarget = "1.8"
       }
   }
   

2. 编写后台功能
   要使用WorkerManager管理后台任务需要继承 Worker 并在 doWork() 中编写我们自己的后台处理逻辑：

   class ReportWorker(val context: Context, workerParams: WorkerParameters) : Worker(context, workerParams) {
       override fun doWork(): Result {
   		// TODO 后台逻辑
           return Result.success()
       }
   }
   

   在后台逻辑中我们可以编写自己要执行的代码，并可以根据实际情况返回Result.success() 或 Result.failure()
3. 启动Worker

   // 一次性任务
   // val reportRequest = OneTimeWorkRequestBuilder<ReportWorker>().build()
   // 周期性任务
   val reportRequest = PeriodicWorkRequestBuilder<ReportWorker>(30, TimeUnit.MINUTES).build()
   WorkManager.getInstance().enqueue(reportRequest)
   

   启动Worker非常简单，只需要创建一个Worker，把它加入到WorkManager的执行队列中就可以了。

WorkManager高级用法

1. 添加Worker的约束条件
   有时我们的后台任务需要连接网络下执行，尽管我们在doWork()可以进行判断，但WorkerManager为我们提供了更便捷的方式：通过在创建Worker时添加 Constraints 来为后台任务添加执行时的约束条件。

   val constraints = Constraints.Builder()
                   .setRequiresCharging(true)
                   .setRequiredNetworkType(NetworkType.CONNECTED)
                   .build()
   val reportRequest = PeriodicWorkRequestBuilder<ReportWorker>(30, TimeUnit.MINUTES)
                     .setConstraints(constraints)
                     .build()
   WorkManager.getInstance().enqueue(reportRequest)
   

   Constraints为我们提供了很多约束条件，例如：网络状态、电量是否充足、存储空间是否充足等

2. Worker 取消
   Worker的取消非常简单，可以直接使用 WorkManager.cancelWorkById(UUID) 来实现，而在我们创建Worker时每个Worker都会有一个UUID。
   如果我们为Woker设置了tag，也可以通过 WorkManager.cancelAllWorkByTag(String) 来取消Worker

3. 唯一任务
   Worker如果不手动取消那么它并不会随应用的退出而自动终止，这样当我们再次进入App执行到创建Worker的代码时就会再次创建一个Worker。这种情况对于OneTimeWorkRequest是没有什么影响的，但对于PeriodicWorkRequest 会出现越来越多的Worker在WorkerManager中执行。本来半小时执行一次的任务可能因此执行了多次。当然我们可以在创建Worker前cancel掉上一个Worker，但这样就不能保证切换过程中的执行周期。为解决这个问题，我们需要使用enqueueUniqueWork来向WorkerManger中添加我们的Worker

   WorkManager.getInstance().enqueueUniquePeriodicWork("uniqueWorkName", ExistingPeriodicWorkPolicy.KEEP,reportRequest)
   

   其中：
   "uniqueWorkName" 为唯一名称，该名称是后面添加策略的判断标准，注意它与tag意义不同；
   KEEP 表示保持原有的Worker，忽略新创建的；除了KEEP，还可以使用 REPLACE 表示使用新的替换旧的。