乐趣区

关于android:WorkManager-在-Kotlin-中的实践

jiezi

WorkManager 是一个 Android Jetpack 扩大库，它能够让您轻松布局那些可延后、异步但又须要牢靠运行的工作。对于绝大部分后盾执行工作来说，应用 WorkManager 是目前 Android 平台上的最佳实际。

目前为止 WorkManager 系列曾经探讨过:

  • Android Jetpack WorkManager | Android 中文教学视频

在这篇文章中，咱们将探讨:

  • 在 Kotlin 中如何应用 WorkManager
  • CoroutineWorker 类
  • 如何应用 TestListenableWorkerBuilder 测试您的 CoroutineWorker 类

Kotlin 版的 WorkManager

本文的示例代码是用 Kotlin 编写的并应用了 KTX 库 (Kotlin Extensions)。KTX 版的 WorkManager 提供了更简洁且习用的 Kotlin 扩大函数。如 WorkManager 公布日志 中形容的那样，只须要在 build.gradle 文件中增加 androidx.work:work-runtime-ktx 依赖项，即可应用 KTX 版的 WorkManager。该组件蕴含 CoroutineWorker 和其余有用的 WorkManager 扩大办法。

更简洁且习用

当您须要结构一个数据对象，并且须要将它传入 Worker 类或者从 Worker 类返回时，KTX 版 WorkManager 提供了一种语法糖。在这种状况下，用 Java 语法实现的代码如下所示:

Data myData = new Data.Builder()
                      .putInt(KEY_ONE_INT, aInt)
                      .putIntArray(KEY_ONE_INT_ARRAY, aIntArray)
                      .putString(KEY_ONE_STRING, aString)
                      .build();

而在 Kotlin 中，咱们能够借助 workDataOf 辅助函数将代码写的更简洁:

inline fun workDataOf(vararg pairs: Pair<String, Any?>): Data

因而能够将后面的 Java 表达式改写成:

val data = workDataOf(
        KEY_MY_INT to myIntVar,
        KEY_MY_INT_ARRAY to myIntArray,
        KEY_MY_STRING to myString
    )

CoroutineWorker

除了能够应用 Java 实现的 Worker 类 (Worker、ListenableWorker 和 RxWorker) 之外，还有惟一一个应用 Kotlin 协程实现的 Work 类——CoroutineWorker。

Worker 类与 CoroutineWorker 类的次要区别在于: CoroutineWorker 类的 doWork() 办法是一个能够执行异步工作的挂起函数，而 Worker 类的 doWork() 办法只能执行同步工作。CoroutineWorker 的另一个个性是能够主动解决工作的暂停和勾销，而 Worker 类须要实现 onStopped() 办法来解决这些状况。

取得残缺上下文信息，请参阅官网文档 在 WorkManager 中进行线程解决。在这里，我想重点介绍一下什么是 CoroutineWorker，并且涵盖一些细小的但很重要的区别，以及深刻理解如何应用在 WorkManager v2.1 中引入的新测试个性，来测试您的 CoroutineWorker 类。

正如后面写的那样，CoroutineWorker#doWork() 只是一个挂起函数。它默认是在 Dispatchers.Default 上启动的:

class MyWork(context: Context, params: WorkerParameters) :
        CoroutineWorker(context, params) {override suspend fun doWork(): Result {
return try {
            // 做点什么
            Result.success()} catch (error: Throwable) {Result.failure()
        }
    }
}

须要切记的是，这是应用 CoroutineWorker 代替 Worker 或 ListenableWorker 时的基本区别:

与 Worker 不同，此代码不会在 WorkManager 的 Configuration 中指定的 Executor 上运行。

正如方才所说，CoroutineWorker#doWork() 默认是在 Dispatchers.Default 启动的。您能够应用 withContext() 对此配置进行自定义。

class MyWork(context: Context, params: WorkerParameters) :
        CoroutineWorker(context, params) {override suspend fun doWork(): Result = withContext(Dispatchers.IO) {
return try {
            // 做点什么
            Result.success()} catch (error: Throwable) {Result.failure()
        }
    }
}

很少须要扭转 CoroutineWorker 应用的 Dispatcher，因为 Dispatchers.Default 能够满足大多数状况下的需要。

要理解对于如何在 Kotlin 中应用 WorkManager，能够尝试这个 codelab。

测试 Worker 类

WorkManager 有几个额定的工具类，能够很不便地测试您的 Work。您能够在 WorkManager 测试文档页面 和新的 应用 WorkManager 2.1.0 进行测试 的指南中理解更多相干信息。测试工具的原始实现使得自定义 WorkManager 成为可能，这样一来咱们便能够使其体现为同步执行，进而能够应用 WorkManagerTestInitHelper#getTestDriver() 来模仿提早和测试周期性工作。

WorkManager v2.1 版中减少了一个新的工具类: TestListenableWorkerBuilder，它引入了一种全新的测试 Worker 类的形式。

这对于 CoroutineWorker 类来说是一个十分重要的更新，因为您能够通过 TestListenableWorkerBuilder 间接运行 Worker 类，来测试它们的逻辑是否正确。

@RunWith(JUnit4::class)
class MyWorkTest {
    private lateinit var context: Context
    @Before
    fun setup() {context = ApplicationProvider.getApplicationContext()
    }
    @Test
    fun testMyWork() {
        // 获取 ListenableWorker 的实例
        val worker = 
            TestListenableWorkerBuilder<MyWork>(context).build()
        // 同步的运行 worker
        val result = worker.startWork().get()
        assertThat(result, `is`(Result.success()))
    }
}

这里的重点是能够同步获取 CoroutineWorker 的运行后果，而后能够间接查看 Worker 类的逻辑行为是否正确。

应用 TestListenableWorkerBuilder 也能够将输出数据传递给 Worker 或设置 runAttemptCount，这对于测试 Worker 外部的重试逻辑是十分有用的。

比方，如果要将一些数据上传到服务器，思考到连贯可能呈现问题，您兴许会增加一些重试逻辑:

class MyWork(context: Context, params: WorkerParameters) :
        CoroutineWorker(context, params) {override suspend fun doWork(): Result {val serverUrl = inputData.getString("SERVER_URL")
        return try {
            // 通过 URL 做点什么
            Result.success()} catch (error: TitleRefreshError) {if (runAttemptCount <3) {Result.retry()
            } else {Result.failure()
            }
        }
    }
}

而后您能够在测试中，应用 TestListenableWorkerBuilder 来测试这个重试逻辑是否正确:

@Test
fun testMyWorkRetry() {val data = workDataOf("SERVER_URL" to "[http://fake.url](http://fake.url)")
    // 获取 ListenableWorker，并将 RunAttemptCount 设置为 2
    val worker = TestListenableWorkerBuilder<MyWork>(context)   
                     .setInputData(data)
                     .setRunAttemptCount(2)
                     .build()
    // 启动同步执行的工作
    val result = worker.startWork().get()
    assertThat(result, `is`(Result.retry()))
}
@Test
fun testMyWorkFailure() {val data = workDataOf("SERVER_URL" to "[http://fake.url](http://fake.url)")
    // 获取 ListenableWorker，并将 RunAttemptCount 设置为 3
    val worker = TestListenableWorkerBuilder<MyWork>(context)
                     .setInputData(data)
                     .setRunAttemptCount(3)
                     .build()
    // 启动同步执行的工作
    val result = worker.startWork().get()
    assertThat(result, `is`(Result.failure()))
}

总结

随着 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] 标签 ](https://stackoverflow.com/que…
  • WorkManager 的源码 (AOSP 的一部分)
退出移动版