原文地址:https://android.jlelse.eu/exploring-jetpack-the-power-of-chains-in-the-workmanager-apis-30509ca4b2c
上一篇文章我们讨论了WorkManager API如何工作以及如何使用这些API来安排work在特定条件下运行。
这篇文章中我们将讨论如何将多个work链接到一起,并且按特定顺序运行,让我们开始来了解链条的力量。
链接works:
- 可能有一些时候希望按特定顺序运行某些人武,WorkManager提供链条以预定义顺序排列你的work。
- 例如,照片编辑器应用程序需要先压缩图像,然后该图像应该上传到服务器。在这个例子中,你需要两个任务 - 一个用于压缩图像,另一个用于上传图像 - 按顺序运行
- 使用WorkManager,你可以轻松的链接这些任务,以按顺序或并行或以任意组合方式运行。
- 记住,如何任何任务在链条中出错了,链条将无法运行该失败任务之后的剩余任务。
如何链接works
- 链接两个或更多works,work manager提供了两个方法:1)beginWith 和2) then,你可以传递你想要运行的Worker的WorkRequest
- 顾名思义,beginWith方法指示链的起点。
- beginWith之后,可以添加多个then调用,然后后续的work会在前面的work完成之后运行。
链接work并且顺序执行
- 我们看一下上面的例子,上传照片的工作应在照片压缩后执行,因此,对于这个例子,我们需要安排两个Worker按顺序运行。
WorkManager.getInstance()
.beginWith(compressWork)
.then(uploadWork)// then() returns new WorkContinuation instance
.enqueue();
了解顺序链中的数据流
- 按顺序链接多个任务时,一个任务的输出可用作链中下一个任务的输入。
- 如果它是一个简单的链,并且一个OneTimeWorkRequest后跟另外一个OneTimeWorkRequest,则第一个任务通过调用setOutputData返回其结果,下一个任务通过调用getInputData()来获取结果。
- 在上面的例子中,compressWork将首先运行,并在完成之后返回WorkComputation,接着传递给uploadWork。
链条并行执行
-
让我们考虑一个更复杂的例子,你需要并行运行A1,A2,A3,然后接着运行B,最后并行运行C1,C2。
了解并行链中的数据流
- 在上面的例子中,A1,A2,A3并行运行,B不会开始执行,直到所有并行运行的任务完成。
- 一旦A1,A2,A3运行完成,这三个任务的综合输出作为任务B的输入传递
- 你可以在OneTimeWorkRequest.Builder中设置InputMerger,以指定在不同的任务使用相同key而返回数据时。
- 现在当B执行完成之后,C1和C2将会接收从B返回的数据。
合并多个链
-
WorkManager提供了一种将多个链并行执行的方法。
- 假如你有链1,它按顺序运行A1和A2,同样,链2有B1和B2顺序运行。
- 现在希望将这些链组合起来,以便他们能够并行运行,并在链完成执行后立即执行C
- 你可以使用combine方法实现
WorkContinuation chain1 = WorkManager.getInstance()
.beginWith(workA1)
.then(workA2);
WorkContinuation chain2 = WorkManager.getInstance()
.beginWith(workB1)
.then(workB2);
WorkContinuation chain3 = WorkContinuation
.combine(chain1, chain2) //Combines chain 1 and 2
.then(workC);
chain3.enqueue();
这里工作管理器不保证不同子链之间的执行顺序。
- 还有许多其他重载版本的组合方法,允许不同的组合将链与OneTimeWorkRequest或OneTimeWorkRequest列表组合。
唯一work流
您可以创建一个唯一的工作序列,只需调用beginUniqueWork()而不是beginWith()来开始序列。每个独特的工作序列都有一个名字; WorkManager只允许在同一时间有一个工作流使用一个名字。当您创建新的唯一工作序列时,您可以指定WorkManager应该执行的操作,如果已经有一个未完成的序列具有相同的名称:
- 取消已经存在的流然后替换为新的
- 继续执行存在的,然后忽略新的
- 将新序列附加到现有序列,在现有序列的最后一个任务完成后运行新序列的第一个任务。
如果您有一个不应该多次入队的任务,则唯一工作序列可能很有用。例如,如果您的应用程序需要将其数据同步到网络,则可能会排列一个名为“sync”的序列,并指定如果已经有一个具有该名称的序列,则应该忽略您的新任务。如果您需要逐步建立一个长期的任务链,那么唯一的工作序列也会很有用。例如,照片编辑应用程序可能会让用户撤消一长串的操作。每个撤销操作可能需要一段时间,但必须按正确的顺序执行。在这种情况下,应用程序可以创建一个“撤消”链并根据需要将每个撤销操作追加到链中。
标记work
你可以给WorkRequest对象打标记,将逻辑上的任务分组,要设置标签,请调用WorkRequest.Builder.addTag(),例如:
val cancelCleanupTask = OneTimeWorkRequest<MyCacheCleanupWorker>()
.setConstraints(myConstraints)
.addTag("cleanup")
.build()
WorkManager提供了一些工具方法可以让你使用标签操作所有的任务,例如,WorkManager.cancelAllWorkByTag()取消所有特定标签的任务,并且WorkManager.getStatusesByTag()返回一个具有该标签的WorkStatus列表