WorkManager — vad är det, API och uppgiftsschemaläggning

Hur fungerar WorkManager?

Arkitekturen i WorkManager är uppbyggd kring tre basklasser: Worker, WorkRequest och WorkManager. Worker innehåller uppgiftslogiken, WorkRequest beskriver exekveringsparametrarna och WorkManager hanterar kön och schemaläggning. Biblioteket använder en intern Room-databas för att lagra status för alla uppgifter.

Worker och WorkRequest

Worker — är en abstrakt klass med en enda metod doWork som anropas i en bakgrundstråd. Metoden returnerar ListenableWorker.Result — SUCCESS, FAILURE eller RETRY. WorkRequest kopplar Worker till parametrar: timeout, tagg, initial fördröjning och begränsningar.

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()
        }
    }
}

Schemaläggning via WorkManager

WorkManager schemalägger uppgifter enhetligt oavsett Android-version. När enqueue anropas sparar biblioteket uppgiften i Room, utvärderar aktuella förhållanden och väljer optimal starttid. Under huven kan JobScheduler, AlarmManager eller en egen schemaläggare användas — utvecklaren behöver inte tänka på det.

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

WorkManager.getInstance(context)
    .enqueue(syncRequest)

Typer av WorkRequest

WorkManager stöder två typer av exekveringsförfrågningar: engångs- och periodiska. Valet av typ beror på scenariot: uppgiften ska utföras en gång eller upprepas med ett visst intervall.

OneTimeWorkRequest

OneTimeWorkRequest är avsedd för uppgifter som ska utföras en gång. Det kan vara att skicka en logg, synkronisera data efter auktorisering, ladda konfiguration vid första start. Fördröjning ställs in via setInitialDelay och begränsningar via setConstraints.

PeriodicWorkRequest

PeriodicWorkRequest passar för återkommande uppgifter med ett minimiintervall på 15 minuter. Biblioteket garanterar att intervallet mellan körningar inte blir kortare än angivet, men kan vara längre på grund av enhetsbegränsningar. För uppgifter med frekvens mindre än 15 minuter, använd Handler eller Timer i en Foreground Service.

Ställa in begränsningar och uppgiftskedjor

Begränsningar (constraints) i WorkManager gör det möjligt att ange villkor under vilka en uppgift kan startas: nätverksanslutning (NetworkType), batterinivå (batteryNotLow), lagringsstatus (StorageNotLow) och viloläge (DeviceIdle). Uppgiften startar inte förrän alla begränsningar är uppfyllda.

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

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

Kedjor (chaining) gör det möjligt att organisera sekventiell eller parallell exekvering av uppgifter. beginWith startar en kedja, then lägger till nästa Worker som körs efter att den föregående har slutförts framgångsrikt. För parallell exekvering, använd workManager.enqueue(listOf(request1, request2)).

WorkManager.getInstance(context)
    .beginWith(compressWorker)
    .then(uploadWorker)
    .then(cleanupWorker)
    .enqueue()
    // compress -> upload -> cleanup sekventiellt

Migrering från JobScheduler till WorkManager

JobScheduler introducerades i Android 5 (API 21) som en systemtjänst för schemaläggning av bakgrundsuppgifter. WorkManager kom som ersättning med ett plattformsoberoende API, automatisk migrering och ytterligare funktioner: kedjor, exekveringsgaranti, taggar, statusövervakning via LiveData.

Vid migrering från JobScheduler till WorkManager måste JobService konverteras till Worker, JobInfo ersättas med WorkRequest och Context.getSystemService med WorkManager API. WorkManager löser automatiskt kompatibilitetsproblem och hanterar Doze Mode mer korrekt än en manuell JobScheduler-implementering. Migreringssteg: 1) skapa en Worker-klass, 2) bygg en WorkRequest med samma villkor, 3) ta bort JobService och JobInfo från koden och manifestet.

UniqueWork för unika uppgifter

WorkManager stöder konceptet med unika uppgifter via ExistingWorkPolicy. Om en uppgift med det angivna namnet redan finns, bestämmer policyn beteendet: KEEP (skapa inte en ny), REPLACE (ersätt den befintliga), APPEND (lägg till i slutet av kedjan) och APPEND_OR_REPLACE. UniqueWorkRequest är praktiskt för uppgifter som inte bör dupliceras: databas-synkronisering, konfigurationsladdning, skicka ett analyspaket.

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

Hantera framsteg och delresultat

CoroutineWorker stöder setProgress-mekanismen som gör det möjligt att skicka delresultat från en uppgift. Detta är användbart för långa operationer: ladda en stor fil, batch-bearbetning av bilder, databasmigrering. UI:t kan prenumerera på uppdateringar via getWorkInfosByTagLiveData och visa framsteg i realtid. Även ForegroundInfo-metoden finns tillgänglig för att starta Worker som en Foreground Service med en notifikation om uppgiften måste vara synlig för användaren.

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 och OutputData för dataöverföring

WorkManager stöder dataöverföring mellan Workers via InputData och OutputData. InputData skapas vid byggandet av WorkRequest via Data.Builder och skickas till Worker via inputData. Efter exekvering skapar Worker OutputData via workDataOf eller Data.Builder och returnerar den tillsammans med Result.success(outputData). Nästa Worker i kedjan tar emot den föregåendes outputData som sin inputData. Data lagras i nyckel-värde-format med stöd för grundläggande typer: String, Int, Long, Boolean, Double. Den maximala storleken för Data är 10 KB.

I praktiken använder många projekt WorkManager som enda schemaläggare för bakgrundsuppgifter. Google rekommenderar att alla befintliga JobService migreras till WorkManager, särskilt i appar som stöder Android 4.4 (API 19) och lägre, där JobScheduler inte är tillgängligt och WorkManager använder en reservmekanism via AlarmManager och BroadcastReceiver. För testning tillhandahåller WorkManager TestListenableWorkerBuilder och TestWorkerBuilder, som gör det möjligt att testa Workers i JUnit-tester utan en riktig schemaläggare.