美文网首页翻译
[译] Android - Jetpack - WorkMana

[译] Android - Jetpack - WorkMana

作者: simplehych | 来源:发表于2018-11-23 16:40 被阅读0次

    翻译自 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 尝试按照你的要求的间隔运行任务,受制于你施加的约束和其他要求

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

    相关文章

      网友评论

        本文标题:[译] Android - Jetpack - WorkMana

        本文链接:https://www.haomeiwen.com/subject/rrwjqqtx.html