WorkManager基本使用

冷不防 2023-03-04 11:23 4阅读 0赞

WorkManager能够让我们很容易调试一些将来执行的任务，即使应用退出或者设备重启(这就是厉害的地方)。我们知道JobScheduler也有相似的功能，但是官方建议使用WorkManager取代JobScheduler，因为WorkManager不仅融合了其它的一些API的功能，例如与Google Firebase相关的FirebaseJobDispatcher，与Google Clound Messing相关的GcmNetworkManager，而且WorkManager也会关注电量节省。

当然，并不是所有的任务都会被执行。如果任务需要在应用退出时终止，WorkManager不适用。如果任务需要立即执行，WorkManager也不适用。

### 定义任务 ###

Worker类代表WorkManager使用的任务，Worker类是一个基类，我们需要继承它创建一个任务，并复写`doWork()`方法

public class DownloadWorker extends Worker { 
       public UploadWorker(
           @NonNull Context context,
           @NonNull WorkerParameters params) { 
           super(context, params);
       }
    
       @Override
       public Result doWork() { 
    
          // 执行一些下载图片的任务
          downloadImage();
    
          // 表明任务执行成功
         return Result.success();
       }
    }

`DownloadWorker`这个任务用来下载图片，这个工作在`doWork()`中完成。

`doWork()`是在后台线程中执行的方法，它的返回值表示任务是否执行成功，如果返回`Result.success()`表示任务执行成功，如果返回`Result.failure()`表示任务执行失败，如果返回`Result.retry()`表示任务失败并且需要重试。

从`doWork()`的返回值代表的意义可以看出，在`doWork()`中执行任务是同步阻塞调用，它不支持异步执行任务，并且通过回调返回结果。如果遇到需要使用异步API的情况，那么考虑继承`ListenableWork`。

### 创建任务请求 ###

我们已经知道使用`Woker`定义一个任务，但是在WorkManager调度的是`WorkRequest`，因此我们需要把`Worker`添加到`WorkRequest`中。

`WorkRequest`还包括任务调度的一些信息，例如如何执行任务，是只执行一次，还是周期性执行，又例如任务需要满足哪些条件才能执行。

对于只执行一次的任务，可以使用`OneTimeWorkRequest`，而对于周期性执行的任务，可以使用`PeriodicWorkRequest`。下面以`OneTimeWorkRequest`为例创建一个只执行一次的工作请求

// 任务执行需要有wifi
    Constraints downloadConstraints = new Constraints.Builder()
            .setRequiredNetworkType(NetworkType.UNMETERED) // need wifi
            .build();
    
    WorkRequest downloadWorkRequest = new OneTimeWorkRequest.Builder(DownloadWorker.class)
            .setConstraints(downloadConstraints)
            .build();

这里定义了一个关于下载的`WorkRequest`，它需要在WIFI条件下才能执行。

### 提交任务请求 ###

最后一步，需要把任务请求提交给`WorkManager`

WorkManager.getInstance(this).enqueue(downloadWorkRequest);