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분 미만의 빈도가 필요한 작업은 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를 추가합니다. 병렬 실행을 위해서는 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)을 지원하는 키-값 형식으로 저장됩니다. 최대 데이터 크기는 10KB입니다.

실제로 많은 프로젝트에서 WorkManager를 유일한 백그라운드 작업 스케줄러로 사용합니다. Google은 특히 JobScheduler를 사용할 수 없고 WorkManager가 AlarmManager 및 BroadcastReceiver를 통해 폴백 메커니즘을 사용하는 Android 4.4(API 19) 이하를 지원하는 앱에서 기존의 모든 JobService를 WorkManager로 마이그레이션할 것을 권장합니다. 테스트를 위해 WorkManager는 TestListenableWorkerBuilder 및 TestWorkerBuilder를 제공하여 실제 스케줄러 없이 JUnit 테스트에서 Worker를 테스트할 수 있습니다.