WorkManager — τι είναι, API και προγραμματισμός εργασιών

Πώς λειτουργεί το WorkManager;

Η αρχιτεκτονική του WorkManager χτίζεται γύρω από τρεις βασικές κλάσεις: Worker, WorkRequest και WorkManager. Το 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 υποστηρίζει δύο τύπους αιτημάτων εκτέλεσης: εφάπαξ και περιοδικά. Η επιλογή τύπου εξαρτάται από το σενάριο: η εργασία πρέπει να εκτελεστεί μία φορά ή επαναλαμβανόμενα σε ένα συγκεκριμένο διάστημα.

OneTimeWorkRequest

OneTimeWorkRequest προορίζεται για εργασίες που πρέπει να εκτελεστούν μία φορά. Αυτό μπορεί να είναι η αποστολή ενός αρχείου καταγραφής, ο συγχρονισμός δεδομένων μετά από εξουσιοδότηση, η φόρτωση παραμέτρων κατά την πρώτη εκτέλεση. Η καθυστέρηση ρυθμίζεται μέσω setInitialDelay και οι περιορισμοί μέσω setConstraints.

PeriodicWorkRequest

PeriodicWorkRequest είναι κατάλληλο για επαναλαμβανόμενες εργασίες με ελάχιστο διάστημα 15 λεπτών. Η βιβλιοθήκη εγγυάται ότι το διάστημα μεταξύ εκτελέσεων δεν θα είναι μικρότερο από το καθορισμένο, αλλά μπορεί να είναι μεγαλύτερο λόγω περιορισμών συσκευής. Για εργασίες με συχνότητα μικρότερη από 15 λεπτά, χρησιμοποιήστε Handler ή Timer σε μια Foreground Service.

Ρύθμιση περιορισμών και αλυσίδες εργασιών

Περιορισμοί (constraints) στο WorkManager επιτρέπουν τον ορισμό συνθηκών υπό τις οποίες μπορεί να ξεκινήσει μια εργασία: σύνδεση δικτύου (NetworkType), επίπεδο μπαταρίας (batteryNotLow), κατάσταση αποθήκευσης (StorageNotLow) και λειτουργία αναμονής (DeviceIdle). Η εργασία δεν θα ξεκινήσει έως ότου πληρούνται όλοι οι περιορισμοί.

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

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

Αλυσίδες (chaining) επιτρέπουν την οργάνωση διαδοχικής ή παράλληλης εκτέλεσης εργασιών. Η beginWith ξεκινά μια αλυσίδα, η then προσθέτει τον επόμενο 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 ήρθε ως αντικατάσταση με ένα διασταυρωμένο API, αυτόματη μετάβαση και πρόσθετες δυνατότητες: αλυσίδες, εγγύηση εκτέλεσης, ετικέτες, παρακολούθηση κατάστασης μέσω LiveData.

Κατά τη μετάβαση από JobScheduler σε WorkManager, θα χρειαστεί να μετατρέψετε το JobService σε Worker, να αντικαταστήσετε το JobInfo με WorkRequest και το Context.getSystemService με το API του WorkManager. Το WorkManager λύνει αυτόματα προβλήματα συμβατότητας και χειρίζεται το Doze Mode πιο σωστά από τη χειροκίνητη υλοποίηση του JobScheduler. Βήματα μετάβασης: 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 υποστηρίζει μεταφορά δεδομένων μεταξύ Worker μέσω InputData και OutputData. Το InputData δημιουργείται κατά την κατασκευή του WorkRequest μέσω Data.Builder και μεταφέρεται στον Worker μέσω inputData. Μετά την εκτέλεση, ο Worker δημιουργεί OutputData μέσω workDataOf ή Data.Builder και το επιστρέφει μαζί με Result.success(outputData). Ο επόμενος Worker στην αλυσίδα λαμβάνει το outputData του προηγούμενου ως inputData του. Τα δεδομένα αποθηκεύονται σε μορφή κλειδιού-τιμής με υποστήριξη βασικών τύπων: String, Int, Long, Boolean, Double. Το μέγιστο μέγεθος του Data είναι 10 KB.

Στην πράξη, πολλά έργα χρησιμοποιούν WorkManager ως τον μοναδικό προγραμματιστή εργασιών παρασκηνίου. Η Google συνιστά τη μετεγκατάσταση όλων των υπαρχόντων JobService σε WorkManager, ειδικά σε εφαρμογές που υποστηρίζουν Android 4.4 (API 19) και χαμηλότερα, όπου το JobScheduler δεν είναι διαθέσιμο και το WorkManager χρησιμοποιεί εφεδρικό μηχανισμό μέσω AlarmManager και BroadcastReceiver. Για δοκιμές, το WorkManager παρέχει TestListenableWorkerBuilder και TestWorkerBuilder, που επιτρέπουν τη δοκιμή Worker σε JUnit tests χωρίς πραγματικό προγραμματιστή.