在 Android 5.0 中使用 JobScheduler

Question

在这篇文章中，你会学习到在 Android 5.0 中如何使用 JobScheduler API。JobScheduler API 允许开发者在符合某些条件时创建执行在后台的任务。

介绍

在 Android 开发中，会存在这么些场景 : 你需要在稍后的某个时间点或者当满足某个特定的条件时执行一个任务，例如当设备接通电源适配器或者连接到 WIFI。幸运的是在 API 21 ( Android 5.0，即 Lollipop ) 中，google 提供了一个叫做 JobScheduler API 的新组件来处理这样的场景。

当一系列预置的条件被满足时，JobScheduler API 为你的应用执行一个操作。与 AlarmManager 不同的是这个执行时间是不确定的。除此之外，JobScheduler API 允许同时执行多个任务。这允许你的应用执行某些指定的任务时不需要考虑时机控制引起的电池消耗。

这篇文章中，你会学到关于 JobScheduler API 更多的东西以及在你的应用中用于运行一个简单的后台任务的 JobService，这篇文章中所展示的代码你都可以在 github 中找到。

1. 创建 Job Service

首先，你需要创建一个 API 最低为 21 的 Android 项目，因为 JobScheduler 是最近的版本才加入 Android 的，在写这篇文章的时候，它还没有兼容库支持。（译者注：截止目前已知一个兼容库 JobSchedulerCompat ）

假定你使用的是 Android Studio,当你点击了创建项目的完成按钮之后，你会得到一个"hello world"的应用骨架。你要做的第一步就是创建一个新的 java 类。为了简单起见，让我们创建一个继承自 JobService 且名字为 JobSchedulerService 的类，这个类必须实现两个方法，分别是 onStartJob(JobParameters params) 和 onStopJob(JobParameters params) ；

public class JobSchedulerService extends JobService {
 
  @Override
  public boolean onStartJob(JobParameters params) {
 
    return false;
  }
 
  @Override
  public boolean onStopJob(JobParameters params) {
     
    return false;
  }
}

当任务开始时会执行 onStartJob(JobParameters params) 方法，因为这是系统用来触发已经被执行的任务。正如你所看到的，这个方法返回一个 boolean 值。如果返回值是 false,系统假设这个方法返回时任务已经执行完毕。如果返回值是 true,那么系统假定这个任务正要被执行，执行任务的重担就落在了你的肩上。当任务执行完毕时你需要调用 jobFinished(JobParameters params, boolean needsRescheduled) 来通知系统。

当系统接收到一个取消请求时，系统会调用 onStopJob(JobParameters params) 方法取消正在等待执行的任务。很重要的一点是如果 onStartJob(JobParameters params) 返回 false,那么系统假定在接收到一个取消请求时已经没有正在运行的任务。换句话说， onStopJob(JobParameters params) 在这种情况下不会被调用。

需要注意的是这个 job service 运行在你的主线程，这意味着你需要使用子线程，handler, 或者一个异步任务来运行耗时的操作以防止阻塞主线程。因为多线程技术已经超出了我们这篇文章的范围，让我们简单实现一个 Handler 来执行我们在 JobSchedulerService 定义的任务吧。

private Handler mJobHandler = new Handler( new Handler.Callback() {
   
  @Override
  public boolean handleMessage( Message msg ) {
    Toast.makeText( getApplicationContext(), 
      "JobService task running", Toast.LENGTH_SHORT )
      .show();
    jobFinished( (JobParameters) msg.obj, false );
    return true;
  }
   
} );

在 Handler 中，你需要实现 handleMessage(Message msg) 方法来处理你的任务逻辑。在这个例子中，我们尽量保证例子简单，因此我们只在 handleMessage(Message msg) 中显示了一个 Toast，这里就是你要写你的任务逻辑( 耗时操作 ) 的地方，比如同步数据等。

当任务执行完毕之后，你需要调用 jobFinished(JobParameters params, boolean needsRescheduled) 来让系统知道这个任务已经结束，系统可以将下一个任务添加到队列中。如果你没有调用 jobFinished(JobParameters params, boolean needsRescheduled) ，你的任务只会执行一次，而应用中的其他任务就不会被执行。

jobFinished(JobParameters params, boolean needsRescheduled) 的两个参数中的 params 参数是从 JobService 的 onStartJob(JobParameters params) 的 params 传递过来的，needsRescheduled 参数是让系统知道这个任务是否应该在最初的条件下被重复执行。这个 boolean 值很有用，因为它指明了你如何处理由于其他原因导致任务执行失败的情况，例如一个失败的网络请求调用。

创建了 Handler 实例之后，你就可以实现 onStartJob(JobParameters params) 和 onStopJob(JobParameters params) 方法来控制你的任务了。你可能已经注意到在下面的代码片段中 onStartJob(JobParameters params) 返回了 true。这是因为你要通过 Handler 实例来控制你的操作，这意味着 Handler 的 handleMessage 方法的执行时间可能比 onStartJob(JobParameters params) 更长。返回 true,你会让系统知道你会手动地调用 jobFinished(JobParameters params, boolean needsRescheduled) 方法。

