• 背景：通常我们在开发过程中处理后台任务的时候可能是自己维系一个线程池或者通过一个后台任务来完成我们的工作，然后对于某些特定的需求还需要自己进行网络条件，电量等信息的拦截判断处理。这个实现过程比较繁琐，而且每个类似的需求都写一套相同的逻辑就显得很累赘了。通过谷歌新推出的WorkManager SDK能很好的解决上述问题
• 原理：根据当前系统的API版本和当前应用的存活状态来选择对应的方式来执行任务，当应用在运行的时候，会在应用进程中开启一个子线程来执行任务，如果应用被杀掉了，WorkManager会根据当前系统API版本来选择是使用JobScheduler(API21)还是AlarmManager(API14-API20)来执行任务（具体的执行时机在某些国产系统上可能会发生变化）。
• 结论：对于可延时的执行的后台任务建议迁移到WorkManager上，节约APP的电量消耗（如日志上报等），而对于需要立刻执行的任务建议还是使用ThreadPool或者前台服务等

一、基本功能

• 1.1 运作流程

  • 通过WorkManager将Woker任务添加到任务队列中，在添加的过程中可以指定约束条件（充电状态、WIFI状态、手机存储空间等等）。只有当约束条件满足时才会执行我们的Worker。

• 1.2 Worker

  • 表示一个要执行的任务，我们需要继承并显示该类，并在doWork方法中实现我们自己的任务逻辑，通过不同的返回值表示当前Work的执行情况
    • Worker.Result.SUCCES 表示任务执行成功，如果有下一个任务会接着执行下一个任务
    • Worker.Result.FAILURE 表示任务执行失败，整个任务链就此中断
    • Worker.Result.RETRY 通过WorkManager根据重试策略尝试执行该任务

• 1.3 WorkRequest

  • Worker的包装类，最后添加到WorkManager中的就是当前WorkRequest对象，通过WorkRequest对象可以给我们的Worker附加额外的功能
    • 执行任务时的约束条件（电量、网络等）
    • 当Worker执行失败时的重试策略
    • 设置当前Worker的入参（执行任务时可携带额外的参数给Worker使用）
    • 设置当前Worker接受的入参合并策略（仅当上一个任务存在多个并行的Worker且返回相同的KEY时有作用，在下面的入参和出参模块会详细介绍）
  • 两个子类
    • OneTimeWorkRequest
    • PeriodicWorkRequest（下方模块有介绍）

• 1.4 WorkManager
  * 主要用来管理任务请求和任务队列，将Worker的包装者WorkRequest对象入队，同时还可以指定多个任务执行的先后顺序，实现串行或者并行的任务链。

• 1.5 Constraints（添加约束条件）

  • setRequiredNetworkType（设置网络相关的约束条件）
    • NetworkType.NOT_REQUIRED【对网络没有要求】
    • NetworkType.CONNECTED【网络连接】
    • NetworkType.UNMETERED【不计费的网络比如WIFI下执行】
    • NetworkType.NOT_ROAMING【非漫游网络状态】
    • NetworkType.METERED 【计费网络比如3G，4G下执行。】
  • setRequiresDeviceIdle （设置设备是否空闲）
  • setRequiresCharging（设置设备是否处于充电状态）
  • setRequiresBatteryNotLow（设备电量是否不应低于临界阀值）
  • setRequiresStorageNotLow（设备存储空间低于临界阀值）
  • addTriggerContentUri【API24】（对某个ContentUri的内容变化进行监听）
    • 通过内容提供者修改联系人，当联系人修改时，触发这个监听回调
      注：因为内容提供者的修改可能会短时间内多次调用，为了不影响监听线程，这里需要另起新的线程或者来执行

二、高级功能

• 2.1 任务类型
  • OneTimeWorkRequest 【只执行一次的任务】

    •   OneTimeWorkRequest myWorkRequest = new OneTimeWorkRequest.Builder(MyWorker.class).build();
      

  • PeriodicWorkRequest 【一定周期间隔内重复执行的任务】
    • 周期性任务，官方设定最短执行周期为15分钟，同时因为系统的优化策略，后面周期性的任务执行可能会有一定的时间延迟，无法做到精准时间执行。

  •    PeriodicWorkRequest build = new PeriodicWorkRequest.Builder(MyWorker.class, 25, TimeUnit.MILLISECONDS).build();
    

