主要处理非及时性任务和定时的周期性任务,特点是保证任务一定执行但不一定立即执行,可以在应用退出后继续执行,用于替换部分前台服务的场景
导入依赖
implementation "androidx.work:work-runtime-ktx:2.8.0"
继承Worker实现执行任务doWork()
执行的任务从inputData中获取外部传参
内部数据通过Data数据结构传出(10KB内),结果分为Success(成功)、failure(失败)、retry(重试),重试根据重试策略进行
class MyWork(context: Context, workerParams: WorkerParameters) : Worker(context, workerParams) {
override fun doWork(): Result {
//TODO("Not yet implemented")
//Result.failure() Result.retry()
inputData.getString("p1")//获取外部传入的数据
Thread.sleep(8000)
return Result.success(Data.Builder().putString("result","value").build())//返回并携带参数
}
}
给work构建request
//添加约束
val constraints= Constraints.Builder()
.setRequiredNetworkType(NetworkType.CONNECTED)//联网状态
.setRequiresBatteryNotLow(true)//电量充足
.setRequiresCharging(false)//是否充电时运行
.setRequiresDeviceIdle(false)//是否在空闲时运行
.setRequiresStorageNotLow(false)//是否有充足的存储空间
.build()
//封装任务work到request中
//单一的request
val request= OneTimeWorkRequestBuilder<MyWork>()
.setConstraints(constraints)
.setBackoffCriteria(BackoffPolicy.EXPONENTIAL,1,TimeUnit.DAYS)//设定重试策略的时间增长方式 指数增加或线性增加
.setInputData(Data.Builder().putString("p1","value").build())//设定入参
.build()
监听任务状态
WorkManager.getInstance(this).getWorkInfoByIdLiveData(request.id).observe(this,Observer<WorkInfo>{
it.toString()//监听任务状态
if(it!=null&&it.state==WorkInfo.State.SUCCEEDED){
val out=it.outputData.getString("result")//获取内部传出的数据
}
})
执行任务
WorkManager.getInstance(this).enqueue(request)
也可对任务指定名称,相同名称的指定替换策略
WorkManager.getInstance(this).enqueue(request)
WorkManager.getInstance(this).enqueueUniqueWork("name",ExistingWorkPolicy.REPLACE,request)//通过指定 替换之前的任务
WorkManager.getInstance(this).enqueueUniqueWork("name",ExistingWorkPolicy.KEEP,request)//通过指定名称 使用之前指定的任务
WorkManager.getInstance(this).enqueueUniqueWork("name",ExistingWorkPolicy.APPEND,request)//通过指定名称 追加在之前的任务后 失败情况下状态共有
WorkManager.getInstance(this).enqueueUniqueWork("name",ExistingWorkPolicy.APPEND_OR_REPLACE,request)//通过指定名称 追加在之前的任务后 失败情况下状态分离
定时任务
val periodicWorkRequest=PeriodicWorkRequest.Builder(MyWork::class.java,1,TimeUnit.DAYS)
.setConstraints(constraints)
.build()
val op=WorkManager.getInstance(this).enqueue(periodicWorkRequest)
组合任务
WorkManager.getInstance(this).beginWith(request).then(request).enqueue()//指定先后顺序
链式组合任务
val continuation1= WorkManager.getInstance(this).beginWith(request).then(request)
val continuation2= WorkManager.getInstance(this).beginWith(request).then(request)
val taskList=ArrayList<WorkContinuation>()
taskList.add(continuation1)
taskList.add(continuation2)
WorkContinuation.combine(taskList).then(request).enqueue()//执行完task中的任务再执行指定request