[译] Android - Jetpack - WorkManager 基础知识

翻译自 WorkManager basics

使用 WorkManager ,您可以轻松的设置任务,并将其交给系统,并在您指定的条件下运行

本文介绍了WorkManager 的基本功能,你将能学到如何设置一个任务,指定它应该运行的条件,并将其交给系统。你还能学到如何设置定期任务。

有关更高级的 WorkManager 的功能信息,例如任务链、传递和返回值等,可以查看 WorkManager advance features 文章,还有更多功能可用,了解详情查看 WorkManager reference documentation 文章

类和概念

WorkManager API 使用几个不同的类,在某些情况下,您需要子类化某一个 API 类

以下是最重要的几个 WorkManager 类:

  • Worker:指定需要执行的任务。WorkManager的 API 包含一个抽象类 Worker,继承此类并执行
  • WorkRequest:代表一个单独的任务,最低限度,一个 WorkRequest 对象指定应该执行任务的 Worker 类,同时也向 WorkRequest 对象添加详情信息,指定诸如应该运行任务的环境之类的事情,每个WorkRequest 都有一个自动生成的唯一 ID,能用这个 ID 做一些诸如取消队列任务或者获取任务状态。WorkRequest 是一个抽象类,代码中,可以使用子类,OneTimeWorkRequest 或者 PeriodWorkRequest。
    • WorkRequest.Builder:创建 WorkRequest 的帮助类,同样你可以用它的子类,OneTimeWorkRequest.Builder或者 PeriodWorkRequest.Builder
    • Constraints: 指定任务运行时的限制(例如仅网络连接时),创建约束可以使用 Constraints.Builder,创建 WorkRequest 之前将 Constraints 传递给 WorkRequest.Builder
  • WorkManager: 排队和管理工作请求,你能传递 WorkRequest 对象到 WorkManager将任务入队,WorkManager 调度任务用这样一个方式为了分散系统资源的负担,同时遵守您指定的约束
  • WorkInfo:包含一个特殊任务的信息,WorkManager 为每个 WorkRequest 对象提供了一个 LiveData,这个 LiveData 包含一个 WorkInfo 对象,通过观察 LiveData,能够确定当前任务的状态,并在任务结束之后得到返回值

典型的工作流程

假设你正在写一个照片库的 app,这个app 需要阶段性压缩存储的图片,你希望用 WorkManager APIs 来管理图片压缩。在这种情况下你不希望特意的关注压缩它,你希望设置任务然后不去管它

首先,你将定义你的 Worker 类,然后重写 doWork() 方法,你的 worker 指定了如何执行操作,但是没有关于什么时候运行任务的信息

class CompressWorker(context : Context, params : WorkerParams) : Worker(context, params) {
    
    override dun doWork(): Result {
        myCompress()
        return Result.SUCCESS
    }
}

接下来,基于 Worker 创建 OneTimeWorkRequest 对象,然后用 WorkManager 将任务排入队列

val compressWork = OneTimeWorkRequestBuilder<CompressWorker>().build()
WorkManager.getInstance().enqueue(compressWork)

WorkManager 选择适当的时间去运行任务,平衡系统负载,是否设备插入等考虑因素。如果没有任何指定约束,WorkManager 马上运行任务。如果你需要检查任务状态,你能通过处理合适的 LiveData<WorkInfo> 得到一个 WorkInfo 的对象,例如,检查任务是否结束,用以下代码:

WorkManager.getInstance().getWorkInfoByIdLiveData(compressionWork.id)
            .observe(lifecycleOwner, Observer {
                workInfo ->
                if(workInfo != null && workInfo.state.isFinished){
                }
            })

任务约束

如果你希望,你能指定任务运行时间约束。例如,指定任务仅在设备空闲时,并连接电源。在这种情况下,你需要创建 OneTimeWorkRequest.Builder对象,用这个构建器创建实际的 OneTimeWorkRequest

val myConstraints = Constraints.Builder()
        .setRequiresDeviceIdle(true)
        .setRequiresCharging(true)
        .build()
        
val compressionWork = OneTimeWorkRequestBuilder<CompressWorker>()
        .setConstraints(myConstraints)
        .build()

然后像以前一样将新的 OneTimeWorkRequest 对象放入 WorkManager.enqueue() 队列中,WorkManager 会考虑你的约束确定任务运行的时间

取消任务

你能取消入队的任务,为了取消任务,你需要知道它的 id,可以从 WorkRequest 对象中获取,例如,下面的代码取消上一节 compressionWork 的请求

val compressionWorkId : UUID = compressionWork.getId()
WorkManager.getInstance().cancelWorkById(compressionWorkId)

标记任务

你可以通过为 WorkRequest 对象分配标记字符串来对任务进行分组,为了设置标记,你需要调用 WorkRequest.builder.addTag(),例如

val cacheCleanupTask = OneTimeWorkRequestBuilder<MyCacheCleanupWorker>()
        .setConstraints(myConstraints)
        .addTag("cleanup)
        .build()

这个 WorkManager 类提供一些有效的方法,使你用特殊的标记操作全部的任务,例如:WorkManager.cancelAllWorkByTag() 用一个 reshuffle 标记取消全部任务, WorkManager.getWorkInfoByTagLiveData() 返回全部任务的一个 WorkInfo 列表

定期任务

你可能需要重复执行一项任务,例如照片管理app 可能不仅压缩照片一次,更多的,它会经常检查它的共享照片,查看是否有新的或者新的照片需要压缩,这个重复的任务能压缩发现的照片,或者发现新的需要压缩的图片进行新的任务进行压缩。

为了创建定期任务,用 PeriodWorkRequest.Builder类创建 PeriodWorkRequest 对象,然后以与 OneTimeWorkRequest 对象相同的方式将 PeriodWorkRequest 入队,例如,假设我们定义一个 PhotoCheckWorker 类定义需要被压缩的图片,如果你想没12小时运行库存任务,你将创建 PeriodWorkRequest 对象如下:

val photoCheckBuilder = PeriodWorkRequestBuilder<PhotoCheckWorker>(12,TimeUnit.HOURS)
val photoCheckWork = photoCheckBuilder.build()
WorkManager.getInstance().enqueue(photoChackWork)

WorkManager 尝试按照你的要求的间隔运行任务,受制于你施加的约束和其他要求

学习中,翻译生硬或错误之处,还望指正

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