WorkManager

686 阅读2分钟
WorkManager作用
  • 后台执行任务的需求是十分常见的,Android也提供了多种解决方案,如JobScheduler,Loader,Server等,如果这些API没有被恰当使用,则可能会消耗大量电量。Android在解决应用程序耗电问题上各种尝试,从Doze到APP Standby,通过各种方式限制和管理应用程序,以保证应用不会再后台消耗过多的设备电量。Workmanager为应用程序中那些不需要及时完成的任务提供了一个统一的解决方案,以便在设备电量和用户体验之间达到一个比较好的平衡。
WorkManager的兼容方案
  • WorkManager能根据设备的情况,选择不同的执行方案。在API Level 23以上设备中,通过JobScheduler完成任务,在API Level 23以下的设备中,通过ALarmManager和Broadcast Receivers组合来完成任务。但无论采用哪种方案,任务最重由Executor来执行
  • 另外,WorkManager不是一种新的工作线程,它的出现不是为了替代其他类型的工作线程,工作线程通常立即运行,并在任务执行完成后给用户反馈。而WorkManager不是即时的,它不能保证任务立即执行
WorkManager的使用方法
  1. 添加依赖
  2. 使用Work类定义任务
  3. 使用WorkRequest配置任务
  • 设置任务触发条件
  • 将任务触发条件设置到WorkRequest
  • 设置延迟执行任务
  • 设置指数退避策略
  • 为任务设置Tag标签
WorkManager的使用方法
  1. 将任务交给系统
  2. 观察任务的状态
  3. 取消任务
  4. 参数传递
  5. 周期性任务
  6. 任务链
class MyWorker(context: Context, workerParams: WorkerParameters) : Worker(context, workerParams) {

    override fun doWork(): Result {
        val inputData = inputData.getString("data")
        SystemClock.sleep(2000)
        Log.e("lyb=======", "MyWorker doWork $inputData")
        //任务执行完返回数据
        val putString = Data.Builder().putString("outputData", "执行成功").build()
        return Result.success(putString)
    }
}
fun mAddWork(view : View){
        // 设置触发条件
        val constraints = Constraints.Builder()
            // NetworkType.NOT_REQUIRED 对网络没有要求
            // NetworkType.CONNECTED 网络连接的时候执行
            // NetworkType.UNMETERED 不计费的网络比如WIFI下执行
            //NetworkType.NOT_ROAMING 非漫游网络状态
            //NetworkType.METERED 计费网络比如 3G 4G 不执行
//            .setRequiresBatteryNotLow(true) //不在电量不足执行
//            .setRequiresCharging(true) // 在充电时执行
//            .setRequiresStorageNotLow(true) //不在存储容量不足时执行
//            .setRequiresDeviceIdle(true) //在待机状态下执行 调用需要API级别最低为23
            .setRequiredNetworkType(NetworkType.NOT_REQUIRED)
            .build()

        val inputData = Data.Builder()
            .putString("data","workRequest")
            .build()

        val workRequest = OneTimeWorkRequest.Builder(MyWorker::class.java)
            .setConstraints(constraints)
            //设置延迟执行
            .setInitialDelay(5,TimeUnit.SECONDS)
            //指数退避策略
//            .setBackoffCriteria(BackoffPolicy.LINEAR, Duration.ofSeconds(2L))
            //设置Tag标签
            .addTag("workRequest")
                //传递参数
            .setInputData(inputData)
            .build()

        //周期性任务
//        val workRequest1 = PeriodicWorkRequest.
 // Builder(MyWorker::class.java, Duration.ofMillis(15)).build()

//任务链
//val workA = OneTimeWorkRequest.Builder(MyWorker::class.java).build()
//val workB = OneTimeWorkRequest.Builder(MyWorker::class.java).build()
//WorkManager.getInstance(this)
//    .beginWith(workA)
//    .then(workB)
//    .enqueue()

//任务链组合
//val workA = OneTimeWorkRequest.Builder(MyWorker::class.java).build()
//val workB = OneTimeWorkRequest.Builder(MyWorker::class.java).build()
//val workC = OneTimeWorkRequest.Builder(MyWorker::class.java).build()
//val workD = OneTimeWorkRequest.Builder(MyWorker::class.java).build()
//val workE = OneTimeWorkRequest.Builder(MyWorker::class.java).build()
//val continuation1 = WorkManager.getInstance(this)
//    .beginWith(workA).then(workB)
//val continuation2 = WorkManager.getInstance(this)
//    .beginWith(workC).then(workD)
//WorkContinuation.combine(listOf(continuation1,continuation2)).then(workE).enqueue()

        val workManager = WorkManager.getInstance(this)
        workManager.enqueue(workRequest)

        // 监听任务状态
        workManager.getWorkInfoByIdLiveData(workRequest.id).observe(this){
            Log.e("lyb=====",it.toString())
            if(it.state == WorkInfo.State.SUCCEEDED){
                val output = it.outputData.getString("outputData")
            }
        }

        //取消任务
//        workManager.cancelWorkById(workRequest.id)

    }