Android ジョブのスケジューラ

このガイドでは、Android ジョブスケジューラ API を利用し、バックグラウンド作業をスケジュールする方法について説明します。この API は、Android 5.0 (API レベル 21) 以降を実行している Android デバイスで利用できます。

概要

ユーザーに対する Android アプリケーションのよい応答性を維持するための最善の方法の 1 つは、複雑な処理や長時間実行される処理がバックグラウンドで実行されるようにすることです。ただし、バックグラウンド処理がデバイスのユーザーエクスペリエンスに悪影響を及ぼさないようにすることが重要です。

たとえば、バックグラウンドジョブでは、3 または 4 分ごとに Web サイトをポーリングして、特定のデータセットへの変更が照会されることがあります。これは問題ないように思えますが、バッテリの寿命に大きな影響があります。アプリケーションにより、繰り返し、デバイスがウェイクアップされ、CPU が高い電力状態に引き上げられて、無線の電源が入れられ、ネットワーク要求が行われて、結果が処理されます。デバイスの電源がすぐに切れて、低電力のアイドル状態に戻ることはないため、この状態はいっそう悪くなります。バックグラウンド処理が適切にスケジュールされていないと、デバイスが不必要で過剰な電力要件の状態のままになる可能性があります。この一見無害なアクティビティ (Web サイトのポーリング) により、比較的短い時間でデバイスが使用できなくなります。

Android には、バックグラウンドでの処理の実行に役立つ次の API が用意されていますが、それだけではインテリジェントなジョブのスケジュール設定には不十分です。

Intent Services - Intent Services は、処理の実行には適していますが、作業のスケジュールを設定する方法はありません。
AlarmManager - これらの API では、処理のスケジュールを設定することだけができ、実際に処理を実行する方法はありません。また、AlarmManager では時間ベースの制約のみが可能です。これは、特定の時刻または特定の時間経過後にアラームを発生させることを意味します。
ブロードキャストレシーバー - Android アプリでは、システム全体のイベントまたはインテントに応答して処理を実行するように、ブロードキャストレシーバーを設定できます。ただし、ブロードキャストレシーバーでは、ジョブをいつ実行するかを制御することはできません。また、Android オペレーティングシステムでの変更によって、ブロードキャストレシーバーが動作するタイミングや、応答できる処理の種類が制限されます。

バックグラウンド処理を ("バックグラウンドジョブ" または "ジョブ" とも呼ばれます) を効率的に実行するには、次の 2 つの重要な機能があります。

処理のインテリジェントなスケジュール設定 - バックグラウンドで処理を行うアプリケーションが善良に振る舞うことが重要です。理想的には、アプリケーションでジョブの実行を要求しないようにする必要があります。代わりに、アプリケーションでは、ジョブを実行するために満たす必要がある条件を指定し、条件が満たされたときに作業を実行するオペレーティングシステムでそのジョブのスケジュールを設定してください。これによって、Android では、デバイスで効率性が最大化されるようにジョブを実行できます。たとえば、ネットワーク要求をバッチ処理してすべてを同時に実行し、ネットワーク関連のオーバーヘッドを最大限に利用することができます。
処理のカプセル化 - バックグラウンド処理を実行するコードは、ユーザーインターフェイスとは関係なく実行できる個別のコンポーネントにカプセル化する必要があります。それにより、何らかの理由で処理を完了できなかった場合でも、比較的簡単にスケジュールを再設定できます。

Android ジョブスケジューラは Android オペレーティングシステムに組み込まれるフレームワークであり、バックグラウンド作業のスケジュールを簡単にする fluent API を提供します。 Android ジョブスケジューラは、次の種類で構成されています。

