原生移动开发 / 系统课时

WorkManager 后台任务

WorkManager 后台任务

WorkManager 适合“必须最终执行、允许延后、需要跨进程重启继续调度”的后台工作。本节用一次同步任务串起 Worker、约束、失败重试、周期调度与任务链,并说明哪些行为不能把它当成精确定时器来理解。

学习目标

  • 能创建 CoroutineWorker 并正确返回成功、失败或重试结果
  • 能为任务配置网络、电量约束、退避重试和周期调度
  • 能用任务链表达前后依赖,并理解周期任务的边界

WorkManager 解决的是持久调度

普通协程只存在于当前进程中;Activity 退出、进程被回收后,协程本身不会替你保存“这项工作还要做”。WorkManager 会持久化待执行工作,并在约束满足后交给系统调度,因此更适合日志上传、数据同步、离线队列提交等可延后的可靠任务。

一项工作从 WorkRequest 入队后,通常先处于等待状态。系统满足网络、电量等约束后启动 Worker;Worker 返回 success() 表示完成,返回 failure() 表示终止,返回 retry() 则按退避策略重新等待。

WorkManager 任务从入队到执行、重试与后继任务的关系

创建可重试的 CoroutineWorker

在已有 Android App 中加入 WorkManager 依赖,版本号请替换成项目采用的实际版本。

kotlin
dependencies {
    implementation("androidx.work:work-runtime-ktx:<WORK_VERSION>")
}

这是构建配置片段。同步 Gradle 后,项目应能解析 androidx.work 包;若依赖解析失败,先检查版本号与仓库配置,再继续写 Worker。

下面是主示例。SyncWorker 模拟同步任务:默认直接成功;传入 forceRetry=true 时,前两次执行主动请求重试。runAttemptCount 从 0 开始,可用于限制应用层重试逻辑。

kotlin
package com.example.workdemo

import android.content.Context
import android.util.Log
import androidx.work.BackoffPolicy
import androidx.work.Constraints
import androidx.work.CoroutineWorker
import androidx.work.Data
import androidx.work.NetworkType
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.WorkManager
import androidx.work.WorkerParameters
import java.util.UUID
import java.util.concurrent.TimeUnit

class SyncWorker(
    appContext: Context,
    params: WorkerParameters
) : CoroutineWorker(appContext, params) {

    override suspend fun doWork(): Result {
        val forceRetry = inputData.getBoolean("forceRetry", false)
        Log.i("WorkDemo", "SyncWorker attempt=$runAttemptCount")

        if (forceRetry && runAttemptCount < 2) {
            return Result.retry()
        }

        // 真实项目在这里执行网络同步、文件上传或本地队列提交。
        return Result.success()
    }
}

fun enqueueSync(context: Context, forceRetry: Boolean = false): UUID {
    val constraints = Constraints.Builder()
        .setRequiredNetworkType(NetworkType.CONNECTED)
        .setRequiresBatteryNotLow(true)
        .build()

    val request = OneTimeWorkRequestBuilder<SyncWorker>()
        .setConstraints(constraints)
        .setInputData(Data.Builder().putBoolean("forceRetry", forceRetry).build())
        .setBackoffCriteria(
            BackoffPolicy.EXPONENTIAL,
            10,
            TimeUnit.SECONDS
        )
        .build()

    WorkManager.getInstance(context).enqueue(request)
    return request.id
}

预期结果:在设备联网且电量条件满足后调用 enqueueSync(context),Worker 最终执行一次并成功。Logcat 中可看到类似输出,实际时间可能不同。

text
<TIME> I/WorkDemo: SyncWorker attempt=0

若调用 enqueueSync(context, forceRetry = true),前两次会返回 retry(),WorkManager 按指数退避重新调度,第三次进入成功分支。退避并不承诺精确到某一秒,系统省电策略和约束仍可能继续推迟执行。

配置周期任务

周期任务适合“隔一段时间尝试同步一次”,而不是“每天 08:00:00 准点执行”。PeriodicWorkRequest 的重复间隔不能小于 15 分钟,而且实际运行时间会受约束、Doze 和系统调度影响。

片段示例:以下函数复用上面的 SyncWorker,放在同一 Android 模块中。

kotlin
import android.content.Context
import androidx.work.Constraints
import androidx.work.ExistingPeriodicWorkPolicy
import androidx.work.NetworkType
import androidx.work.PeriodicWorkRequestBuilder
import androidx.work.WorkManager
import java.util.concurrent.TimeUnit

fun schedulePeriodicSync(context: Context) {
    val constraints = Constraints.Builder()
        .setRequiredNetworkType(NetworkType.UNMETERED)
        .build()

    val request = PeriodicWorkRequestBuilder<SyncWorker>(
        15,
        TimeUnit.MINUTES
    )
        .setConstraints(constraints)
        .build()

    WorkManager.getInstance(context).enqueueUniquePeriodicWork(
        "periodic-sync",
        ExistingPeriodicWorkPolicy.KEEP,
        request
    )
}

预期结果:调用后只保留名为 periodic-sync 的一组周期工作;设备满足“非计费网络”等条件时,系统在各周期内择机运行它。它不会保证每隔 15 分钟整点触发。

用任务链表达依赖

当“清理旧缓存”必须成功后才能“上传新数据”,应使用一次性任务链,而不是在 Worker 内手工启动另一个 Worker。前置任务失败或被取消时,依赖它的后继任务不会执行。

片段示例:下面继续复用同一模块中的 SyncWorker。

kotlin
import android.content.Context
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.WorkManager
import androidx.work.Worker
import androidx.work.WorkerParameters

class CleanupWorker(
    appContext: Context,
    params: WorkerParameters
) : Worker(appContext, params) {
    override fun doWork(): Result = Result.success()
}

fun enqueueChain(context: Context) {
    val cleanup = OneTimeWorkRequestBuilder<CleanupWorker>().build()
    val sync = OneTimeWorkRequestBuilder<SyncWorker>().build()

    WorkManager.getInstance(context)
        .beginWith(cleanup)
        .then(sync)
        .enqueue()
}

预期结果:CleanupWorker 成功后才会调度 SyncWorker;如果清理任务失败或取消,同一条依赖链上的同步任务不会继续运行。

PeriodicWorkRequest 不能成为任务链的一部分。需要“定期触发一组步骤”时,常见做法是让周期 Worker 自己完成轻量协调,或在每次触发时按业务规则创建一组一次性工作。这样才能把“重复触发”和“步骤依赖”分开建模。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

WorkManager 后台任务

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通