使用WorkManager,您可以轻松设置任务并将其交给系统,以便在您指定的条件下运行。
本概述介绍了最基本的WorkManager功能。在此页面中,您将学习如何设置任务,指定应运行的条件,并将其交给系统。您还将学习如何设置重复作业。
有关更高级的WorkManager功能(如作业链和传递和返回值)的信息,请参阅 WorkManager高级功能。还有更多功能; 有关完整的详细信息,请参阅WorkManager参考文档。
注意:要将WorkManager库导入Android项目,请参阅向项目添加组件。
WorkManager基础知识
使用WorkManager,您可以轻松设置任务并将其交给系统,以便在您指定的条件下运行。
本概述介绍了最基本的WorkManager功能。在此页面中,您将学习如何设置任务,指定应运行的条件,并将其交给系统。您还将学习如何设置重复作业。
有关更高级的WorkManager功能(如作业链和传递和返回值)的信息,请参阅 WorkManager高级功能。还有更多功能; 有关完整的详细信息,请参阅WorkManager参考文档。
注意:要将WorkManager库导入Android项目,请参阅向项目添加组件。
类和概念
WorkManager API使用几个不同的类。在某些情况下,您需要子类化其中一个API类。
这些是最重要的WorkManager类:
-
Worker
:指定您需要执行的任务。WorkManager API包含一个抽象Worker
类。您可以扩展此类并在此处执行工作。 -
WorkRequest
:代表一项单独的任务。WorkRequest
对象至少 指定Worker
应该执行任务的类。但是,您还可以向WorkRequest
对象添加详细信息 ,指定诸如运行任务的环境之类的内容。每个WorkRequest
都有一个自动生成的唯一ID; 您可以使用ID执行取消排队任务或获取任务状态等操作。WorkRequest
是一个抽象的类; 在您的代码中,您将使用其中一个直接子类,OneTimeWorkRequest
或PeriodicWorkRequest
。-
WorkRequest.Builder
:用于创建WorkRequest
对象的辅助类 。同样,你将使用其中一个子类,OneTimeWorkRequest.Builder
或PeriodicWorkRequest.Builder
。 -
Constraints
:指定对任务运行时间的限制(例如,“仅在连接到网络时”)。使用创建Constraints
对象Constraints.Builder
,并在创建之前 将其传递Constraints
给 。WorkRequest.Builder
WorkRequest
-
-
WorkManager
:排队和管理工作请求。您将WorkRequest
对象传递WorkManager
给队列任务。WorkManager
调度任务的方式是分散系统资源的负载,同时遵守您指定的约束。 -
WorkInfo
:包含有关特定任务的信息。在WorkManager
提供了LiveData
对每个WorkRequest
对象。所述LiveData
保持WorkInfo
对象; 通过观察LiveData
,您可以确定任务的当前状态,并在任务完成后获取任何返回的值。
典型工作流程
假设您正在编写照片库应用程序,该应用程序需要定期压缩其存储的图像。您希望使用WorkManager API来计划图像压缩。在这种情况下,您在压缩发生时并不特别在意; 你想设置任务而忘记它。
首先,您将定义您的Worker
类,并覆盖其 doWork()
方法。您的worker类指定了如何执行操作,但没有任何关于何时应该运行任务的信息
public class CompressWorker extends Worker {
public CompressWorker(
@NonNull Context context,
@NonNull WorkerParameters params) {
super(context, params);
}
@Override
public Result doWork() {
// Do the work here--in this case, compress the stored images.
// In this example no parameters are passed; the task is
// assumed to be "compress the whole library."
myCompress();
// Indicate success or failure with your return value:
return Result.success();
// (Returning Result.retry() tells WorkManager to try this task again
// later; Result.failure() says not to try again.)
}
}
接下来,OneTimeWorkRequest
基于该对象创建对象Worker
,然后将任务排入队列 WorkManager
:
OneTimeWorkRequest compressionWork =
new OneTimeWorkRequest.Builder(CompressWorker.class)
.build();
WorkManager.getInstance().enqueue(compressionWork);
WorkManager
选择适当的时间来运行任务,平衡诸如系统负载,设备是否插入等考虑因素。在大多数情况下,如果您未指定任何约束,请立即 WorkManager
运行您的任务。如果需要检查任务状态,可以WorkInfo
通过获取相应的句柄来获取对象。例如,如果要检查任务是否已完成,可以使用以下代码:LiveData<WorkInfo>
WorkManager.getInstance().getWorkInfoByIdLiveData(compressionWork.getId())
.observe(lifecycleOwner, workInfo -> {
// Do something with the status
if (workInfo != null && workInfo.getState().isFinished()) {
// ...
}
});
任务约束
如果您愿意,可以指定任务运行时间的约束。例如,您可能希望指定该任务仅在设备空闲并连接到电源时运行。在这种情况下,您需要创建一个 OneTimeWorkRequest.Builder
对象,并使用该构建器来创建实际的OneTimeWorkRequest
:
// Create a Constraints object that defines when the task should run
Constraints myConstraints = new Constraints.Builder()
.setRequiresDeviceIdle(true)
.setRequiresCharging(true)
// Many other constraints are available, see the
// Constraints.Builder reference
.build();
// ...then create a OneTimeWorkRequest that uses those constraints
OneTimeWorkRequest compressionWork =
new OneTimeWorkRequest.Builder(CompressWorker.class)
.setConstraints(myConstraints)
.build();
然后像以前一样将新OneTimeWorkRequest
对象传递给 在找到运行任务的时间时考虑您的约束。WorkManager.enqueue()
WorkManager
取消任务
您可以在排队后取消任务。要取消该任务,您需要其工作ID,您可以从该WorkRequest
对象获取该工作ID 。例如,以下代码取消compressionWork
了上一节中的请求:
UUID compressionWorkId = compressionWork.getId();
WorkManager.getInstance().cancelWorkById(compressionWorkId);
WorkManager
尽最大努力取消任务,但这本质上是不确定的 - 当您尝试取消任务时,任务可能已经运行或已完成。WorkManager
还提供了在尽力而为的基础上取消 唯一工作序列中的所有任务或具有指定标记的所有任务的方法。
标记的工作
您可以通过为任何WorkRequest
对象分配标记字符串来逻辑地对任务进行分组 。要设置标记,请调用WorkRequest.Builder.addTag(String)
,例如:
OneTimeWorkRequest cacheCleanupTask =
new OneTimeWorkRequest.Builder(MyCacheCleanupWorker.class)
.setConstraints(myConstraints)
.addTag("cleanup")
.build();
这些WorkManager
类提供了几种实用程序方法,使您可以使用特定标记操作所有任务。例如,WorkManager.cancelAllWorkByTag(String)
取消具有特定标记的所有任务,并WorkManager.getWorkInfosByTagLiveData(String)
返回WorkInfo
具有该标记的所有任务的所有任务的列表。
重复的任务
您可能需要重复执行一项任务。例如,照片管理器应用可能不会仅压缩其照片一次。更有可能的是,它会经常检查其共享照片,并查看是否有任何新的或已更改的图像需要压缩。此重复任务可以压缩它找到的图像,或者,当它找到需要压缩的图像时,它可以触发新的“压缩此图像”任务。
要创建重复任务,请使用 PeriodicWorkRequest.Builder
该类创建 PeriodicWorkRequest
对象,然后PeriodicWorkRequest
以与OneTimeWorkRequest
对象相同的方式将其 排队 。例如,假设我们定义了一个PhotoCheckWorker
类来识别需要压缩的图像。如果要每12小时运行一次清单任务,则可以创建如下PeriodicWorkRequest
对象:
PeriodicWorkRequest.Builder photoCheckBuilder =
new PeriodicWorkRequest.Builder(PhotoCheckWorker.class, 12,
TimeUnit.HOURS);
// ...if you want, you can apply constraints to the builder here...
// Create the actual work object:
PeriodicWorkRequest photoCheckWork = photoCheckBuilder.build();
// Then enqueue the recurring task:
WorkManager.getInstance().enqueue(photoCheckWork);
在WorkManager
尝试在您请求的时间间隔,受您带来的约束和它的其他要求运行任务。