• 2.2 任务链
  • 串行链

    •   WorkManager.getInstance().beginWith(workRequestA)
            .then(workRequestB)
            .then(workRequestC)
            .enqueue()
      

    • 依次执行workRequestA ，workRequestB，workRequestC。每个阶段完成之后通过在doWork方法中返回Worker.Result.SUCCES来进入下一个workRequest。如果其中任何一个workRequest返回Worker.Result.FAILURE，那么后续的workRequest都不会执行了，就此中断
  • 并发链

    •  WorkManager.getInstance()
           .beginWith(workA1, workA2, workA3)
           .then(workB1, workB2)
           .then(workC1, workC2)
           .enqueue();
      

    • 首先并行执行workA1, workA2, workA3任务，等待这三个任务都执行完之后再并发执行workB1, workB2任务，等待着两个任务执行完毕之后再继续并发执行workC1, workC2任务。
  • 组合链

    •     //A,B任务链
          WorkContinuation continuationAB = WorkManager.getInstance().beginWith(requestA).then(requestB);
          //C,D任务链
          WorkContinuation continuationCD = WorkManager.getInstance().beginWith(requestC).then(requestD);
          // 对AB和CD进行组合
          WorkContinuation.combine(continuationAB, continuationCD).then(requestE).enqueue();
      

    • A/B串行执行，C/D串行执行，最后让A/B和C/D这两个组合任务并发执行。
• 2.3 任务标签
  • 作用：对WorkerRequest进行标签分组，同时还可以操作同一分组标签，比如取消该标签下的所有任务，或者获取该标签下的所有任务，然后查询各个任务现在的执行状态

  •  OneTimeWorkRequest cacheCleanupTask =new OneTimeWorkRequest.Builder(WorkerA.class)
          .addTag("groupA")
          .build();
    

• 2.4 任务参数传递
  • 作用：当我们在执行单个任务或者一个任务链的时候，我们可能需要将参数带入到第一个任务中，或者需要将第一个任务执行后的返回结果带入到第二个任务中。
  • 初始化任务时传递参数：

    •     Data workData = new Data.Builder() // Data大小需要控制在10k内
                   .putInt("NAME", "Android Develop") // 参数可以为任意类型
                   .putInt("AGE", 101)
                   .build();
          OneTimeWorkRequest workRequestA = new OneTimeWorkRequest.Builder(WorkerA.class)
                   .setInputData(workData)
                   .build();
          WorkManager.getInstance().enqueue(mathWork);
      

  • 将当前任务的执行结果传递给下一个任务

    •     public class MathWorker extends Worker {
             @Override
             public Worker.WorkerResult doWork() {
                 String sourceName = getInputData().getString("NAME", "");
                 int sourceAge = getInputData().getInt("AGE", 0);
                 int formatAge = sourceAge + 101;
                 Data output = new Data.Builder()
                      .putInt("AGE", formatAge)
                      .build();
                 setOutputData(output);
                 return WorkerResult.SUCCESS;
         }}
      

  • 多个相同参数来源的合并
    • 参数合并：当需要将多个任务的输出作为一个任务的输入时就会涉及到一个参数合并的问题，如果多个任务的输出中由好几个key都是一样的，那么需要由开发者自己来决定应该使用什么样的参数合并规则
    • 合并规则之ArrayCreatingInputMerger

      •  OneTimeWorkRequest workerRequestA = new OneTimeWorkRequest.Builder(WorkerA.class).setInputMerger(ArrayCreatingInputMerger.class).build();
        

      • 对于该合并规则来说，同一个的Key对应的Value都会放在一个数组中，数据会随着入参的增多而变大，对于下游任务想要获取数据的方法为getXXXArray()，如getIntArray();
    • 合并规则之OverwritingInputMerger

      • OneTimeWorkRequest workerRequestB = new OneTimeWorkRequest.Builder(WorkerA.class).setInputMerger(OverwritingInputMerger.class).build();
        

      • 顾名思义，后到的key-value会覆盖已存在的key-value
    • 自定义合并规则
      • 需要自定义类，然后继承抽象类InputMerger，覆写merge方法，实现自己的merge逻辑

三、存在的限制

• 周期任务最小时间间隔为15分钟
• 任务队列最大限制为100个
• 参数传递最大数据量为10kb