バックグラウンド処理を管理しよう！ WorkManagerの基本の使い方を解説

一歩進んだAndroidアプリ開発ができる「Android Jetpack」入門 第9回

WorkRequestへの設定

　先述の通り、from()メソッドにより生成されたWorkRequestオブジェクトは、何も設定がされていないデフォルトの振る舞いを行います。次に、このWorkRequestの設定方法を紹介します。

WorkRequestへの設定にはビルダーが必要

　WorkRequestに設定を行う場合は、生成したWorkRequestインスタンスに直接設定を行うわけではありません。代わりに、以下の手順となります。

1. WorkRequestのビルダーを生成
2. ビルダーに設定
3. WorkRequestを生成

　この手順で行ったコードサンプルは、Javaならばリスト9、Kotlinならばリスト10のようになります。

リスト9：WorkRequestに設定を行うコードサンプル（Java版）

OneTimeWorkRequest.Builder workRequestBuilder = new OneTimeWorkRequest.Builder(CountUpWorker.class);  // (1)
workRequestBuilder.addTag("DelayedWorker");  // (2)
workRequestBuilder.setInitialDelay(5, TimeUnit.SECONDS);  // (2)
WorkRequest workRequest = workRequestBuilder.build();  // (3)

リスト10：WorkRequestに設定を行うコードサンプル（Kotlin版）

val workRequestBuilder = OneTimeWorkRequestBuilder<CountUpWorker>()  // (1)
workRequestBuilder.addTag("DelayedWorker")  // (2)
workRequestBuilder.setInitialDelay(5, TimeUnit.SECONDS)  // (2)
val workRequest = workRequestBuilder.build()  // (3)

　以下、順に説明していきます。

1. WorkRequestのビルダーを生成

　（1）が該当します。これは、Javaの場合は、OneTimeWorkRequest.Builderインスタンスの生成コードです。その際、from()によるWorkRequestインスタンス生成の時と同様に、リスト9のように、引数としてワーカークラスを渡します。

　一方、Kotlinの場合は、リスト10のように、OneTimeWorkRequestBuilderインスタンスとなります。また、ワーカークラスの指定は、引数ではなく、ジェネリクスの型指定として行い、引数はなしとします。

2. ビルダーに設定

　（2）が該当します。表1のWorkRequestのビルダーのメソッドを利用して、設定を行っていきます。

表1：WorkRequestのビルダーの設定メソッド

メソッド	概要
addTag	タグ文字列を設定
inputData	ワーカーで利用するデータの設定
setInitialDelay	ワーカーの開始タイミングを設定
setBackoffCriteria	リトライに関する設定
setExpedited	重要度の高いワーカーの設定
setId	IDを設定

　これらのメソッドのうち、リスト9とリスト10では、タグ文字列の設定のaddTag()を利用しています。このメソッドでタグ文字列を設定しておくと、ワーカーのキャンセルなどを行う際に、このタグ文字列でのワーカーの検索が可能となります。

　また、同じく、setInitialDelay()も利用しています。このメソッドでは、ワーカーの開始を遅らせる設定が可能です。設定方法は、第1引数に数値を、第2引数に第1引数の数値の単位を指定します。リスト9とリスト10では、第1引数が5、第2引数がTimeUnit.SECONDSとなっているので、ENQUEUED状態になってから5秒後にワーカーが開始される設定となります。

　その他のメソッドのうちいくつかは、次回以降紹介する予定です。

3. WorkRequestを生成

　（3）が該当します。各種設定が行われたビルダーに対してbuild()メソッドを実行することで、WorkRequestインスタンスが生成されます。あとは、from()で生成したWorkRequestインスタンスと同様に、WorkManagerのenqueue()に登録を行います。

　なお、ここまでの手順を、メソッドチェーンを利用して、以下のようなコードを記述することも可能です。

WorkRequest workRequest = new OneTimeWorkRequest.Builder(CountUpWorker.class).addTag("DelayedWorker").setInitialDelay(5, TimeUnit.SECONDS).build();

Constraintsを利用した細かい設定

　表1を見てもWorkRequestのビルダーで設定できる内容は、あまり種類がありません。代わりに、細かい設定にはConstraintsオブジェクトを使います。これは、Javaではリスト11、Kotlinではリスト12のコードとなります。

リスト11：Constraintsを利用したWorkRequestの設定コード（Java版）

Constraints.Builder constraintsBuilder = new Constraints.Builder();  // (1)
constraintsBuilder.setRequiredNetworkType(NetworkType.UNMETERED);  // (2)
Constraints constraints = constraintsBuilder.build();  // (3)
workRequestBuilder.setConstraints(constraints);  // (4)

リスト12：Constraintsを利用したWorkRequestの設定コード（Kotlin版）

val constraintsBuilder = Constraints.Builder()  // (1)
constraintsBuilder.setRequiredNetworkType(NetworkType.UNMETERED)  // (2)
val constraints = constraintsBuilder.build()  // (3)
workRequestBuilder.setConstraints(constraints)  // (4)

　Constraintsオブジェクトを利用する場合も、（1）のように、まずConstraints.Builderインスタンスを生成し、（2）のように、そのビルダーに対して表2のメソッドを使って設定を行っていきます。その後、（3）のようにbuild()メソッドを実行して、ようやくConstraintsオブジェクトを生成します。最終的にWorkRequestのビルダーのsetConstraints()メソッドに(3)のConstraintsオブジェクトを渡すことで、表2で行った設定が可能となります。

表2：Constraints.Builderへの設定メソッド

メソッド	概要	引数
setRequiredNetworkType	特定のネットワーク状態の時のみワーカーを実行する設定	NetworkTypeの定数
setRequiresBatteryNotLow	バッテリの充電量が充分の時のみワーカーを実行するかの設定	boolean
setRequiresCharging	充電時のみワーカーを実行するかの設定	boolean
setRequiresStorageNotLow	ストレージの空き容量が充分の時のみワーカーを実行するかの設定	boolean

　なお、setRequiredNetworkType()の引数として利用するNetworkTypeの定数には表3のものがあります。

表3：NetworkTypeの定数

定数	概要
CONNECTED	いかなる種類でもネットワークに接続されている必要がある
METERED	従量制ネットワークに接続されている必要がある
NOT_REQUIRED	ネットワーク接続は不要
NOT_ROAMING	非ローミングのネットワークに接続されている必要がある
TEMPORARILY_UNMETERED	通常は従量制だが一時的に非従量制のネットワークに接続されている必要がある
UNMETERED	非従量制のネットワークに接続されている必要がある

　リスト11では、UNMETEREDを指定しています。このUNMETEREDは、通常はWi-Fi接続を指すため、端末がWi-Fiに接続している時のみワーカーが実行されるようになります。

まとめ

　Android Jetpackについて紹介していく本連載の第9回は、いかがでしたでしょうか。

　今回は、3回にわたって紹介するWorkManagerの初回として、WorkManagerの概説とその基本的な使い方を紹介しました。次回は、この続きとして、WorkRequestへの設定を掘り下げ、もう少し応用的なワーカーの実行方法を紹介します。