Android Jetpack之WorkManager

WorkManager的介绍

WorkManager是用来执行后台任务的，例如，发送应用程序日志、同步应用程序数据、备份用户数据等。WorkManager能保证任务一定会被执行，即使应用程序当前不在运行中，甚至在设备重启过后，任务仍然会在适当的时刻被执行。这是因为WorkManager有自己的数据库，关于任务的所有信息和数据都保存在该数据库中。因此，只要任务交给了WorkManager，哪怕应用程序彻底退出，或者设备被重新启动，WorkManager依然能够保证完成你交给它的任务。WorkManager最低能兼容API Level 14，并且不需要你的设备安装Google PlayServices。因此，不用过于担心兼容性问题，因为API Level 14已经能够兼容几乎100%的设备。

WorkManager的使用

使用前需要添加如下依赖：

implementation "androidx.work:work-runtime:2.6.0-beta01"

1.简单任务的创建

这里我们先学习如何创建一次性执行的任务，首先我们需要继承Worker并实现doWork()方法，所执行的任务就在这个方法中执行，在任务中我们打印一句话

public class SimpleWork extends Worker {
    public SimpleWork(@NonNull Context context, @NonNull WorkerParameters workerParams) {
        super(context, workerParams);
    }

    @NonNull
    @Override
    public Result doWork() {
        Log.e("简单任务","执行完毕");
        return Result.success();
    }
}

doWork()方法的返回值类型为Result，它有三种状态
● Result.success() ：执行成功
● Result.failure() ：执行失败
● Result.retry() ：需要重新执行
在Activity中执行任务的代码如下，其中simpleWork()方法是点击按钮触发的方法，OneTimeWorkRequest是只执行一次的任务请求

/**
     * 简单任务
     * @param view
     */
    public void simpleWork(View view) {
        OneTimeWorkRequest oneTimeWorkRequest =
                new OneTimeWorkRequest.Builder(SimpleWork.class)
                        .build();
        WorkManager.getInstance(this).enqueue(oneTimeWorkRequest);
    }

另外我们还可以给任务添加延时执行，如下所示，通过setInitialDelay()方法将任务的执行延迟2秒

/**
     * 简单任务
     * @param view
     */
    public void simpleWork(View view) {
        OneTimeWorkRequest oneTimeWorkRequest =
                new OneTimeWorkRequest.Builder(SimpleWork.class)
                        .setInitialDelay(2, TimeUnit.SECONDS)
                        .build();
        WorkManager.getInstance(this).enqueue(oneTimeWorkRequest);
    }

执行效果如下

2.Worker的数据传递

数据我们使用Data来进行传递，具体代码如下：
Activity中向Worker传递数据通过setInputData()方法，并且我们在这里也监听了Worker回传的数据

public void transferDataWork(View view) {
        Data data = new Data.Builder()
                .putString("data","Activity的数据").build();
        OneTimeWorkRequest oneTimeWorkRequest =
                new OneTimeWorkRequest.Builder(SimpleWork.class)
                        .setInputData(data)
                        .build();
        WorkManager.getInstance(this).enqueue(oneTimeWorkRequest);
        //监听Worker回传的数据
        WorkManager.getInstance(this)
                .getWorkInfoByIdLiveData(oneTimeWorkRequest.getId())
                .observe(this, new Observer<WorkInfo>() {
                    @Override
                    public void onChanged(WorkInfo workInfo) {
                        if(workInfo.getState().isFinished()){
                            Data outputData = workInfo.getOutputData();
                            Log.e("传递数据任务",outputData.getString("data"));
                        }
                    }
                });
    }

Worker中的代码如下，直接将Data作为参数放到Result.success()等的方法中即可

public class TransferDataWork extends Worker {
    public TransferDataWork(@NonNull Context context, @NonNull WorkerParameters workerParams) {
        super(context, workerParams);
    }

    @NonNull
    @Override
    public Result doWork() {
        String activityData = getInputData().getString("data");
        Log.e("传递数据任务",activityData);
        Data data = new Data.Builder()
                .putString("data","TransferDataWork的数据").build();
        return Result.success(data);
    }
}

执行效果如下

3.任务链

这里我们可以使用WorkManager的beginWith()和then()方法设置先执行的任务和后执行的任务，beginWith()和then()方法也都可以传递任务集合

public class MoreWork extends Worker {
    public MoreWork(@NonNull Context context, @NonNull WorkerParameters workerParams) {
        super(context, workerParams);
    }

    @NonNull
    @Override
    public Result doWork() {
        String activityData = getInputData().getString("data");
        Log.e("任务链",activityData);
        return Result.success();
    }
}

 /**
     * 任务链
     * @param view
     */
    public void moreWork(View view) {
        ArrayList<OneTimeWorkRequest> workerRequests = new ArrayList();
        //任务1
        OneTimeWorkRequest oneTimeWorkRequest1 =
                new OneTimeWorkRequest.Builder(MoreWork.class)
                        .setInputData(new Data.Builder().putString("data","任务1").build())
                        .build();
        //任务2
        OneTimeWorkRequest oneTimeWorkRequest2 =
                new OneTimeWorkRequest.Builder(MoreWork.class)
                        .setInputData(new Data.Builder().putString("data","任务2").build())
                        .build();
        workerRequests.add(oneTimeWorkRequest1);
        workerRequests.add(oneTimeWorkRequest2);

        //任务3
        OneTimeWorkRequest oneTimeWorkRequest3 =
                new OneTimeWorkRequest.Builder(MoreWork.class)
                        .setInputData(new Data.Builder().putString("data","任务3").build())
                        .build();
        WorkManager.getInstance(this)
                .beginWith(workerRequests)//先执行的任务
                .then(oneTimeWorkRequest3)//后执行的任务
                .enqueue();
    }

执行结果如下

4.周期性任务

前面提到过的OneTimeWorkRequest是一次性任务。一次性任务在任务成功执行后，便彻底结束。而周期性任务则需要通过PeriodicWorkRequest来实现，它会按照设定的时间定期执行。二者使用起来没有太大差别。需要注意的是，周期性任务的间隔时间不能少于15分钟，具体代码如下：

public class PeriodicWork extends Worker {
    public PeriodicWork(@NonNull Context context, @NonNull WorkerParameters workerParams) {
        super(context, workerParams);
    }

    @NonNull
    @Override
    public ListenableWorker.Result doWork() {
        Log.e("周期性任务","执行完毕");
        return Result.success();
    }
}

/**
     * 周期性任务
     * @param view
     */
    public void periodicTask(View view) {
        PeriodicWorkRequest periodicWorkRequest =
                new PeriodicWorkRequest.Builder(PeriodicWork.class,15,TimeUnit.MINUTES)
                        .build();
        WorkManager.getInstance(this)
                .enqueue(periodicWorkRequest);
    }

5.任务的取消

取消任务可以通过如下三种方法取消

//根据id取消
        WorkManager.getInstance(this).cancelWorkById(oneTimeWorkRequest1.getId());
        //取消所有
        WorkManager.getInstance(this).cancelAllWork();
        //根据Tag取消
        WorkManager.getInstance(this).cancelAllWorkByTag("Tag");

案例源码

https://gitee.com/itfitness/work-manager-demo