我们先看一下JobScheduler的使用,了解一下JobScheduler的用法,在看一下JobScheduler的实现源码。
先看一下如何使用,翻译自tutsplus
JobScheduler允许开发者创建在后台执行的job,当预置的条件被满足时,这些Job将会在后台被执行。
在Android开发中,我们会遇到很多这样的情况,比如在未来的某个时间点或者未来满足某种条件(比如插入电源或者连接WiFi)的情况下下去执行一些操作。在Android L上,Google提供了一个叫做JobScheduler的组件来帮助我们处理这种情况。
JobScheduler Api可以在我们的App中执行一些操作,这些操作将会在我们预置的一些条件被满足的时候被执行。和AlarmManager
不一样,执行这些操作的时间并不是严格准确的。 JobScheduler会把一系列的job收集起来一起执行,这样既允许我们的job被执行,又能兼顾到手机电量的使用情况,达到节电的目的。
如何使用JobScheduler Api
- 创建JobService
首先要确保我们创建的App最小支持的SDK在Android L以上,因为到目前为止,还没有兼容包来提供这个功能。
在我们的工程中写一个继承与JobService
的Service(比如叫JobSchedulerService),这个Service提供了两个回调方法,一个是onStartJob(JobParameters params)
和onStopJob(JobParameters params)
。
public class JobSchedulerService extends JobService{
@Overrid
public boolean onStartJob(JobParameters params){
return false;
}
@Override
public boolean onStopJob(JobParameters params){
return false;
}
}
- onStartJob
当系统要触发执行我们的Job的时候,会调用onStartJob
方法。这个方法会返回一个布尔型的值。
当返回false
的时候,系统会认为onStartJob
这个方法返回的时候,我们要做的工作已经做完了,这不是一个耗时的工作。
当返回true
的时候,系统会认为我们要执行一个耗时的工作,在onStartJob
这个方法返回的时候,我们的工作仍然在异步执行。当我们的工作执行完成的时候,我们必须手动调用jobFinished(JobParameters params, boolean needRescheduled)
务必要注意,如果onStartJob
返回了true,在异步工作执行完成之后,我们必须手动调用jobFinished
方法,如果不调用jobFinished
,系统会一直认为我们在执行当前Job,那么系统就不会再入队其他的Job去执行,也就是说JobScheduler的执行队列就会被阻塞了
- onStopJob
当系统收到一个cancel job的请求时,并且这个job仍然在执行,系统就会调用onStopJob
方法。
也就是说在系统受到取消请求时,并不会一定会调用onStopJob
方法,只有onStartJob
返回true
的时候,才会调用onStopJob
,否则不调用。
但不论是否调用onStopJob
方法,系统受到取消请求时,都会取消该job(具体怎么取消,在讲源码的时候在分析).
需要注意的是,JobService是运行在我们应用的主线程,这意味着我们需要开启新线程或者使用Handler或者AsyncTask来处理耗时的工作。
为了简单起见,下面的代码使用了一个Handler
来处理耗时工作,并且在处理的耗时工作也仅仅是弹出一个Toast.
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方法。
//当onStartJob返回true的时候,我们必须手动调用jobFinished方法
//否则该应用中的其他job将不会被执行
jobFinished( (JobParameters) msg.obj, false );
return true;
}
} );
jobFinished(JobParameters params, boolean needRescheduled)
中的两个参数,第一个参数JobParameter来自于onStartJob(JobParameters params)
中的params,这也说明了如果我们想要在onStartJob
中执行异步操作,必须要保存下来这个JobParameter
。
接下来我们改造一下原来的onStartJob
和onStopJob
,
@Override
public boolean onStartJob(JobParameters params) {
//这里我们启用一个Handler来模拟耗时操作
//注意到我们在使用Hanlder的时候把传进来的JobParameters保存下来了
mJobHandler.sendMessage( Message.obtain( mJobHandler, 1, params ) );
//注意这里我们返回了true,因为我们要做耗时操作。
//返回true意味着耗时操作花费的事件比onStartJob执行的事件更长
//并且意味着我们会手动的调用jobFinished方法
return true;
}
@Override
public boolean onStopJob(JobParameters params) {
mJobHandler.removeMessages( 1 );
return false;
}
要使该JobScheduler能够正常工作,必须在AndroidManifest.xml中注册,并声明权限
<service android:name=".JobSchedulerService"
android:permission="android.permission.BIND_JOB_SERVICE" />
- 创建JobScheduler
要使用我们创建的JobService,我们必须系统的JobScheduler服务,如下
mJobScheduler = (JobScheduler)
getSystemService( Context.JOB_SCHEDULER_SERVICE );
然后使用JobInfo.Builder来设置我们JobScheduler的触发条件
//Builder构造方法接收两个参数,第一个参数是jobId,每个app或者说uid下不同的Job,它的jobId必须是不同的
//第二个参数是我们自定义的JobService,系统会回调我们自定义的JobService中的onStartJob和onStopJob方法
JobInfo.Builder builder = new JobInfo.Builder( 1,
new ComponentName( getPackageName(),
JobSchedulerService.class.getName() ) );
//指定每三秒钟重复执行一次
builder.setPeriodic( 3000 );
JobInfo.Builder可以设置很多参数,但是有一些参数是互斥的,同时设置了之后会抛出异常,下面详细说明一下:
setMinimumLatency(long minLatencyMillis)
:这个方法指定我们的Job至少要多少毫秒之后执行,比如setMinimumLatency(5000)
,就表明我们这是了这个JobScheduler之后,这个Job至少要5秒之后执行,前五秒肯定是不会执行的。这个参数和setPeriodic
互斥。两个同时设置会抛出异常。
setOverrideDeadline(long maxExecutionDelayMillis)
:这个方法指定我们的Job在某段时间之后必须执行,即使设置的其他条件不满足(比如我们还设置了要求充电,连接wifi等条件)。这是一个严格准时的执行,比如setOverrideDeadline(5000)
就表明这个Job在第五秒的时候会准时执行,而忽略其他的条件。这个方法也和setPerioidc
互斥。
setPersisted(boolean isPersisted)
:来设置是否重启之后继续schedule该Job
setRequiredNetworkType(int networkType)
:来启动我们这个Job时所需要的网络类型,一共有三个值JobInfo.NETWORK_TYPE_NONE
表明启动我们这个Job时不需要任何的网络连接;JobInfo.NETWORK_TYPE_ANY
表明启动我们这个Job时只要连着网就可以,不要求网络类型。JobInfo.NETWORK_TYPE_UNMETERED
表明启动我们这个Job时需要连接Wifi.
setRequiresCharging(boolean requiresCharging)
来表示启动我们这个Job时是否需要连接电源
setRequiresDeviceIdle(boolean requiresDeviceIdle)
:来表示启动我们这个Job时是否需要机器处于空闲状态。
务必要注意,同时使用setRequiredNetworkType(int networkType)
, setRequiresCharging(boolean requireCharging)
和setRequiresDeviceIdle(boolean requireIdle)
这三个条件,可能导致我们的Job永远都不会执行。这个时候我们需要setOverrideDeadline(long time)
来确保我们的Job肯定能被执行一次
当以上两步都执行完毕之后,我们就可以schedule我们的Job了
if( mJobScheduler.schedule( builder.build() ) <= 0 ) {
//If something goes wrong
}
JobScheduler
的schedule
方法返回一个整型。当schedule失败的时候会返回一个负数,成功的时候会返回我们在创建JobInfo.Builder
时传入的JobId.
JobScheduler提供了两个方法来取消Job,一个是cancel(int jobId)
,该方法取消指定的Job,一个是cancelAll
来取消所有的Job。
这就是JobScheduler大致的使用流程,下一篇会分析一下JobScheduler的源码。