標籤:android
在Android 5.0中使用JobScheduler
- 原文連結 : using-the-jobscheduler-api-on-android-lollipop
- 譯者 : Mr.Simple
- 校對者 : Mr.Simple
在這篇文章中,你會學習到在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,當你點擊了建立項目的完成按鈕之後,你會得到一個”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)方法。
@Overridepublic boolean onStartJob(JobParameters params) { mJobHandler.sendMessage( Message.obtain( mJobHandler, 1, params ) ); return true;}@Overridepublic 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。掌握了這些之後,你可以在減少資源消耗的同時提升應用的效率。
更多文章
更多優秀文章請猛擊android-tech-frontier。
在Android 5.0中使用JobScheduler