1.添加依赖
implementation(libs.androidx.work.runtime.ktx)
toml
[versions]
workKtx = "2.9.0"
[libraries]
# WorkManager
androidx-work-runtime-ktx = { group = "androidx.work", name = "work-runtime-ktx", version.ref = "workKtx" }
2.新建后台任务,每一个后台任务都需要继承 Worker:
/**
* 后台任务
*/
class FirstWorker(context: Context, params: WorkerParameters) : Worker(context, params) {
override fun doWork(): Result {
Log.d("MainActivity", "doWork: 任务已执行")
return Result.success()
}
}
3.定时任务
// 创建方式一
// val request = OneTimeWorkRequest.Builder(FirstWorker::class.java).build()
// 创建方式二
val request = OneTimeWorkRequestBuilder<FirstWorker>().build()
4.将后台加入WorkManager,后台任务便会执行,但不会立即执行,而是系统找到合适的时机执行
// 加入任务队列
WorkManager.getInstance(this).enqueue(request)
5.延时执行
// 单次任务
val request = OneTimeWorkRequestBuilder<FirstWorker>()
.setInitialDelay(1, TimeUnit.MINUTES)
.build()
6.添加 Tag
添加 Tag 的作用是方便取消任务。
// 单次任务
// val request = OneTimeWorkRequest.Builder(FirstWorker::class.java).build()
val request = OneTimeWorkRequestBuilder<FirstWorker>()
.addTag("one")
.build()
7.重新执行失败的任务
如果任务执行失败,还可以重新执行。
首先需要将任务执行结果返回为 retry
。
/**
* 后台任务
*/
class FirstWorker(context: Context, params: WorkerParameters) : Worker(context, params) {
override fun doWork(): Result {
Log.d("MainActivity", "doWork: 任务已执行")
return Result.retry()
}
}
然后通过 setBackoffCriteria
方法设置重新执行时间。
// 单次任务
val request = OneTimeWorkRequestBuilder<FirstWorker>()
.setInitialDelay(1, TimeUnit.MINUTES)
.addTag("one")
.setBackoffCriteria(BackoffPolicy.LINEAR, 5, TimeUnit.MINUTES)
.build()
8.取消任务
// 取消后台任务
// WorkManager.getInstance(this).cancelAllWork()
WorkManager.getInstance(this).cancelWorkById(request.id)
// WorkManager.getInstance(this).cancelAllWorkByTag("one")
9.监听任务执行结果
// 监听任务执行结果
WorkManager.getInstance(this).getWorkInfoByIdLiveData(request.id).observe(this) {
if (it.state == WorkInfo.State.SUCCEEDED) {
Log.d("MainActivity", "任务执行成功")
} else if (it.state == WorkInfo.State.FAILED) {
Log.d("MainActivity", "任务执行失败")
}
}
10.周期任务
// 周期性任务,执行周期不得小于15分钟
// val request = PeriodicWorkRequest.Builder(FirstWorker::class.java, 15, TimeUnit.MINUTES).build()
val request = PeriodicWorkRequestBuilder<FirstWorker>(15,TimeUnit.MINUTES).build()
11.链式任务
beginWith
是第一个执行的任务
then
是依次排在第一个任务后面的任务。
只有当任务执行成功时,才会执行下一个任务。
// 链式任务
/*WorkManager.getInstance(this)
.beginWith(syncRequest)
.then(compressRequest)
.then(uploadRequest)
.enqueue()*/
学习完整笔记:
// 单次任务
// val request = OneTimeWorkRequest.Builder(FirstWorker::class.java).build()
val request = OneTimeWorkRequestBuilder<FirstWorker>()
.setInitialDelay(1, TimeUnit.MINUTES)
.addTag("one")
.setBackoffCriteria(BackoffPolicy.LINEAR, 5, TimeUnit.MINUTES)
.build()
// 周期性任务,执行周期不得小于15分钟
// val request = PeriodicWorkRequest.Builder(FirstWorker::class.java, 15, TimeUnit.MINUTES).build()
// val request = PeriodicWorkRequestBuilder<FirstWorker>(15,TimeUnit.MINUTES).build()
// 加入任务队列
WorkManager.getInstance(this).enqueue(request)
// 取消后台任务
// WorkManager.getInstance(this).cancelAllWork()
// WorkManager.getInstance(this).cancelWorkById(request.id)
// WorkManager.getInstance(this).cancelAllWorkByTag("one")
// 监听任务执行结果
WorkManager.getInstance(this).getWorkInfoByIdLiveData(request.id).observe(this) {
if (it.state == WorkInfo.State.SUCCEEDED) {
Log.d("MainActivity", "任务执行成功")
} else if (it.state == WorkInfo.State.FAILED) {
Log.d("MainActivity", "任务执行失败")
}
}
// 链式任务
/*WorkManager.getInstance(this)
.beginWith(syncRequest)
.then(compressRequest)
.then(uploadRequest)
.enqueue()*/
最后
如果想要成为架构师或想突破20~30K薪资范畴,那就不要局限在编码,业务,要会选型、扩展,提升编程思维。此外,良好的职业规划也很重要,学习的习惯很重要,但是最重要的还是要能持之以恒,任何不能坚持落实的计划都是空谈。
如果你没有方向,这里给大家分享一套由阿里高级架构师编写的《Android八大模块进阶笔记》,帮大家将杂乱、零散、碎片化的知识进行体系化的整理,让大家系统而高效地掌握Android开发的各个知识点。
相对于我们平时看的碎片化内容,这份笔记的知识点更系统化,更容易理解和记忆,是严格按照知识体系编排的。
欢迎大家一键三连支持,若需要文中资料,直接扫描文末CSDN官方认证微信卡片免费领取↓↓↓(文末还有ChatGPT机器人小福利哦,大家千万不要错过)
PS:群里还设有ChatGPT机器人,可以解答大家在工作上或者是技术上的问题