WorkManager — 概要、API、タスクスケジューリング

WorkManagerの仕組み

WorkManagerのアーキテクチャは、Worker、WorkRequest、WorkManagerの3つの基本クラスを中心に構築されています。Workerはタスクロジックを含み、WorkRequestは実行パラメーターを記述し、WorkManagerはキューとスケジューリングを管理します。ライブラリは内部のRoomデータベースを使用してすべてのタスクの状態を保存します。

WorkerとWorkRequest

Workerは抽象クラスで、バックグラウンドスレッドで呼び出される単一のメソッドdoWorkを持ちます。このメソッドはListenableWorker.Result — SUCCESS、FAILURE、またはRETRYを返します。WorkRequestはWorkerをパラメーター（タイムアウト、タグ、初期遅延、制約）に結び付けます。

class SyncWorker(
    context: Context,
    params: WorkerParameters
) : Worker(context, params) {

    override fun doWork(): Result {
        return try {
            val api = RetrofitClient.api
            val response = api.syncData()
            Result.success()
        } catch (e: Exception) {
            Result.retry()
        }
    }
}

WorkManagerによるスケジューリング

WorkManagerは、Androidバージョンに関係なくタスクを均一にスケジュールします。enqueueを呼び出すと、ライブラリはタスクをRoomに保存し、現在の条件を評価し、最適な実行時間を選択します。内部的には、JobScheduler、AlarmManager、または独自のスケジューラーを使用する場合があり、開発者はそのことを心配する必要はありません。

val syncRequest = OneTimeWorkRequestBuilder<SyncWorker>()
    .setInitialDelay(15, TimeUnit.MINUTES)
    .addTag("sync")
    .build()

WorkManager.getInstance(context)
    .enqueue(syncRequest)

WorkRequestの種類

WorkManagerは、1回限りと定期限の2種類の実行リクエストをサポートしています。タイプの選択はシナリオに依存します：タスクを1回実行するか、指定された間隔で繰り返すか。

OneTimeWorkRequest

OneTimeWorkRequestは、1回だけ実行する必要があるタスク向けに設計されています。ログの送信、認証後のデータ同期、初回起動時の設定ダウンロードなどが該当します。遅延はsetInitialDelay、制約はsetConstraintsで設定します。

PeriodicWorkRequest

PeriodicWorkRequestは、最小間隔15分の繰り返しタスクに適しています。ライブラリは、実行間隔が指定された間隔より短くならないことを保証しますが、デバイスの制約により長くなる可能性があります。15分未満の頻度のタスクには、Foreground ServiceでHandlerまたはTimerを使用してください。

制約の設定とタスクチェーン

WorkManagerの制約により、タスクを開始できる条件を設定できます：ネットワーク接続（NetworkType）、バッテリーレベル（batteryNotLow）、ストレージ状態（StorageNotLow）、アイドルモード（DeviceIdle）。すべての制約が満たされるまでタスクは開始されません。

val constraints = Constraints.Builder()
    .setRequiredNetworkType(NetworkType.CONNECTED)
    .setRequiresCharging(true)
    .setRequiresBatteryNotLow(true)
    .build()

val request = OneTimeWorkRequestBuilder<ImageUploadWorker>()
    .setConstraints(constraints)
    .build()

チェーンにより、タスクの順次実行または並列実行を整理できます。beginWithでチェーンを開始し、thenで次のWorkerを追加します。これは前のWorkerの正常完了後に実行されます。並列実行には、workManager.enqueue(listOf(request1, request2))を使用します。

WorkManager.getInstance(context)
    .beginWith(compressWorker)
    .then(uploadWorker)
    .then(cleanupWorker)
    .enqueue()
    // compress -> upload -> cleanup 順次実行

JobSchedulerからWorkManagerへの移行

JobSchedulerはAndroid 5（API 21）でバックグラウンドタスクをスケジュールするためのシステムサービスとして導入されました。WorkManagerはその後継として登場し、自動移行と追加機能（チェーン、実行保証、タグ、LiveDataによる状態監視）を備えたクロスプラットフォームAPIを提供しています。

JobSchedulerからWorkManagerに移行する際は、JobServiceをWorkerに変換し、JobInfoをWorkRequestに、Context.getSystemServiceをWorkManager APIに置き換える必要があります。WorkManagerは互換性の問題を自動的に処理し、手動のJobScheduler実装よりも正しくDoze Modeを処理します。移行手順：1）Workerクラスを作成、2）同じ条件でWorkRequestを構築、3）コードとマニフェストからJobServiceとJobInfoを削除。

ユニークタスクのためのUniqueWork

WorkManagerはExistingWorkPolicyを通じてユニークタスクの概念をサポートしています。指定された名前のタスクが既に存在する場合、ポリシーが動作を決定します：KEEP（新規作成しない）、REPLACE（既存を置き換える）、APPEND（チェーンの最後に追加）、APPEND_OR_REPLACE。UniqueWorkRequestは、重複すべきでないタスク（データベース同期、設定ダウンロード、分析バッチ送信）に便利です。

WorkManager.getInstance(context)
    .enqueueUniqueWork(
        "sync_data",
        ExistingWorkPolicy.KEEP,
        syncRequest
    )

進捗と中間結果の処理

CoroutineWorkerはsetProgressメカニズムをサポートしており、中間実行結果を渡すことができます。これは長時間実行される操作（大規模ファイルのダウンロード、画像のバッチ処理、データベース移行）に役立ちます。UIはgetWorkInfosByTagLiveDataを介して更新を購読し、リアルタイムの進捗を表示できます。タスクをユーザーに表示する必要がある場合は、ForegroundInfoメソッドを使用してWorkerを通知付きのForeground Serviceとして実行することもできます。

class ProgressWorker(
    context: Context,
    params: WorkerParameters
) : CoroutineWorker(context, params) {

    override suspend fun doWork(): Result {
        val total = 100
        for (i in 1..total) {
            setProgress(
                workDataOf("progress" to i)
            )
        }
        return Result.success()
    }
}

データ転送のためのInputDataとOutputData

WorkManagerはInputDataとOutputDataを介したWorker間のデータ転送をサポートしています。InputDataはData.Builderを介してWorkRequest構築時に作成され、inputDataを介してWorkerに渡されます。実行後、WorkerはworkDataOfまたはData.Builderを介してOutputDataを作成し、Result.success(outputData)とともに返します。チェーン内の次のWorkerは、前のWorkerのoutputDataを自身のinputDataとして受け取ります。データはキーと値の形式で保存され、基本的な型（String、Int、Long、Boolean、Double）をサポートします。Dataの最大サイズは10 KBです。

実際には、多くのプロジェクトがWorkManagerを唯一のバックグラウンドタスクスケジューラーとして使用しています。Googleは、特にJobSchedulerが利用できずWorkManagerがAlarmManagerとBroadcastReceiverを介してフォールバックメカニズムを使用するAndroid 4.4（API 19）以下をサポートするアプリでは、既存のすべてのJobServiceをWorkManagerに移行することを推奨しています。テストのために、WorkManagerはTestListenableWorkerBuilderとTestWorkerBuilderを提供しており、実際のスケジューラーなしでJUnitテストでWorkerをテストできます。