Firebase ジョブディスパッチャー

[アーティクル]
04/25/2024

このガイドでは、Google の Firebase ジョブディスパッチャーライブラリを使用して、バックグラウンド処理をスケジュールする方法について説明します。

概要

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

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

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

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

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

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

Google のライブラリである Firebase ジョブディスパッチャーでは、バックグラウンド処理のスケジュール設定を簡単にする fluent API が提供されています。これは、Google Cloud Manager の代わりになるものです。 Firebase ジョブディスパッチャーは、次の API で構成されています。

Firebase.JobDispatcher.JobService は抽象クラスであり、バックグラウンドジョブで実行されるロジックではこれを拡張する必要があります。
Firebase.JobDispatcher.JobTrigger では、ジョブを開始するタイミングを宣言します。通常、これは時間枠として表されます (例: 少なくとも 30 秒待ってからジョブを開始するが、5 分以内にジョブを実行する)。
Firebase.JobDispatcher.RetryStrategy には、ジョブを正常に実行できないときに行う必要があることに関する情報が含まれています。再試行戦略では、ジョブの再実行を試みるまでの待機時間を指定します。
Firebase.JobDispatcher.Constraint は、ジョブを実行する前に満たされる必要がある条件を記述するオプションの値です (例: デバイスが従量課金制ではないネットワークを使用している場合や、充電されている場合)。
Firebase.JobDispatcher.Job は、これまでの API を、JobDispatcher によってスケジュール設定できる処理単位にまとめる API です。 Job.Builder クラスは、Job をインスタンス化するために使用されます。
Firebase.JobDispatcher.JobDispatcher では、前の 3 つの API を使用して、オペレーティングシステムでの処理がスケジュール設定され、必要に応じてジョブを取り消す手段が提供されます。

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

bool OnStartJob(IJobParameters parameters) - このメソッドは処理が行われる場所であり、常に実装する必要があります。メインスレッドで実行されます。このメソッドでは、残っている処理がある場合は true が返され、処理が完了した場合は false が返されます。
bool OnStopJob(IJobParameters parameters) - これは、何らかの理由でジョブが停止されたときに呼び出されます。後でジョブのスケジュールを再設定する必要がある場合は、true が返されます。
JobFinished(IJobParameters parameters, bool needsReschedule) - このメソッドは、JobService で非同期処理が完了したときに呼び出されます。

ジョブのスケジュールを設定するには、アプリケーションで JobDispatcher オブジェクトをインスタンス化します。次に、Job.Builder を使用して作成した Job オブジェクトを JobDispatcher に提供すると、そこでジョブの実行が試みられ、スケジュールが設定されます。

このガイドでは、Firebase ジョブディスパッチャーを Xamarin.Android アプリケーションに追加し、それを使用してバックグラウンド処理のスケジュールを設定する方法について説明します。

要件

Firebase ジョブディスパッチャーには、Android API レベル9 以上が必要です。 Firebase ジョブディスパッチャーライブラリは、Google Play 開発者サービスによって提供されるいくつかのコンポーネントに依存しています。デバイスに Google Play 開発者サービスがインストールされている必要があります。

Xamarin.Android での Firebase ジョブディスパッチャーライブラリの使用

Firebase ジョブディスパッチャーを使い始めるには、まず Xamarin.Firebase.JobDispatcher NuGet パッケージを Xamarin.Android プロジェクトに追加します。 Xamarin.Firebase.JobDispatcher パッケージ (まだプレリリース段階) 用の NuGet パッケージマネージャーを検索します。

Firebase ジョブディスパッチャーライブラリを追加した後、JobService クラスを作成し、FirebaseJobDispatcher のインスタンスを使用して実行するようにスケジュールを設定します。

JobService の作成

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

JobService クラスを拡張します
サブクラスを ServiceAttribute で修飾します。厳密には必要ではありませんが、JobService のデバッグで役立つように Name パラメーターを明示的に設定することをお勧めします。
AndroidManifest.xml に IntentFilter を追加して JobService を宣言します。これは、Firebase ジョブディスパッチャーが JobService を探して呼び出す場合にも役立ちます。

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

