Jetpack之WorkManager 的链式调度

移动端团队 @ 奇舞团(360集团大前端团队)

简介

  • WorkManager 主要的能力: 可轻松调度那些即使在退出应用重启设备后仍然可以运行的可延期的异步任务,重点是可延期异步链式任务

  • 本篇侧重介绍Workmanager的异步的链式任务的调度上,至于可延期定时任务等更高级功能,我们后面再做分享

  • WorkManager device api Level 使用条件:

    如果设备在 API 级别 23 或更高级别上运行,系统会使用 JobScheduler。在 API 级别 14-22 上,系统会使用 GcmNetworkManager(如果可用),否则会使用自定义 AlarmManagerBroadcastReciever 实现作为备用

使用入门

  • gradle 引入
dependencies {
  def work_version = "2.5.0"
    // (Java only)
    implementation "androidx.work:work-runtime:$work_version"
    // Kotlin + coroutines
    implementation "androidx.work:work-runtime-ktx:$work_version"
    // optional - RxJava2 support
    implementation "androidx.work:work-rxjava2:$work_version"
    // optional - GCMNetworkManager support
    implementation "androidx.work:work-gcm:$work_version"
    // optional - Test helpers
    androidTestImplementation "androidx.work:work-testing:$work_version"
    // optional - Multiprocess support
    implementation "androidx.work:work-multiprocess:$work_version"
  }
复制代码
import android.content.Context;
import android.util.Log;

import androidx.annotation.NonNull;
import androidx.work.Worker;
import androidx.work.WorkerParameters;

/**
 		* Created by caining on 2021/5/24 14:28
   */
   public class WorkA extends Worker {
   public WorkA(@NonNull Context context, @NonNull WorkerParameters workerParams) {
       super(context, workerParams);
   }

   @NonNull
   @Override
   public Result doWork() {
       long millis = System.currentTimeMillis();
       try {
           Thread.sleep(1000);
       } catch (InterruptedException ignore) {
           return Result.failure();
       }
       long end = System.currentTimeMillis();
       Log.i("Work--------> ", "\nA开始时间:" + millis + "----执行时间:" + String.valueOf(end - millis)+ "----结束时间:" +end);
       return Result.success();
   }
   }
复制代码
  • Work 工作的状态&&dowork return

    • Result.success():工作成功完成。
    • Result.failure():工作失败。
    • Result.retry():工作失败,应根据其重试政策在其他时间尝试。
    • 可以用WorkInfo.State.isFinished() 判断完成状态
    image-20210525102439894

链式调度示例

  • 我们看这样一个链式任务的实例:
image-20210524161909979
  • WorkA-WorkB-WorkC-WorkD-WorkE 都采用就简单extends Work方式,和上面例子中的WorkA类似
  • 创建OneTimeWorkRequest
OneTimeWorkRequest requestWorkA = new OneTimeWorkRequest.Builder(WorkA.class).build();
OneTimeWorkRequest requestWorkB = new OneTimeWorkRequest.Builder(WorkB.class).build();
OneTimeWorkRequest requestWorkC = new OneTimeWorkRequest.Builder(WorkC.class).build();
OneTimeWorkRequest requestWorkD = new OneTimeWorkRequest.Builder(WorkD.class).build();
OneTimeWorkRequest requestWorkE = new OneTimeWorkRequest.Builder(WorkE.class).build();
复制代码
  • 链式调度 示例1:
  /**
         A       B       C
         |       |       | 
         +-------+-------+
                 |
                 D
     */
WorkManager.getInstance(MainActivity.this)
        .beginWith(Arrays.asList(requestWorkA, requestWorkB, requestWorkC))
        .then(requestWorkD)
        .enqueue();

/**
	example1:执行结果如下
  I/Work-------->: A开始时间:1621843840447----执行时间:1000----结束时间:1621843841447
  I/Work-------->: B开始时间:1621843840448----执行时间:2001----结束时间:1621843842449
  I/Work-------->: C开始时间:1621843840456----执行时间:3000----结束时间:1621843843456
  I/Work-------->: D开始时间:1621843843539----执行时间:1000----结束时间:1621843844539
*/
复制代码

