WorkManager 是一个 Android Jetpack 扩展库，它可以让您轻松规划那些可延后、异步但又需要可靠运行的任务。对于绝大部分后台执行任务来说，使用 WorkManager 是目前 Android 平台上的最佳实践。
- WorkManager https://developer.android.google.cn/topic/libraries/architecture/workmanager/
- Android Jetpack https://developer.android.google.cn/jetpack/
在这篇文章中，我们将讨论:
-
在 Kotlin 中如何使用 WorkManager
-
CoroutineWorker 类
-
如何使用 TestListenableWorkerBuilder 测试您的CoroutineWorker 类
- CoroutineWorker https://developer.android.google.cn/reference/kotlin/androidx/work/CoroutineWorker
- TestListenableWorkerBuilder https://developer.android.google.cn/reference/androidx/work/testing/TestListenableWorkerBuilder
Kotlin 版的 WorkManager
本文的示例代码是用 Kotlin 编写的并使用了 KTX 库 (Kotlin Extensions)。KTX 版的 WorkManager 提供了更简洁且惯用的 Kotlin 扩展函数。如 WorkManager 发布日志中描述的那样，只需要在 build.gradle 文件中添加 androidx.work:work-runtime-ktx 依赖项，即可使用 KTX 版的 WorkManager。该组件包含 CoroutineWorker 和其他有用的 WorkManager 扩展方法。
- KTX 库 https://developer.android.google.cn/kotlin/ktx
- 发布日志 https://developer.android.google.cn/jetpack/androidx/releases/work
更简洁且惯用
当您需要构造一个数据对象，并且需要将它传入Worker 类或者从 Worker 类返回时，KTX 版 WorkManager 提供了一种语法糖。在这种情况下，用 Java 语法实现的代码如下所示:
1 2Data myData = new Data.Builder() 3 .putInt(KEY_ONE_INT, aInt) 4 .putIntArray(KEY_ONE_INT_ARRAY, aIntArray) 5 .putString(KEY_ONE_STRING, aString) 6 .build();
而在 Kotlin 中，我们可以借助 workDataOf 辅助函数将代码写的更简洁:
1 2inline fun workDataOf(vararg pairs: Pair<String, Any?>): Data
因此可以将前面的 Java 表达式改写成:
1 2val data = workDataOf( 3 KEY_MY_INT to myIntVar, 4 KEY_MY_INT_ARRAY to myIntArray, 5 KEY_MY_STRING to myString 6 )
CoroutineWorker
除了可以使用 Java 实现的 Worker 类 (Worker、ListenableWorker 和 RxWorker) 之外，还有唯一一个使用 Kotlin 协程实现的 Work 类——CoroutineWorker。
-
Worker https://developer.android.google.cn/reference/androidx/work/Worker.html
-
ListenableWorker https://developer.android.google.cn/reference/androidx/work/ListenableWorker
-
RxWorker https://developer.android.google.cn/reference/androidx/work/RxWorker.html
-
Kotlin 协程 https://kotlinlang.org/docs/reference/coroutines-overview.html
-
CoroutineWorker https://developer.android.google.cn/reference/kotlin/androidx/work/CoroutineWorker.html
Worker 类与 CoroutineWorker 类的主要区别在于: CoroutineWorker 类的 doWork() 方法是一个可以执行异步任务的挂起函数，而 Worker 类的 doWork() 方法只能执行同步任务。CoroutineWorker 的另一个特性是可以自动处理任务的暂停和取消，而 Worker 类需要实现 onStopped() 方法来处理这些情况。
获得完整上下文信息，请参阅官方文档在 WorkManager 中进行线程处理。在这里，我想重点介绍一下什么是 CoroutineWorker，并且涵盖一些细小的但很重要的区别，以及深入了解如何使用在 WorkManager v2.1 中引入的新测试特性，来测试您的 CoroutineWorker 类。
- 在 WorkManager 中进行线程处理 https://developer.android.google.cn/topic/libraries/architecture/workmanager/advanced/threading
正如前面写的那样，CoroutineWorker#doWork() 只是一个挂起函数。它默认是在 Dispatchers.Default 上启动的:
1 2class MyWork(context: Context, params: WorkerParameters) : 3 CoroutineWorker(context, params) { 4override suspend fun doWork(): Result { 5return try { 6 // 做点什么 7 Result.success() 8 } catch (error: Throwable) { 9 Result.failure() 10 } 11 } 12} 13
需要切记的是，这是使用 CoroutineWorker 代替 Worker 或 ListenableWorker 时的根本区别:
与 Worker 不同，此代码不会在 WorkManager 的 Configuration 中指定的 Executor 上运行。
正如刚才所说，CoroutineWorker#doWork() 默认是在 Dispatchers.Default 启动的。您可以使用 withContext() 对此配置进行自定义。
1 2class MyWork(context: Context, params: WorkerParameters) : 3 CoroutineWorker(context, params) { 4override suspend fun doWork(): Result = withContext(Dispatchers.IO) { 5return try { 6 // 做点什么 7 Result.success() 8 } catch (error: Throwable) { 9 Result.failure() 10 } 11 } 12}
很少需要改变 CoroutineWorker 使用的 Dispatcher，因为 Dispatchers.Default 可以满足大多数情况下的需求。
要了解关于如何在 Kotlin 中使用 WorkManager，可以尝试这个 codelab。
总结
随着 WorkManager v2.1 以及 workManager-testing 中新特性的发布，CoroutineWorker 因其简单易用而大放光彩。现在您可以非常容易的对 Worker 类进行测试，并且 WorkManager 在 Kotlin 中的整体使用体验也非常棒。
如果您还没有在项目中使用 CoroutineWorker 以及 workmanager-runtime-ktx 中包含的其他扩展，强烈建议您在项目中使用它们。当使用 Kotlin 进行开发 (已经成为我的日常) 时，这是我使用 WorkManager 的首选方式。
希望这篇文章对您有所帮助，欢迎您在评论区积极留言，分享您在 WorkManager 使用中的见解或者问题。
WorkManager 相关资源
开发者指南 | 在 WorkManager 中进行线程处理 参考指南 | androidx.work Codelab | 使用 WorkManager 处理后台任务 WorkManager 的公开问题追踪器 发行日志 | WorkManager Stack Overflow 的 [android-workmanager] 标签 WorkManager 的源码 (AOSP的一部分)