在 Android 应用中使用 Kotlin 协程 - 官方示例详解(6) - 将协程与 WorkManager 结合使用

1. 什么是WorkManager

WorkManager 属于 Android Jetpack 的一部分，是一种架构组件.
WorkManager 是一个兼容、灵活且简单的库，用于处理可延迟的后台工作。
WorkManager 是 Android 中这些用例的推荐解决方案。

2. WorkManager 有什么用。

用于处理既需要机会性执行，又需要有保证的执行的后台工作。
机会性执行意味着 WorkManager 会尽快执行您的后台工作。
有保证的执行意味着 WorkManager 会负责通过逻辑保障在各种情况下启动工作，
即使用户离开应用也无妨。

WorkManager 的任务的典型示例:

上传日志
对图片应用滤镜并保存图片
定期将本地数据与网络同步

3. 将协程与WorkManager 一起使用.

不同用例，可以通过 ListenableWorker 基类的不同实现 完成。

public abstract class ListenableWorker {
        public ListenableWorker(@NonNull Context appContext, @NonNull WorkerParameters workerParams) {

使用WorkManager 的最好方法是通过 CoroutineWorker类，该类支持将doWork()定义为suspend函数.
*注： CoroutineWorker 的代码实现：

public abstract class CoroutineWorker(
    appContext: Context,
    params: WorkerParameters
) : ListenableWorker(appContext, params) {

    public abstract suspend fun doWork(): Result

然后，项目代码里的 RefreshMainDataWork， 它继承 CoroutineWorker, 需要实现 doWork.

class RefreshMainDataWork(context: Context, params: WorkerParameters, private val network: MainNetwork) :
        CoroutineWorker(context, params) {
        
    override suspend fun doWork(): Result {
       val database = getDatabase(applicationContext)
       val repository = TitleRepository(network, database.titleDao)

       return try {
           repository.refreshTitle()
           Result.success()
       } catch (error: TitleRefreshError) {
           Result.failure()
       }
    }   
}

请注意，CoroutineWorker.doWork() 是一个挂起函数。
与更简单的 Worker 类不同，此代码不会在WorkManager 配置所指定的执行器上运行，
而是使用 coroutineContext 成员的调度程序（默认为 Dispatchers.Default）。

4. 测试 CoroutineWorker

WorkManager 提供了几种不同的Worker类测试方法.
WorkManager v2.1 引入了一组新的 API 来支持更简单的 ListenableWorker 类测试方法，
并最终推出了 CoroutineWorker。
我们将在代码中使用其中一个名为 TestListenableWorkerBuilder 的新 API。

更新 androidTest 文件夹下的 RefreshMainDataWorkTest 文件

@RunWith(JUnit4::class)
class RefreshMainDataWorkTest {

    @Test
    fun testRefreshMainDataWork() {
       val fakeNetwork = MainNetworkFake("OK")

       val context = ApplicationProvider.getApplicationContext()
       val worker = TestListenableWorkerBuilder(context)
               .setWorkerFactory(RefreshMainDataWork.Factory(fakeNetwork))
               .build()

       // Start the work synchronously
       val result = worker.startWork().get()

       assertThat(result).isEqualTo(Result.success())
    }
}

在执行测试之前，我们会先告知 WorkManager 关于工厂的信息，以便我们注入虚构网络。

测试本身会使用 TestListenableWorkerBuilder 创建我们的工作器，
然后我们可以运行该工作器来调用 startWork() 方法。

--- End --
--- 至此，此系列结束!----