WorkManager的用法

一.WorkManager的作用

　　绝大部分应用程序都有后台执行任务的需求，根据需求的不同，Android为后台任务提供了多种解决方案，如JobShedule,Loader,Service等。如果这些api没有被正确的使用，则可能导致消耗大量的电量。WorkManager为应用程序中那些不需要及时完成的任务提供了一个统一的解决方案，以便在设备电量和用户体验间达到一个比较好的平衡。WorkManager有三个重要特点，分别如下：

　　1.针对的是不需要及时完成的任务

　　2.保证任务一定被执行

　　3.兼容范围广，最低能兼容API Level14

二.WorkManager的基本使用方法

　　1.添加依赖：implementation 'androidx.work:work-runtime:2.8.1'

　　2.使用Work类定义任务

public class MyWorker extends Worker {

    public MyWorker(@NonNull Context context, @NonNull WorkerParameters workerParams) {
        super(context, workerParams);
    }

    @NonNull
    @Override
    public Result doWork() {//耗时的任务在doWork()方法中执行
        Log.i("OneTimeWorkRequest","Work Start!");
        String inputData=getInputData().getString("key");//接收WorkManager传递来的数据
        Data outputData=new Data.Builder()
                .putString("key","value")
                .build();
        return Result.success(outputData);//给WorkManager返回数据
    }
}

　　doWork()方法有3种类型的返回值：若执行成功，则返回Result.success()；若执行失败，则返回Result.failure()；若需要重新执行，则返回Result.retry()。

　　3.使用WorkRequest配置任务

　　　　配置任务就是在告诉系统，任务在何时运行及如何运行，下面结合代码讲解

public class MainActivity extends AppCompatActivity implements View.OnClickListener {private Constraints constraints;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Data inputData=new Data.Builder()
                .putString("key","value")
                .build();
　　　　　//设置任务触发的条件：需要联网，电量充足，正在充电
        constraints=new Constraints.Builder()
                .setRequiredNetworkType(NetworkType.CONNECTED)
                .setRequiresBatteryNotLow(true)
                .setRequiresCharging(true)
                .build();
        OneTimeWorkRequest oneTimeWorkRequest=new OneTimeWorkRequest.Builder(MyWorker.class)//一次性任务
                .setConstraints(constraints)
                .setInitialDelay(10,TimeUnit.SECONDS)//触发条件满足后，延迟10s执行任务
                .addTag("test")//为任务设置tag标签，之后可以通过标签跟踪任务的状态，或者取消任务
                .setBackoffCriteria(BackoffPolicy.LINEAR,OneTimeWorkRequest.MIN_BACKOFF_MILLIS, TimeUnit.MILLISECONDS)//设置指数退避策略，例如当Worker线程的执行出现了异常，如服务器宕机，你希望一段时间后重试该任务
                .setInputData(inputData)//传递数据给Worker
                .build();
        WorkManager.getInstance(this).getWorkInfoByIdLiveData(oneTimeWorkRequest.getId()).observe(this, new Observer<WorkInfo>() {//获取WorkInfo对象，实时监测任务的状态
            @Override
            public void onChanged(WorkInfo workInfo) {
                if(workInfo!=null&&workInfo.getState()==WorkInfo.State.SUCCEEDED){
                    String value = workInfo.getOutputData().getString("key");//获取Worker返回的数据
                }
            }
        });
        WorkManager.getInstance(this).enqueue(oneTimeWorkRequest);//将任务提交系统
    }
}

　　4.将任务提交系统：WorkManager.getInstance(this).enqueue(oneTimeWorkRequest);

　　5.观察任务的状态，任务提交系统后，可以通过WorkInfo获知任务的状态，有三种方式获取WorkInfo对象：

　　　　(1)WorkManager.getWorkInfosByTag()

　　　　(2)WorkManager.getWorkInfoById()

　　　　(3)WorkManager.getWokInfosForUniqueWork()

　　　　如果希望实时获取任务的状态，这三个方法还有对应的LiveData方法，在方法后面加上LiveData即可。

　　6.WorkManager与Worker之间的参数传递

　　　　WorkManager通过setInputData()方法向Worker传递数据，数据的传递通过Data对象来完成，需要注意的是，Data只能用于传递一些小的基本类型的数据。

　　　　Worker通过getInputData()方法接收数据，并在任务完成后向WorkManager返回数据，通过return Result.success(outputData)，然后WorkManager通过LiveData得到从Worker返回的数据。

　　7.周期性任务PeriodicWorkRequest

　　　　WorkRequest有两种实现方式，OneTimeWorkRequest和PeriodicWorkRequest，即一次性任务和周期性任务。周期性任务使用方式和一次性任务类似，不过需要注意的是，周期性任务的时间间隔不能少于15分钟。

　　　　new PeriodicWorkRequest.Builder(Upload.class,15,TimeUnit.MINUTES).build();只需要做此修改，其他地方一样

　　8.任务链

　　　　如果有一系列的任务需要按顺序执行，那么可以利用WorkManager.beginWith().then().then()...enqueue();

WorkManager.getInstance(this)//先1后2
     .beginWith(firstWorkRequest)
     .then(secondWorkRequest)
     .enqueue();
or
WorkManager.getInstance(this)//先1和2；1和2不分先后，然后再3
    .beginWith(firstWorkRequest,secondWorkRequest)
    .then(thirdWorkRequest)
    .enqueue();