[Service(Name = "com.xamarin.fjdtestapp.DemoJob")]
[IntentFilter(new[] {FirebaseJobServiceIntent.Action})]
public class DemoJob : JobService
{
    static readonly string TAG = "X:DemoService";

    public override bool OnStartJob(IJobParameters jobParameters)
    {
        Task.Run(() =>
        {
            // Work is happening asynchronously (code omitted)
                       
        });

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

    public override bool OnStopJob(IJobParameters jobParameters)
    {
        Log.Debug(TAG, "DemoJob::OnStartJob");
        // nothing to do.
        return false;
    }
}

FirebaseJobDispatcher の作成

処理のスケジュールを設定する前に、Firebase.JobDispatcher.FirebaseJobDispatcher オブジェクトを作成する必要があります。 FirebaseJobDispatcher の役割は、JobService のスケジュールを設定することです。次のコードスニペットは、FirebaseJobDispatcher のインスタンスを作成する 1 つの方法です。

// This is the "Java" way to create a FirebaseJobDispatcher object
IDriver driver = new GooglePlayDriver(context);
FirebaseJobDispatcher dispatcher = new FirebaseJobDispatcher(driver);

上のコードスニペットで、GooglePlayDriver は、FirebaseJobDispatcher がデバイス上の Google Play 開発者サービスのスケジューリング API と対話できるようにするクラスです。 context パラメーターは、任意の Android Context (Activity など) です。現在、GooglePlayDriver は、Firebase ジョブディスパッチャーライブラリ内で唯一の IDriver の実装です。

Firebase ジョブディスパッチャーに対する Xamarin. Android のバインドによって、Context から FirebaseJobDispatcher を作成するための拡張メソッドが提供されます。

FirebaseJobDispatcher dispatcher = context.CreateJobDispatcher();

FirebaseJobDispatcher がインスタンス化されたら、Job を作成し、JobService クラスでコードを実行できるようになります。 Job は Job.Builder オブジェクトによって作成されます。これについては、次のセクションで説明します。

Job.Builder での Firebase.JobDispatcher.Job の作成

Firebase.JobDispatcher.Job クラスの役割は、JobService の実行に必要なメタデータをカプセル化することです。 Job には、ジョブが実行可能になる前に満たされる必要がある制約、Job が定期的かどうか、ジョブが実行されるトリガーなどの情報が含まれます。少なくとも、Job には、"タグ" (ジョブを FirebaseJobDispatcher に対して一意に示す文字列) と、実行する必要のある JobService の種類が必要です。ジョブを実行する時間になると、Firebase ジョブディスパッチャーによって JobService がインスタンス化されます。 Job は、Firebase.JobDispatcher.Job.JobBuilder クラスのインスタンスを使用して作成されます。

次のコードスニペットは、Xamarin.Android のバインドを使用して Job を作成する方法の最も簡単な例です。

Job myJob = dispatcher.NewJobBuilder()
                      .SetService<DemoJob>("demo-job-tag")
                      .Build();

Job.Builder によって、ジョブに対する入力値についてのいくつかの基本的な検証チェックが実行されます。 Job.Builder で Job を作成できない場合は、例外がスローされます。 Job.Builder で作成される Job の既定値は次のとおりです。

Job の "有効期間" (実行のスケジュールが設定されている期間) は、デバイスの再起動までだけです。デバイスが再起動されると Job は失われます。
Job は定期的に実行されません。1 回実行されるだけです。
Job は、できるだけ早く実行されるようにスケジュール設定されます。
Job の既定の再試行戦略では、"エクスポネンシャルバックオフ" が使用されます (詳しくは、後の「RetryStrategy の設定」セクションで説明します)

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

Job を作成した後は、実行する前に、FirebaseJobDispatcher でスケジュールを設定する必要があります。 Job のスケジュールを設定するには、次の 2 つの方法があります。

// This will throw an exception if there was a problem scheduling the job
dispatcher.MustSchedule(myJob);

// This method will not throw an exception; an integer result value is returned
int scheduleResult = dispatcher.Schedule(myJob);

FirebaseJobDispatcher.Schedule によって返される値は、次のいずれかの整数値です。

FirebaseJobDispatcher.ScheduleResultSuccess - Job は正常にスケジュール設定されました。
FirebaseJobDispatcher.ScheduleResultUnknownError - 不明な問題が発生したため、Job のスケジュールを設定できませんでした。
FirebaseJobDispatcher.ScheduleResultNoDriverAvailable - 無効な IDriver が使用されたか、または IDriver がなんらかの理由で使用できませんでした。
FirebaseJobDispatcher.ScheduleResultUnsupportedTrigger - Trigger はサポートされていませんでした。
FirebaseJobDispatcher.ScheduleResultBadService - サービスが正しく構成されていないか、または使用できません。

ジョブの構成

ジョブをカスタマイズすることができます。ジョブをカスタマイズする方法の例を次に示します。

ジョブにパラメーターを渡す - Job で処理を実行するために追加の値が必要になる場合があります (ファイルのダウンロードなど)。
制約を設定する - 特定の条件が満たされた場合にのみ、ジョブが実行されるようにすることが必要な場合があります。たとえば、デバイスが充電されている場合にのみ、Job を実行するような場合です。
Job をいつ実行するかを指定する - Firebase ジョブディスパッチャーでは、ジョブを実行する必要がある時刻をアプリケーションで指定できます。
失敗したジョブの再試行戦略を宣言する - "再試行戦略" では、完了できなかった Jobs への対処方法についてのガイダンスを FirebaseJobDispatcher に提供します。

これらの各トピックについては、以下のセクションで詳しく説明します。

ジョブにパラメーターを渡す

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

Bundle jobParameters = new Bundle();
jobParameters.PutInt(FibonacciCalculatorJob.FibonacciPositionKey, 25);

Job myJob = dispatcher.NewJobBuilder()
                      .SetService<DemoJob>("demo-job-tag")
                      .SetExtras(jobParameters)
                      .Build();

Bundle には、OnStartJob メソッドの IJobParameters.Extras プロパティからアクセスします。

public override bool OnStartJob(IJobParameters jobParameters)
{
    int position = jobParameters.Extras.GetInt(FibonacciPositionKey, DEFAULT_VALUE);
    
    // rest of code omitted
}

制約の設定

制約を使用すると、デバイスでのコストやバッテリ消費を削減できます。 Firebase.JobDispatcher.Constraint クラスでは、これらの制約を整数値として定義します。

Constraint.OnUnmeteredNetwork - デバイスが従量課金制ではないネットワークに接続されている場合にのみ、ジョブを実行します。これは、ユーザーにデータ料金が発生しないようにするのに役立ちます。
Constraint.OnAnyNetwork - デバイスがどのようなネットワークに接続されていても、ジョブを実行します。 Constraint.OnUnmeteredNetwork と共に指定した場合は、この値が優先されます。
Constraint.DeviceCharging - デバイスが充電されている場合にのみ、ジョブを実行します。

制約を設定するには、Job.Builder.SetConstraint メソッドを使用します。

Job myJob = dispatcher.NewJobBuilder()
                      .SetService<DemoJob>("demo-job-tag")
                      .SetConstraint(Constraint.DeviceCharging)
                      .Build();

JobTrigger では、ジョブをいつ開始する必要があるかについて、オペレーティングシステムにガイダンスが提供されます。 JobTrigger の "実行時間枠" では、Job を実行する必要があるスケジュール設定された時刻が定義されています。実行時間枠には、"開始枠" の値と "終了枠" の値があります。開始枠は、ジョブを実行する前にデバイスが待機する秒数です。終了枠の値は、Job を実行する前に待機する最大秒数です。

JobTrigger は、Firebase.Jobdispatcher.Trigger.ExecutionWindow メソッドを使用して作成できます。たとえば、Trigger.ExecutionWindow(15,60) は、スケジュール設定された時刻から 15 から 60 秒の間にジョブを実行する必要があることを意味します。 Job.Builder.SetTrigger メソッドが使用されます

JobTrigger myTrigger = Trigger.ExecutionWindow(15,60);
Job myJob = dispatcher.NewJobBuilder()
                      .SetService<DemoJob>("demo-job-tag")
                      .SetTrigger(myTrigger)
                      .Build();

ジョブの既定の JobTrigger は、Trigger.Now の値によって表されます。この値は、スケジュールが設定された後、ジョブをできるだけ早く実行することを指定します。

RetryStrategy の設定

Firebase.JobDispatcher.RetryStrategy は、失敗したジョブを再実行する前にデバイスで使用する遅延の量を指定するために使用されます。 RetryStrategy の "ポリシー" では、失敗したジョブのスケジュールを再設定するために使用する時間ベースのアルゴリズムと、ジョブをスケジュールする時間枠を指定する実行時間枠が定義されています。この "再スケジュール時間枠" は、2 つの値によって定義されます。 1 つ目の値は、ジョブを再スケジュールする前に待機する秒数です ("初期バックオフ" 値)。2 つ目の値は、ジョブを実行するまでの最大秒数です ("最大バックオフ" 値)。

次の int 値によって、2 種類の再試行ポリシーが識別されます。

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

FirebaseJobDispatcher.NewRetryStrategy メソッドを使用してカスタム RetryStrategy を定義できます。 3 つのパラメーターを受け取ります。

int policy - "ポリシー" は、前の RetryStrategy 値、RetryStrategy.RetryPolicyLinear、または RetryStrategy.RetryPolicyExponential のいずれかです。
int initialBackoffSeconds - "初期バックオフ" は、ジョブの再実行を試みる前に必要な遅延時間 (秒単位) です。これの既定値は 30 秒です。
int maximumBackoffSeconds - "最大バックオフ" 値は、ジョブの実行を再試行するまでの最大待機時間を秒単位で指定します。既定値は 3600 秒です。

RetryStrategy retry = dispatcher.NewRetryStrategy(RetryStrategy.RetryPolicyLinear, initialBackoffSeconds, maximumBackoffSet);

// Create a Job and set the RetryStrategy via the Job.Builder
Job myJob = dispatcher.NewJobBuilder()
                      .SetService<DemoJob>("demo-job-tag")
                      .SetRetryStrategy(retry)
                      .Build();

ジョブの取り消し

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

int cancelResult = dispatcher.CancelAll(); 

// to cancel a single job:

int cancelResult = dispatcher.Cancel("unique-tag-for-job");

どちらのメソッドでも、整数値が返されます。

FirebaseJobDispatcher.CancelResultSuccess - ジョブは正常に取り消されました。
FirebaseJobDispatcher.CancelResultUnknownError - エラーが発生したため、ジョブを取り消せませんでした。
FirebaseJobDispatcher.CancelResult.NoDriverAvailable - 使用できる有効な IDriver がないため、FirebaseJobDispatcher はジョブを取り消せません。

まとめ

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

次の方法で共有

Firebase ジョブディスパッチャー

概要

要件

Xamarin.Android での Firebase ジョブディスパッチャーライブラリの使用

JobService の作成

FirebaseJobDispatcher の作成

Job.Builder での Firebase.JobDispatcher.Job の作成

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

ジョブの構成

ジョブにパラメーターを渡す

制約の設定

RetryStrategy の設定

ジョブの取り消し

まとめ

その他のリソース

次の方法で共有

Firebase ジョブ ディスパッチャー

概要

要件

Xamarin.Android での Firebase ジョブ ディスパッチャー ライブラリの使用

JobService の作成

FirebaseJobDispatcher の作成

Job.Builder での Firebase.JobDispatcher.Job の作成

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

ジョブの構成

ジョブにパラメーターを渡す

制約の設定

RetryStrategy の設定

ジョブの取り消し

まとめ

関連リンク

その他のリソース

Firebase ジョブディスパッチャー

Xamarin.Android での Firebase ジョブディスパッチャーライブラリの使用