Android WorkManage 基本使用

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()*/

👀关注公众号：Android老皮！！！欢迎大家来找我探讨交流👀