当前位置：首页 > backend >正文

Android Jetpack 组件库 -＞WorkManager

backend 2025/7/27 12:04:41

引言

为什么需要 WorkManager？

传统后台任务的问题：

// 传统方式 - 手动管理后台任务
class MainActivity : AppCompatActivity() {override fun onCreate(savedInstanceState: Bundle?) {super.onCreate(savedInstanceState)// 问题1：无法保证任务执行Thread {// 后台任务downloadFile()}.start()// 问题2：无法处理系统限制val alarmManager = getSystemService(Context.ALARM_SERVICE) as AlarmManager// 需要手动处理 Doze 模式、电池优化等}
}

问题：

❌ 无法保证任务在系统限制下执行

❌ 难以处理应用被杀死的情况

❌ 无法设置任务约束条件

❌ 难以管理任务的生命周期

❌ 无法处理网络状态变化

WorkManager 的优势

// WorkManager 方式 - 声明式任务调度
val downloadWork = OneTimeWorkRequestBuilder<DownloadWorker>().setConstraints(Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).setRequiresCharging(true).build()).build()WorkManager.getInstance(context).enqueue(downloadWork)

优势：

✅ 自动处理系统限制（Doze、电池优化等）

✅ 保证任务最终执行

✅ 支持任务约束条件

✅ 自动重试机制

✅ 支持链式任务

✅ 与 Jetpack 组件完美集成

正文

核心概念与架构

核心组件

WorkManager (工作管理器)
↓
WorkRequest (工作请求)
↓
Worker (工作执行者)
↓
WorkInfo (工作状态)

详细说明：

WorkManager

任务调度管理器

负责任务的入队、取消、查询

自动处理系统限制

WorkRequest

任务请求的抽象

包含任务配置（约束、输入、标签等）

分为 OneTimeWorkRequest 和 PeriodicWorkRequest

Worker

实际执行任务的类

在后台线程中执行

返回执行结果

WorkInfo

任务状态信息

包含任务进度、输出数据等

任务类型

// 一次性任务
val oneTimeWork = OneTimeWorkRequestBuilder<MyWorker>().build()// 周期性任务
val periodicWork = PeriodicWorkRequestBuilder<MyWorker>(Duration.ofHours(1) // 最小间隔 15 分钟
).build()// 链式任务
val chain = WorkManager.getInstance(context).beginWith(workA).then(workB).then(workC).enqueue()

基础使用与实践

项目配置

步骤1：添加依赖

dependencies {def work_version = "2.8.1"// WorkManagerimplementation "androidx.work:work-runtime-ktx:$work_version"// WorkManager TestingandroidTestImplementation "androidx.work:work-testing:$work_version"
}

步骤2：创建 Worker

// 基本 Worker
class DownloadWorker(context: Context,params: WorkerParameters
) : Worker(context, params) {override fun doWork(): Result {return try {// 执行下载任务val url = inputData.getString("url") ?: return Result.failure()val fileName = inputData.getString("fileName") ?: return Result.failure()// 模拟下载过程downloadFile(url, fileName)// 返回成功结果val outputData = Data.Builder().putString("filePath", "/storage/downloads/$fileName").build()Result.success(outputData)} catch (e: Exception) {// 返回失败结果Result.failure()}}private fun downloadFile(url: String, fileName: String) {// 实际下载逻辑Thread.sleep(5000) // 模拟下载时间}
}

步骤3：创建 WorkRequest

// 创建一次性任务
val downloadWork = OneTimeWorkRequestBuilder<DownloadWorker>().setInputData(Data.Builder().putString("url", "https://example.com/file.zip").putString("fileName", "download.zip").build()).setConstraints(Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).setRequiresCharging(true).setRequiresDeviceIdle(false).build()).setBackoffCriteria(BackoffPolicy.LINEAR,Duration.ofMinutes(10)).setInitialDelay(Duration.ofMinutes(5)).addTag("download").build()

步骤4：入队任务

            .observe(this) { workInfo ->when (workInfo.state) {WorkInfo.State.SUCCEEDED -> {val filePath = workInfo.outputData.getString("filePath")Log.d("WorkManager", "下载完成: $filePath")}WorkInfo.State.FAILED -> {Log.e("WorkManager", "下载失败")}WorkInfo.State.RUNNING -> {Log.d("WorkManager", "正在下载...")}else -> {Log.d("WorkManager", "状态: ${workInfo.state}")}}}}
}

高级特性

链式任务（Chaining）

WorkManager 支持任务链式执行，前一个任务完成后自动执行下一个任务：

val workA = OneTimeWorkRequestBuilder<WorkerA>().build()
val workB = OneTimeWorkRequestBuilder<WorkerB>().build()
val workC = OneTimeWorkRequestBuilder<WorkerC>().build()WorkManager.getInstance(context).beginWith(workA).then(workB).then(workC).enqueue()

还可以并行执行多个任务：

val workA = OneTimeWorkRequestBuilder<WorkerA>().build()
val workB = OneTimeWorkRequestBuilder<WorkerB>().build()
val workC = OneTimeWorkRequestBuilder<WorkerC>().build()WorkManager.getInstance(context).beginWith(listOf(workA, workB)) // workA 和 workB 并行.then(workC) // workC 在前两个都完成后执行.enqueue()

周期性任务（Periodic Work）

适合定时同步、定时上传等场景：

val periodicWork = PeriodicWorkRequestBuilder<SyncWorker>(15, TimeUnit.MINUTES // 最小周期为15分钟
).build()WorkManager.getInstance(context).enqueueUniquePeriodicWork("syncWork",ExistingPeriodicWorkPolicy.KEEP,periodicWork
)

任务约束（Constraints）

可以为任务设置执行条件：

val constraints = Constraints.Builder().setRequiredNetworkType(NetworkType.UNMETERED) // 仅在WiFi下执行.setRequiresCharging(true) // 仅在充电时执行.setRequiresBatteryNotLow(true) // 电量充足时执行.build()val work = OneTimeWorkRequestBuilder<MyWorker>().setConstraints(constraints).build()

输入输出数据（Input/Output Data）

任务之间可以通过 Data 传递数据：

// 传递输入数据
val inputData = Data.Builder().putString("key", "value").build()val work = OneTimeWorkRequestBuilder<MyWorker>().setInputData(inputData).build()// Worker 中获取输入数据
val value = inputData.getString("key")// Worker 返回输出数据
return Result.success(Data.Builder().putString("result", "done").build())

任务取消与唯一性

通过 tag 或 id 取消任务

支持唯一任务（防止重复入队）

// 通过 tag 取消
WorkManager.getInstance(context).cancelAllWorkByTag("download")// 唯一任务
WorkManager.getInstance(context).enqueueUniqueWork("uniqueWorkName",ExistingWorkPolicy.REPLACE,workRequest
)

实际项目应用

场景举例

图片/文件上传：断点续传，保证最终上传成功

数据同步：定时与服务器同步数据

日志收集：后台收集并定时上传日志

推送消息拉取：定时拉取推送消息

与前台服务结合

WorkManager 允许在需要时将任务提升为前台服务（显示通知），适合长时间运行的任务：

class ForegroundWorker(context: Context, params: WorkerParameters) : Worker(context, params) {override fun doWork(): Result {setForegroundAsync(createForegroundInfo())// 执行任务return Result.success()}private fun createForegroundInfo(): ForegroundInfo {val notification = NotificationCompat.Builder(applicationContext, "channel_id").setContentTitle("任务进行中").setSmallIcon(R.drawable.ic_notification).build()return ForegroundInfo(1, notification)}
}