WorkManager — bu nədir, API və tapşırıqların planlaşdırılması

WorkManager necə işləyir?

Arxitektura WorkManager üç əsas sinif ətrafında qurulub: Worker, WorkRequest və WorkManager. Worker tapşırıq məntiqini ehtiva edir, WorkRequest icra parametrlərini təsvir edir, WorkManager isə növbə və planlaşdırmanı idarə edir. Kitabxana bütün tapşırıqların vəziyyətini saxlamaq üçün daxili Room verilənlər bazasından istifadə edir.

Worker və WorkRequest

Worker — fon iplikdə çağırılan tək doWork metodu olan abstrakt sinifdir. Metod ListenableWorker.Result — SUCCESS, FAILURE və ya RETRY qaytarır. WorkRequest Worker-i parametrlərlə əlaqələndirir: vaxt aşımı, teq, ilkin gecikmə və məhdudiyyətlər.

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 vasitəsilə icranın planlaşdırılması

WorkManager Android versiyasından asılı olmayaraq tapşırıqları vahid şəkildə planlaşdırır. enqueue çağırışı zamanı kitabxana tapşırığı Room-da saxlayır, cari şərtləri qiymətləndirir və optimal başlatma vaxtını seçir. Daxildə JobScheduler, AlarmManager və ya öz planlayıcısı istifadə oluna bilər — tərtibatçı bu barədə düşünmür.

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

WorkManager.getInstance(context)
    .enqueue(syncRequest)

WorkRequest növləri

WorkManager iki növ icra sorğusunu dəstəkləyir: birdəfəlik və dövri. Növün seçimi ssenaridən asılıdır: tapşırıq bir dəfə yerin yetirilməli və ya müəyyən fasilə ilə təkrarlanmalıdır.

OneTimeWorkRequest

OneTimeWorkRequest bir dəfə yerin yetirilməli tapşırıqlar üçün nəzərdə tutulub. Bu, log göndərmə, girişdən sonra verilənlərin sinxronlaşdırılması, ilk işə salınmada konfiqurasiyanın yüklənməsi ola bilər. Gecikmə setInitialDelay, məhdudiyyətlər isə setConstraints vasitəsilə təyin edilir.

PeriodicWorkRequest

PeriodicWorkRequest minimum 15 dəqiqə fasilə ilə təkrarlanan tapşırıqlar üçün uyğundur. Kitabxana işə salmalar arasındakı fasilənin göstəriləndən az olmayacağına zəmanət verir, lakin cihazın məhdudiyyətləri səbəbindən daha çox ola bilər. Tezliyi 15 dəqiqədən az olan tapşırıqlar üçün Foreground Service-də Handler və ya Timer istifadə edin.

Məhdudiyyətlərin qurulması və tapşırıq zəncirləri

Məhdudiyyətlər (constraints) WorkManager-də tapşırığın başladıla biləcəyi şərtləri təyin etməyə imkan verir: şəbəkə qoşulması (NetworkType), batareya səviyyəsi (batteryNotLow), yaddaş vəziyyəti (StorageNotLow) və gözləmə rejimi (DeviceIdle). Bütün məhdudiyyətlər yerin yetirilməyincə tapşırıq başlamaz.

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

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

Zəncirlər (chaining) tapşırıqların ardıcıl və ya paralel yerin yetirilməsini təşkil etməyə imkan verir. beginWith zənciri başladır, then əvvəlki uğurla tamamlandıqdan sonra icra olunacaq növbəti Worker-i əlavə edir. Paralel icra üçün workManager.enqueue(listOf(request1, request2)) istifadə olunur.

WorkManager.getInstance(context)
    .beginWith(compressWorker)
    .then(uploadWorker)
    .then(cleanupWorker)
    .enqueue()
    // compress → upload → cleanup ardıcıl

JobScheduler-dən WorkManager-ə miqrasiya