Android.App.Job.JobScheduler は、Android アプリケーションの代わりにジョブをスケジュール、実行、必要に応じてキャンセルするシステムサービスです。
Android.App.Job.JobService は抽象クラスであり、アプリケーションのメインスレッドでジョブを実行するロジックで拡張する必要があります。つまり、作業の非同期実行は JobService が担います。
Android.App.Job.JobInfo オブジェクトには、ジョブを実行する必要があるとき、Android を誘導するための条件が保持されます。

Android ジョブスケジューラで作業をスケジュールするには、Xamarin.Android アプリケーションで、JobService クラスを拡張するクラスでコードをカプセル化する必要があります。 JobService には、ジョブの有効期間中に呼び出すことができるライフサイクルメソッドが 3 つあります。

bool OnStartJob(JobParameters パラメーター) – このメソッドは作業を実行する JobScheduler によって呼び出され、アプリケーションのメインスレッドで実行されます。作業を非同期で実行すること、作業が残っている場合に true を返すこと、作業が完了している場合に false を返すことは JobService が行います。

JobScheduler はこのメソッドを呼び出すと、Android に wakelock を要求し、ジョブの間保持します。ジョブが完了したら、JobFinished メソッドを呼び出し、この事実を JobScheduler に伝えるのは JobService が行います (次で説明します)。
JobFinished(JobParameters parameters, bool needsReschedule) – このメソッドは、作業が完了していることを JobScheduler に伝える目的で JobService によって呼び出される必要があります。 JobFinished が呼び出されない場合、JobScheduler は wakelock を削除しないため、不必要にバッテリを消費します。
bool OnStopJob(JobParameters パラメーター) – ジョブが Android によって途中で停止されたときにこれが呼び出されます。再試行条件に基づき、ジョブをスケジュールし直す必要がある場合、true を返す必要があります (詳細は次で説明します)。

ジョブを実行できる、あるいはジョブを実行する必要があるタイミングを制御する "制約" または "トリガー" を指定できます。たとえば、デバイスの充電中にのみ実行されるようにジョブを制約したり、写真を撮ったときにジョブが開始されるようにすることができます。

このガイドでは、JobService クラスを実装し、JobScheduler でそれをスケジュールする方法について詳しく説明します。

要件

Android ジョブスケジューラには、Android API レベル 21 (Android 5.0) 以降が必要です。

Android ジョブスケジューラの使用

Android ジョブスケジューラ API は 3 つの手順で使用します。

JobService 型を実装し、作業をカプセル化します。
JobInfo.Builder オブジェクトを使用することで、JobScheduler でジョブを実行するための条件を保持する JobInfo オブジェクトを作成します。
JobScheduler.Schedule を使用してジョブをスケジュールします。

JobService を実装する

Android ジョブスケジューラライブラリによって実行されるすべての処理は、Android.App.Job.JobService 抽象クラスを拡張する型で実行される必要があります。 JobService の作成は、Android フレームワークでの Service の作成とよく似ています。

JobService クラスを拡張します。
サブクラスを ServiceAttribute で修飾し、パッケージ名とクラス名で構成された文字列に Name パラメーターを設定します (次の例を参照)。
ServiceAttribute の Permission プロパティを文字列 android.permission.BIND_JOB_SERVICE に設定します。
OnStartJob メソッドをオーバーライドし、作業を実行するコードを追加します。 Android では、ジョブを実行するアプリケーションのメインスレッドでこのメソッドを呼び出します。アプリケーションがブロックされることを回避するため、数ミリ秒以上かかる作業はスレッドで実行しなければなりません。
作業が完了したら、JobService で JobFinished メソッドを呼び出す必要があります。このメソッドによって、作業が完了したことが JobService から JobScheduler に伝えられます。 JobFinished を呼び出さないと、JobService によってデバイスに不要な要求が行われ、バッテリの耐用年数を減らします。
OnStopJob メソッドをオーバーライドすることもお勧めします。このメソッドは、ジョブが終了前にシャットダウンになると呼び出され、リソースを正しく破棄する機会を JobService に与えます。このメソッドは、ジョブを再スケジュールする必要がある場合に true を返し、ジョブの再実行が望まれない場合に false を返すようにします。

