Android 5.0中使用JobScheduler

时间:2022-04-15 21:54:58

在这篇文章中,你会学习到在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的,在写这篇文章的时候,它还没有兼容库支持。

假定你使用的是Android Studio,当你点击了创建项目的完成button之后,你会得到一个”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, 或者一个异步任务来运行耗时的操作以防止堵塞主线程。

由于多线程技术已经超出了我们这篇文章的范围。让我们简单实现一个Handlder来运行我们在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) and 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。

掌握了这些之后,你能够在降低资源消耗的同一时候提升应用的效率。