原生移动开发 / 系统课时

创建一次可靠后台任务

创建一次可靠后台任务

本篇从一个最小可运行例子开始:定义 Worker、创建一次性 WorkRequest、提交到 WorkManager,再观察任务状态。重点不是写复杂业务,而是建立“工作单元”和“调度请求”分离的基本模型。

学习目标

  • 能定义一个最小的 Kotlin Worker 并返回执行结果
  • 能创建并提交 OneTimeWorkRequest
  • 能通过 WorkInfo 理解 ENQUEUED、RUNNING、SUCCEEDED 等状态变化

定义 Worker

Worker 表示真正执行的工作单元。对于一次简单的同步任务,可以继承 Worker,把业务操作放进 doWork(),最后通过 Result.success()、Result.failure() 或 Result.retry() 告诉 WorkManager 本次执行结果。

下面示例假定项目已经添加 AndroidX WorkManager 依赖,并使用 Kotlin 与普通 Android Activity。

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

class SyncWorker(
    appContext: Context,
    workerParams: WorkerParameters
) : Worker(appContext, workerParams) {

    override fun doWork(): Result {
        // 真实项目中这里执行同步、上传或本地数据处理。
        Log.d("SyncWorker", "background work started")
        return Result.success()
    }
}

fun enqueueSync(context: Context) {
    val request = OneTimeWorkRequestBuilder<SyncWorker>().build()
    WorkManager.getInstance(context).enqueue(request)
}

预期输出

text
D/SyncWorker: background work started

这里有两个不同层次的对象:SyncWorker 描述“做什么”,OneTimeWorkRequest 描述“这次工作如何被调度”。把业务代码直接塞进 Activity,会让任务生命周期受界面影响;拆成 Worker 后,调度职责交给 WorkManager。

提交后观察状态

提交 WorkRequest 后,可以保存它的唯一 ID,通过 getWorkInfoByIdLiveData() 观察生命周期。实际运行时,状态可能经历排队和运行阶段;如果约束未满足,任务可能继续保持排队状态。

kotlin
import android.os.Bundle
import android.util.Log
import androidx.appcompat.app.AppCompatActivity
import androidx.work.OneTimeWorkRequestBuilder
import androidx.work.WorkManager

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val request = OneTimeWorkRequestBuilder<SyncWorker>().build()
        val workManager = WorkManager.getInstance(this)

        workManager.enqueue(request)

        workManager.getWorkInfoByIdLiveData(request.id)
            .observe(this) { info ->
                info?.let {
                    Log.d("SyncWork", "id=${it.id}, state=${it.state}")
                }
            }
    }
}

预期结果

text
D/SyncWork: id=<ID>, state=ENQUEUED
D/SyncWork: id=<ID>, state=RUNNING
D/SyncWork: id=<ID>, state=SUCCEEDED

<ID> 是运行时生成的 WorkRequest 标识,实际值每次可能不同。状态也不应按“固定三行日志”理解:调度条件、系统状态或任务执行时间不同,观察到的状态序列可能有所变化。

WorkManager 一次性任务从提交到完成的生命周期

正确理解三个结果

Result.success() 表示这次工作已经完成;Result.failure() 表示工作失败且不应按重试语义继续;Result.retry() 表示本次没有完成,但应该按照 WorkManager 的退避策略在之后再次尝试。

因此,网络临时中断、服务暂时不可用这类可恢复错误通常需要和永久性业务错误区分处理。不要捕获所有异常后都返回 Result.success(),否则 WorkManager 会认为任务已经完成,后续也不会因为这次结果而重试。

验证可靠调度是否成立

实际开发中,不要只看一次 doWork() 是否打印日志。至少确认三个结果:任务被成功 enqueue,WorkInfo 能观察到状态变化,以及最终状态与业务处理结果一致。这样才能验证你真正使用的是 WorkManager 的调度能力,而不是碰巧在当前进程里执行了一次后台代码。

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

目录与阅读设置

阅读设置

17

记录一个想法

创建一次可靠后台任务

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

登录哪都通