次のコードは、TPL を使用して何らかの処理を非同期に実行する、アプリケーションに対する最も簡単な JobService の例です。

[Service(Name = "com.xamarin.samples.downloadscheduler.DownloadJob", 
         Permission = "android.permission.BIND_JOB_SERVICE")]
public class DownloadJob : JobService
{
    public override bool OnStartJob(JobParameters jobParams)
    {            
        Task.Run(() =>
        {
            // Work is happening asynchronously
                      
            // Have to tell the JobScheduler the work is done. 
            JobFinished(jobParams, false);
        });

        // Return true because of the asynchronous work
        return true;  
    }

    public override bool OnStopJob(JobParameters jobParams)
    {
        // we don't want to reschedule the job if it is stopped or cancelled.
        return false; 
    }
}

ジョブをスケジュールするための JobInfo の作成

Xamarin.Android アプリケーションでは、JobService を直接インスタンス化することがありません。代わりに、JobInfo オブジェクトが JobScheduler に渡されます。 JobScheduler によって、要求された JobService オブジェクトがインスタンス化され、JobInfo のメタデータに基づいて JobService をスケジュールし、実行します。 JobInfo オブジェクトには次の情報が含まれる必要があります。

JobId – これは JobScheduler にジョブ ID を知らせる int 値です。この値を再利用すると、既存のジョブがすべて更新されます。この値は、アプリケーションで一意にする必要があります。
JobService – このパラメーターは、ジョブを実行するために JobScheduler で使用する型を明示的に識別する ComponentName です。

この拡張メソッドは、アクティビティなど、Android Context で JobInfo.Builder を作成する方法を示しています。

public static class JobSchedulerHelpers
{
    public static JobInfo.Builder CreateJobBuilderUsingJobId<T>(this Context context, int jobId) where T:JobService
    {
        var javaClass = Java.Lang.Class.FromType(typeof(T));
        var componentName = new ComponentName(context, javaClass);
        return new JobInfo.Builder(jobId, componentName);
    }
}

// Sample usage - creates a JobBuilder for a DownloadJob and sets the Job ID to 1.
var jobBuilder = this.CreateJobBuilderUsingJobId<DownloadJob>(1);

var jobInfo = jobBuilder.Build();  // creates a JobInfo object.

Android ジョブスケジューラの強力な機能として、ジョブを実行するタイミングや、ジョブが実行される条件を制御できます。次の表には JobInfo.Builder で使用されるメソッドの一部を掲載していますが、これらのメソッドを使用することで、ジョブを実行できるタイミングをアプリで制御できます。

Method	説明
`SetMinimumLatency`	ジョブを実行するまでの待機時間 (ミリ秒単位) を指定します。
`SetOverridingDeadline`	この時間 (ミリ秒単位) が経過する前にジョブを実行する必要があることを宣言します。
`SetRequiredNetworkType`	ジョブのネットワーク要件を指定します。
`SetRequiresBatteryNotLow`	このジョブは、デバイスからユーザーに "バッテリ低下" 警告が表示されていないときにのみ実行できます。
`SetRequiresCharging`	ジョブは、バッテリが充電中のときにのみ実行できます。
`SetDeviceIdle`	ジョブは、デバイスがビジー状態のときに実行されます。
`SetPeriodic`	ジョブを定期的に実行するように指定します。
`SetPersisted`	デバイスを再起動してもジョブは存続します。

SetBackoffCriteria からは、ジョブの再実行を試行する前に JobScheduler に待機する時間についていくつかの指示が与えられます。バックオフ条件には 2 つの部分があります。ミリ秒単位で指定される遅延 (既定値は 30 秒) と使用すべきバックオフの種類です ("バックオフポリシー" や "再試行ポリシー" と呼ばれることがあります)。この 2 つのポリシーは Android.App.Job.BackoffPolicy 列挙型にカプセル化されます。

