在 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<Context>()
       val worker = TestListenableWorkerBuilder<RefreshMainDataWork>(context)
               .setWorkerFactory(RefreshMainDataWork.Factory(fakeNetwork))
               .build()

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

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

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

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

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,366评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,521评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,689评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,925评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,942评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,727评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,447评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,349评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,820评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,990评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,127评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,812评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,471评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,017评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,142评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,388评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,066评论 2 355

推荐阅读更多精彩内容