从时间结果可以看出 执行顺序是 abc 同时开始,执行结束后执行D 任务,符合流程图所执行的链式任务

  • 链式调度 示例2,利用WorkContinuation.combine 合并任务

  • 我们可以实现如下流程链式任务:

image-20210524172851974
    /**
         A       B   D
         |       |   |
         +-------+   |
             |       |
             C       |
             |       |
             +-------+
                 |
                 E
      `WorkContinuation.combine` 合并混合两个任务
     */

WorkManager workManager = WorkManager.getInstance(MainActivity.this);
WorkContinuation firstABC = workManager.beginWith(Arrays.asList(requestWorkA,requestWorkB)).then(requestWorkC);
WorkContinuation dWork = workManager.beginWith(requestWorkD);
WorkContinuation.combine(Arrays.asList(firstABC, dWork)).then(requestWorkE).enqueue();
复制代码
I/Work-------->: A开始时间:1621848348002----执行时间:1000----结束时间:1621848349002
I/Work-------->: D开始时间:1621848348003----执行时间:1000----结束时间:1621848349003
I/Work-------->: B开始时间:1621848348003----执行时间:2000----结束时间:1621848350003
I/Work-------->: C开始时间:1621848350132----执行时间:3000----结束时间:1621848353132
I/Work-------->: E开始时间:1621848353314----执行时间:1000----结束时间:1621848354314
复制代码
  • 链式调度 示例3:
image-20210525171116083
/**
         A       C
         |       |
         B       D
         |       |
         +-------+
             |
             E
     */
WorkManager workManager = WorkManager.getInstance(MainActivity.this);
WorkContinuation left = workManager.beginWith(requestWorkA).then(requestWorkB);
WorkContinuation right = workManager.beginWith(requestWorkC).then(requestWorkD);
WorkContinuation finalWork = WorkContinuation.combine(Arrays.asList(left, right)).then(requestWorkE);
finalWork.enqueue();
/**
    I/Work-------->: A开始时间:1621934646458----执行时间:1000----结束时间:1621934647458
    I/Work-------->: C开始时间:1621934646459----执行时间:3000----结束时间:1621934649459
    I/Work-------->: B开始时间:1621934647541----执行时间:2001----结束时间:1621934649542
    I/Work-------->: D开始时间:1621934649539----执行时间:1000----结束时间:1621934650539
    I/Work-------->: E开始时间:1621934650703----执行时间:1001----结束时间:1621934651704
*/
复制代码

数据传递

  • 数据传递流程如下
image-20210526104616469
//step 1 
Data myData = new Data.Builder()
                .putString("input", "123")
                .build();
复制代码
//step 2
new OneTimeWorkRequest.Builder(AWorker.class).setInputData(myData).build();
复制代码
 //step 3 >AWorker
@NonNull
    @Override
    public Result doWork() {
        String input = getInputData().getString("input");
    		Data output = new Data.Builder()
                .putString("output", "456")
                .build();
        return Result.success(output);
    }
复制代码
//step4
manager.getWorkInfoByIdLiveData(requestWorkA.getId()).observe(activity, new Observer<WorkInfo>() {
            @Override
            public void onChanged(WorkInfo workInfo) {
                if (workInfo != null && workInfo.getState().isFinished()) {
                    try {
                        output = workInfo.getOutputData().getString("output");
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                    MLogger.i("outPut--->" + output);
                }

            }
        });
复制代码

input合并器

WorkManager 提供两种不同类型的 InputMerger

总结

  • WorkManager在异步的链式调度上使用起来非常方便,能快速的实现我们不同任务的执行顺序
  • WorkManager在传数据上,类似Intent ,key-value形式,传送方便
  • WorkManager拥有其他高级功能,比如定时任务等

引用

文章分类
Android