BackoffPolicy.Exponential - エクスポネンシャルバックオフポリシーでは、失敗するたびに、初期バックオフ値が指数的に増加します。ジョブが初めて失敗したときは、ライブラリは、指定されている初回間隔だけ待ってからジョブを再スケジュールします (たとえば 30 秒)。ジョブが 2 回目に失敗した場合は、ライブラリはジョブの実行を試行する前に少なくとも 60 秒間待機します。 3 回目の試行が失敗すると、ライブラリは 120 秒待機します。以下同様です。これが既定値です。
BackoffPolicy.Linear - この戦略は直線的バックオフであり、ジョブの実行は (成功するまで) 設定された一定の間隔で再スケジュールされます。直線的バックオフは、可能な限り早く完了する必要がある処理や、短時間で自動的に解決される問題に最適です。

JobInfo オブジェクトの作成方法について詳しくは、JobInfo.Builder クラスに関する Google のドキュメントをお読みください。

JobInfo 経由でジョブにパラメーターを渡す

ジョブにパラメーターを渡すには、Job.Builder.SetExtras メソッドと共に渡される PersistableBundle を作成します。

var jobParameters = new PersistableBundle();
jobParameters.PutInt("LoopCount", 11);

var jobBuilder = this.CreateJobBuilderUsingJobId<DownloadJob>(1)
                     .SetExtras(jobParameters)
                     .Build();

PersistableBundle には、JobService の OnStartJob メソッドの Android.App.Job.JobParameters.Extras プロパティからアクセスします。

public override bool OnStartJob(JobParameters jobParameters)
{
    var loopCount = jobParams.Extras.GetInt("LoopCount", 10);
    
    // rest of code omitted
}

ジョブのスケジュール設定

ジョブをスケジュールするために、Xamarin.Android アプリケーションでは、JobScheduler システムサービスの参照を受け取り、前の手順で作成した JobInfo オブジェクトを指定して JobScheduler.Schedule メソッドを呼び出します。 JobScheduler.Schedule が直後に、2 つの整数値のいずれかと共に返されます。

JobScheduler.ResultSuccess – ジョブは正常にスケジュールされました。
JobScheduler.ResultFailure – ジョブはスケジュールできませんでした。これは通常、JobInfo パラメーターの競合で引き起こされます。

次のサンプルコードでは、ジョブをスケジュールし、スケジュール試行の結果をユーザーに通知しています。

var jobScheduler = (JobScheduler)GetSystemService(JobSchedulerService);
var scheduleResult = jobScheduler.Schedule(jobInfo);

if (JobScheduler.ResultSuccess == scheduleResult)
{
    var snackBar = Snackbar.Make(FindViewById(Android.Resource.Id.Content), Resource.String.jobscheduled_success, Snackbar.LengthShort);
    snackBar.Show();
}
else
{
    var snackBar = Snackbar.Make(FindViewById(Android.Resource.Id.Content), Resource.String.jobscheduled_failure, Snackbar.LengthShort);
    snackBar.Show();
}

ジョブの取り消し

JobsScheduler.CancelAll() メソッドまたは JobScheduler.Cancel(jobId) メソッドを使用して、スケジュール設定されたすべてのジョブまたは 1 つのジョブだけを取り消すことができます。

// Cancel all jobs
jobScheduler.CancelAll(); 

// to cancel a job with jobID = 1
jobScheduler.Cancel(1)

まとめ

このガイドでは、Android ジョブスケジューラを使用して、バックグラウンドで処理をインテリジェントに実行する方法について説明しました。ここでは、実行される処理を JobService としてカプセル化する方法、JobScheduler を使用してその処理のスケジュールを設定する方法、JobTrigger で条件を指定する方法、RetryStrategy でエラーを処理する方法について説明しました。

Last updated on 2018-03-19

次の方法で共有