WorkManager — nedir, API ve görev planlama

WorkManager nasıl çalışır?

WorkManager'in mimarisi üç temel sınıf etrafında inşa edilmiştir: Worker, WorkRequest ve WorkManager. Worker görev mantığını içerir, WorkRequest yürütme parametrelerini tanımlar ve WorkManager kuyruğu ve zamanlamayı yönetir. Kütüphane, tüm görevlerin durumunu depolamak için dahili bir Room veritabanı kullanır.

Worker ve WorkRequest

Worker, arka plan iş parçacığında çağrılan tek bir doWork yöntemine sahip soyut bir sınıftır. Yöntem ListenableWorker.Result — SUCCESS, FAILURE veya RETRY döndürür. WorkRequest, Worker'ı parametrelerle (zaman aşımı, etiket, başlangıç gecikmesi ve kısıtlamalar) ilişkilendirir.

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 ile zamanlama

WorkManager, Android sürümünden bağımsız olarak görevleri tek tip şekilde zamanlar. enqueue çağrıldığında, kütüphane görevi Room'a kaydeder, mevcut koşulları değerlendirir ve en uygun yürütme zamanını seçer. Perde arkasında JobScheduler, AlarmManager veya kendi zamanlayıcısını kullanabilir — geliştiricinin bunun için endişelenmesine gerek yoktur.

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

WorkManager.getInstance(context)
    .enqueue(syncRequest)

WorkRequest türleri

WorkManager iki tür yürütme talebini destekler: bir kerelik ve periyodik. Tür seçimi senaryoya bağlıdır: görev bir kez mi çalışmalı yoksa belirli bir aralıkta mı tekrarlanmalı.

OneTimeWorkRequest

OneTimeWorkRequest, bir kez yürütülmesi gereken görevler için tasarlanmıştır. Bu, günlük gönderme, yetkilendirme sonrası veri senkronizasyonu, ilk başlatmada yapılandırma indirme olabilir. Gecikme setInitialDelay ile, kısıtlamalar ise setConstraints ile ayarlanır.

PeriodicWorkRequest

PeriodicWorkRequest, minimum 15 dakika aralıklı tekrarlayan görevler için uygundur. Kütüphane, çalıştırmalar arasındaki aralığın belirtilenden daha kısa olmayacağını garanti eder, ancak cihaz kısıtlamaları nedeniyle daha uzun olabilir. 15 dakikadan daha sık görevler için Foreground Service'de Handler veya Timer kullanın.

Kısıtlamaları ayarlama ve görev zincirleri

WorkManager'daki kısıtlamalar, bir görevin başlatılabileceği koşulları belirlemenize olanak tanır: ağ bağlantısı (NetworkType), pil seviyesi (batteryNotLow), depolama durumu (StorageNotLow) ve boşta kalma modu (DeviceIdle). Tüm kısıtlamalar karşılanana kadar görev başlatılmaz.

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

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

Zincirler, görevlerin sıralı veya paralel yürütülmesini düzenlemenize olanak tanır. beginWith bir zincir başlatır, then bir öncekinin başarıyla tamamlanmasından sonra yürütülecek bir sonraki Worker'ı ekler. Paralel yürütme için workManager.enqueue(listOf(request1, request2)) kullanın.

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

JobScheduler'dan WorkManager'a geçiş

JobScheduler, Android 5'te (API 21) arka plan görevlerini zamanlamak için bir sistem hizmeti olarak tanıtıldı. WorkManager, otomatik geçiş ve ek yeteneklerle (zincirler, yürütme garantisi, etiketler, LiveData ile durum izleme) çapraz platform bir API sunarak onun yerini aldı.

JobScheduler'dan WorkManager'a geçiş yaparken, JobService'i Worker'a dönüştürmeniz, JobInfo'yu WorkRequest ile ve Context.getSystemService'i WorkManager API'si ile değiştirmeniz gerekir. WorkManager uyumluluk sorunlarını otomatik olarak yönetir ve Doze Modu'nu manuel JobScheduler uygulamasından daha doğru şekilde işler. Geçiş adımları: 1) Worker sınıfı oluşturun, 2) aynı koşullarla bir WorkRequest oluşturun, 3) kod ve manifest dosyasından JobService ve JobInfo'yu kaldırın.

Benzersiz görevler için UniqueWork

WorkManager, ExistingWorkPolicy aracılığıyla benzersiz görevler kavramını destekler. Belirtilen ada sahip bir görev zaten mevcutsa, politika davranışı belirler: KEEP (yeni oluşturma), REPLACE (mevcut olanı değiştir), APPEND (zincirin sonuna ekle) ve APPEND_OR_REPLACE. UniqueWorkRequest, tekrarlanmaması gereken görevler için kullanışlıdır: veritabanı senkronizasyonu, yapılandırma indirme, analitik toplu gönderme.

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

İlerleme ve ara sonuç yönetimi

CoroutineWorker, ara yürütme sonuçlarını iletmeye olanak tanıyan setProgress mekanizmasını destekler. Bu, uzun süren işlemler için kullanışlıdır: büyük dosya indirme, toplu görüntü işleme, veritabanı geçişi. UI, getWorkInfosByTagLiveData aracılığıyla güncellemelere abone olabilir ve gerçek zamanlı ilerlemeyi görüntüleyebilir. Görevin kullanıcıya görünür olması gerekiyorsa, ForegroundInfo yöntemi, Worker'ı bir bildirimle Foreground Service olarak çalıştırmak için de kullanılabilir.

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

Veri aktarımı için InputData ve OutputData

WorkManager, InputData ve OutputData aracılığıyla Worker'lar arasında veri aktarımını destekler. InputData, Data.Builder aracılığıyla WorkRequest oluşturma sırasında oluşturulur ve inputData aracılığıyla Worker'a iletilir. Yürütmeden sonra Worker, workDataOf veya Data.Builder aracılığıyla OutputData oluşturur ve Result.success(outputData) ile birlikte döndürür. Zincirdeki bir sonraki Worker, bir öncekinin outputData'sını kendi inputData'sı olarak alır. Veriler, temel türler (String, Int, Long, Boolean, Double) desteğiyle anahtar-değer biçiminde depolanır. Maksimum Data boyutu 10 KB'dir.

Pratikte, birçok proje WorkManager'ı tek arka plan görev zamanlayıcısı olarak kullanır. Google, özellikle JobScheduler'ın bulunmadığı ve WorkManager'in AlarmManager ve BroadcastReceiver aracılığıyla yedekleme mekanizması kullandığı Android 4.4 (API 19) ve altını destekleyen uygulamalarda, mevcut tüm JobService'leri WorkManager'a geçirmeyi önerir. Test için WorkManager, gerçek bir zamanlayıcı olmadan JUnit testlerinde Worker'ları test etmeye olanak tanıyan TestListenableWorkerBuilder ve TestWorkerBuilder sağlar.