WorkManager可以轻松设置和安排精心设计的任务请求。 您可以将API用于以下场景：
- 以指定顺序运行的链式任务序列
- 唯一的命名序列，包含应用程序启动两个具有相同名称的序列时会发生什么的规则
- 传递和返回值的任务，包括每个任务将参数传递给链中下一个任务的链式任务
一、链式任务
您的应用可能需要按特定顺序运行多个任务。WorkManager允许您创建和排队指定多个任务的工作序列，以及它们应运行的顺序。
例如，假设您的应用有三个OneTimeWorkRequest对象：workA，workB和workC。 任务必须按该顺序运行。 要将它们排入队列，请使用WorkManager.beginWith（）方法创建一个序列，并传递第一个OneTimeWorkRequest对象; 该方法返回一个WorkContinuation对象，该对象定义了一系列任务。 然后依次使用WorkContinuation.then（）添加剩余的OneTimeWorkRequest对象，最后使用WorkContinuation.enqueue（）将整个序列排入队列：
WorkManager.getInstance()
.beginWith(workA)
// Note: WorkManager.beginWith() returns a
// WorkContinuation object; the following calls are
// to WorkContinuation methods
.then(workB) // FYI, then() returns a new WorkContinuation instance
.then(workC)
.enqueue();
WorkManager根据每个任务指定的约束以请求的顺序运行任务。 如果任何任务返回Worker.Result.FAILURE，则整个序列结束。
您还可以将多个OneTimeWorkRequest对象传递给任何beginWith（）和.then（）调用。 如果将多个OneTimeWorkRequest对象传递给单个方法调用，则WorkManager会在运行其余序列之前运行所有这些任务（并行）。 例如：
WorkManager.getInstance()
// First, run all the A tasks (in parallel):
.beginWith(workA1, workA2, workA3)
// ...when all A tasks are finished, run the single B task:
.then(workB)
// ...then run the C tasks (in any order):
.then(workC1, workC2)
.enqueue();
您可以通过使用WorkContinuation.combine（）方法连接多个链来创建更复杂的序列。 例如，假设您要运行如下序列：
图1.您可以使用WorkContinuation来设置复杂的链式任务。
要设置此序列，请创建两个单独的链，然后将它们连接到第三个链中：
WorkContinuation chain1 = WorkManager.getInstance()
.beginWith(workA)
.then(workB);
WorkContinuation chain2 = WorkManager.getInstance()
.beginWith(workC)
.then(workD);
WorkContinuation chain3 = WorkContinuation
.combine(chain1, chain2)
.then(workE);
chain3.enqueue();
在这种情况下，WorkManager在工作之前运行workA。 它还在工作之前运行。 在work和workD完成后，WorkManager运行workE。
注意：当WorkManager按顺序运行每个子链时，无法保证chain1中的任务可能与chain2中的任务重叠。 例如，workB可能在workC之前或之后运行，或者它们可能同时运行。 唯一的承诺是每个子链中的任务将按顺序运行; 也就是说，workB在workA完成之后才会启动。
WorkContinuation方法有许多变体可以为特定情况提供缩写。 例如，有一个WorkContinuation.combine（OneTimeWorkRequest，WorkContinuation ...）方法，它指示WorkManager完成所有指定的WorkContinuation链，然后使用指定的OneTimeWorkRequest完成。 有关详细信息，请参阅WorkContinuation参考。
二、独特的工作顺序
您可以通过调用beginUniqueWork（）而不是beginWith（）来创建一个唯一的工作序列。 每个独特的工作序列都有一个名称; WorkManager一次只允许一个具有该名称的工作序列。 创建新的唯一工作序列时，如果已经有一个具有相同名称的未完成序列，则指定WorkManager应执行的操作：
- 取消现有序列并将其替换为新序列
- 保留现有序列并忽略您的新请求
- 将新序列附加到现有序列，在现有序列的最后一个任务完成后运行新序列的第一个任务
如果您的任务不应多次排队，则唯一的工作顺序非常有用。 例如，如果您的应用需要将其数据同步到网络，您可以将名为“sync”的序列排队，并指定如果已经有一个具有该名称的序列，则应忽略您的新任务。 如果您需要逐步建立一长串任务，那么独特的工作顺序也很有用。 例如，照片编辑应用程序可能允许用户撤消一长串操作。 每个撤消操作可能需要一段时间，但必须以正确的顺序执行。 在这种情况下，应用程序可以创建“撤消”链并根据需要将每个撤消操作附加到链。
三、输入参数和返回值
为了获得更大的灵活性，您可以将参数传递给任务并让任务返回结果。 传递和返回的值是键值对。 要将参数传递给任务，请在创建WorkRequest对象之前调用WorkRequest.Builder.setInputData（）方法。 该方法采用Data对象，您使用Data.Builder创建。 Worker类可以通过调用Worker.getInputData（）来访问这些参数。 要输出返回值，任务调用Worker.setOutputData（），它接受一个Data对象; 您可以通过观察任务的LiveData <WorkStatus>来获取输出。
例如，假设您有一个执行耗时计算的Worker类。 以下代码显示了Worker类的外观：
// Define the Worker class:
public class MathWorker extends Worker {
// Define the parameter keys:
public static final String KEY_X_ARG = "X";
public static final String KEY_Y_ARG = "Y";
public static final String KEY_Z_ARG = "Z";
// ...and the result key:
public static final String KEY_RESULT = "result";
public MathWorker(
@NonNull Context context,
@NonNull WorkerParameters params) {
super(context, params);
}
@Override
public Worker.Result doWork() {
// Fetch the arguments (and specify default values):
int x = getInputData().getInt(KEY_X_ARG, 0);
int y = getInputData().getInt(KEY_Y_ARG, 0);
int z = getInputData().getInt(KEY_Z_ARG, 0);
// ...do the math...
int result = myCrazyMathFunction(x, y, z);
//...set the output, and we're done!
Data output = new Data.Builder()
.putInt(KEY_RESULT, result)
.build();
setOutputData(output);
return Result.SUCCESS;
}
}
要创建工作并传递参数，您可以使用如下代码：
// Create the Data object:
Data myData = new Data.Builder()
// We need to pass three integers: X, Y, and Z
.putInt(KEY_X_ARG, 42)
.putInt(KEY_Y_ARG, 421)
.putInt(KEY_Z_ARG, 8675309)
// ... and build the actual Data object:
.build();
// ...then create and enqueue a OneTimeWorkRequest that uses those arguments
OneTimeWorkRequest mathWork = new OneTimeWorkRequest.Builder(MathWorker.class)
.setInputData(myData)
.build();
WorkManager.getInstance().enqueue(mathWork);
返回的值将在任务的WorkStatus中可用：
WorkManager.getInstance().getStatusById(mathWork.getId())
.observe(lifecycleOwner, status -> {
if (status != null && status.getState().isFinished()) {
int myResult = status.getOutputData().getInt(KEY_RESULT,
myDefaultValue));
// ... do something with the result ...
}
});
如果链接任务，则一个任务的输出可用作链中下一个任务的输入。 如果它是一个简单的链，只有一个OneTimeWorkRequest后跟另一个OneTimeWorkRequest，第一个任务通过调用setOutputData（）返回其结果，下一个任务通过调用getInputData（）获取该结果。 如果链更复杂 - 例如，因为几个任务都将输出发送到单个后续任务 - 您可以在OneTimeWorkRequest.Builder上定义一个InputMerger，以指定当不同任务返回具有相同键的输出时应该发生什么。
网友评论