JobScheduler Android 5-də (API 21) fon tapşırıqlarını planlaşdırmaq üçün sistem xidməti kimi təqdim edilmişdir. WorkManager avtomatik miqrasiya və əlavə imkanlarla çarpaz platforma API təklif edərək onu əvəz etdi: zəncirlər, icra zəmanəti, teqlər, LiveData vasitəsilə vəziyyətin izlənilməsi.

JobScheduler-dən WorkManager-ə miqrasiya zamanı JobService-i Worker-ə çevirmək, JobInfo-nu WorkRequest ilə əvəz etmək, Context.getSystemService-i WorkManager API-si ilə əvəz etmək lazımdır. WorkManager uyğunluq problemlərini avtomatik həll edir və Doze Mode-u əl ilə JobScheduler tətbiqindən daha düzgün idarə edir. Miqrasiya addımları: 1) Worker sinfi yaradın, 2) eyni şərtlərlə WorkRequest qurun, 3) JobService və JobInfo-nu koddan və manifestdən silin.

Unikal tapşırıqlar üçün UniqueWork

WorkManager ExistingWorkPolicy vasitəsilə unikal tapşırıqlar konsepsiyasını dəstəkləyir. Göstərilən adlı tapşırıq artıq varsa, siyasət davranışı müəyyənləşdirir: KEEP (yenisini yaratma), REPLACE (mövcudu əvəz et), APPEND (zəncirin sonuna əlavə et) və APPEND_OR_REPLACE. UniqueWorkRequest təkrarlanmamalı olan tapşırıqlar üçün əlverişlidir: verilənlər bazasının sinxronlaşdırılması, konfiqurasiyanın yüklənməsi, analitika paketinin göndərilməsi.

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

Proqresin və aralıq nəticələrin idarə edilməsi

CoroutineWorker tapşırığın yerin yetirilməsinin aralıq nəticələrini ötürməyə imkan verən setProgress mexanizmini dəstəkləyir. Bu, uzun müddətli əməliyyatlar üçün faydalıdır: böyük faylın yüklənməsi, şəkillərin toplu emalı, verilənlər bazasının miqrasiyası. UI getWorkInfosByTagLiveData vasitəsilə yenilənmələrə abunə ola və real vaxtda proqresi göstərə bilər. Tapşırıq istifadəçiyə görünən olmalıdırsa, Workeri Foreground Service kimi bildirişlə işə salmaq üçün ForegroundInfo metodu da mövcuddur.

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

Məlumat ötürmək üçün InputData və OutputData

WorkManager Worker-lar arasında məlumat ötürməyi InputData və OutputData vasitəsilə dəstəkləyir. InputData Data.Builder vasitəsilə WorkRequest qurma mərhələsində yaradılır və Worker-ə inputData vasitəsilə ötürülür. İcradan sonra Worker workDataOf və ya Data.Builder vasitəsilə OutputData yaradır və onu Result.success(outputData) ilə birlikdə qaytarır. Zəncirdəki növbəti Worker əvvəlkinin outputData-sını öz inputData-sı kimi alır. Məlumatlar açar-dəyər formatında əsas tiplərlə saxlanılır: String, Int, Long, Boolean, Double. Data-nın maksimum ölçüsü 10 KB-dır.

Təcrübədə bir çox layihə WorkManager-dən yeganə fon tapşırıq planlayıcısı kimi istifadə edir. Google Android 4.4 (API 19) və daha aşağını dəstəkləyən proqramlarda bütün mövcud JobService-ləri WorkManager-ə miqrasiya etməyi tövsiyə edir, çünki JobScheduler mövcud deyil, WorkManager isə AlarmManager və BroadcastReceiver vasitəsilə ehtiyat mexanizmdən istifadə edir. Test üçün WorkManager TestListenableWorkerBuilder və TestWorkerBuilder təqdim edir ki, bunlar real planlayıcı olmadan JUnit testlərində Worker-ları test etməyə imkan verir.