@Override
public boolean onStartJob(JobParameters params) {
  mJobHandler.sendMessage( Message.obtain( mJobHandler, 1, params ) );
  return true;
}
 
@Override
public boolean onStopJob(JobParameters params) {
  mJobHandler.removeMessages( 1 );
  return false;
}

一旦你在 Java 部分做了上述工作之后，你需要到 AndroidManifest.xml 中添加一个 service 节点让你的应用拥有绑定和使用这个 JobService 的权限。

<service android:name=".JobSchedulerService"
  android:permission="android.permission.BIND_JOB_SERVICE" />

2. 创建一个 JobScheduler 对象

随着 JobSchedulerService 构建完毕，我们可以开始研究你的应用如何与 JobScheduler API 进行交互了。第一件要做的事就是你需要创建一个 JobScheduler 对象，在实例代码的 MainActivity 中我们通过 getSystemService( Context.JOB_SCHEDULER_SERVICE ) 初始化了一个叫做 mJobScheduler 的 JobScheduler 对象。

mJobScheduler = (JobScheduler) 
  getSystemService( Context.JOB_SCHEDULER_SERVICE );

当你想创建定时任务时，你可以使用 JobInfo.Builder 来构建一个 JobInfo 对象，然后传递给你的 Service。JobInfo.Builder 接收两个参数，第一个参数是你要运行的任务的标识符，第二个是这个 Service 组件的类名。

JobInfo.Builder builder = new JobInfo.Builder( 1,
    new ComponentName( getPackageName(), 
      JobSchedulerService.class.getName() ) );

这个 builder 允许你设置很多不同的选项来控制任务的执行。下面的代码片段就是展示了如何设置以使得你的任务可以每隔三秒运行一次。

builder.setPeriodic( 3000 );

其他设置方法 :

• setMinimumLatency(long minLatencyMillis): 这个函数能让你设置任务的延迟执行时间（单位是毫秒),这个函数与 setPeriodic(long time) 方法不兼容，如果这两个方法同时调用了就会引起异常；
• setOverrideDeadline(long maxExecutionDelayMillis):
  这个方法让你可以设置任务最晚的延迟时间。如果到了规定的时间时其他条件还未满足，你的任务也会被启动。与 setMinimumLatency(long time) 一样，这个方法也会与 setPeriodic(long time) 不兼容，同时调用这两个方法会引发异常。
• setPersisted(boolean isPersisted):
  这个方法告诉系统当你的设备重启之后你的任务是否还要继续执行。
• setRequiredNetworkType(int networkType):
  这个方法让你这个任务只有在满足指定的网络条件时才会被执行。默认条件是 JobInfo.NETWORK_TYPE_NONE，这意味着不管是否有网络这个任务都会被执行。另外两个可选类型，一种是 JobInfo.NETWORK_TYPE_ANY，它表明需要任意一种网络才使得任务可以执行。另一种是 JobInfo.NETWORK_TYPE_UNMETERED，它表示设备不是蜂窝网络( 比如在 WIFI 连接时 ) 时任务才会被执行。
• setRequiresCharging(boolean requiresCharging):
  这个方法告诉你的应用，只有当设备在充电时这个任务才会被执行。
• setRequiresDeviceIdle(boolean requiresDeviceIdle):
  这个方法告诉你的任务只有当用户没有在使用该设备且有一段时间没有使用时才会启动该任务。

需要注意的是 setRequiredNetworkType(int networkType) , setRequiresCharging(boolean requireCharging) 以及 setRequiresDeviceIdle(boolean requireIdle) 这几个方法可能会使得你的任务无法执行，除非调用 setOverrideDeadline(long time) 设置了最大延迟时间，使得你的任务在未满足条件的情况下也会被执行。一旦你预置的条件被设置，你就可以构建一个 JobInfo 对象，然后通过如下所示的代码将它发送到你的 JobScheduler 中。

if( mJobScheduler.schedule( builder.build() ) <= 0 ) {
  //If something goes wrong
}

你可能注意到了，这个 schedule 方法会返回一个整型。如果 schedule 方法失败了，它会返回一个小于 0 的错误码。否则它会返回我们在 JobInfo.Builder 中定义的标识 id。

如果你的应用想停止某个任务，你可以调用 JobScheduler 对象的 cancel(int jobId) 来实现；如果你想取消所有的任务，你可以调用 JobScheduler 对象的 cancelAll() 来实现。

mJobScheduler.cancelAll();

到了这里，你现在应该已经知道如何在你的应用中使用 JobScheduler API 来执行批量任务和后台操作了。

结论

这篇文章中，你学会了怎么实现一个使用 Handler 对象来运行后台任务的 JobService 子类，你也学会了如何使用 JobInfo.Builder 来设置 JobService。掌握了这些之后，你可以在减少资源消耗的同时提升应用的效率。