[Android] WorkManager를 이용한 백그라운드 작업

🧐  WorkManager?

 안드로이드가 버전업을 거듭하며 어느 순간부터 백그라운드 작업이 수월하지 않게되었다.

초기에는 Service를 이용해서 작업하거나 Broadcast Receiver를 통하여 프로세스를 깨우는 것 또한 쉽게 가능했다.

하지만 안드로이드 M(API 23)부터 백그라운드 작업을 위한 제약 사항들이 추가되며, 개발자들은 여러 API를 통하여 추가 코드 작성이 필요해졌다. 즉, 불가능한 것은 아니지만 까다로워졌다는 것이다.

 

 백그라운드 작업은 여러가지 방법들로 가능하다. AlarmManager, JobScheduler, JobDispatcher(Firebase), 그리고 지금 알아볼 WorkManager.

여기서 여러가지 방법들이 존재하는 이유는 용도(목적)에 따라서 개발자들이 적절한 API를 선택해 사용해야 하기 때문이다.

구글에서 백그라운드 처리에 대한 가이드를 제공한다. 해당 문서를 확인하여 알맞은 방법을 선택하자. 공식문서 - 백그라운드 가이드

 

 WorkManager는 프로세스 종료 여부와 관계없이 반드시 작업을 실행한다. 하지만 작업이 즉시 실행되는 것을 보장하지 않음으로 위에서 언급한 것과 같이 적합한 솔루션을 고민해야한다.

 서버에 로그 또는 분석 데이터를 전송하거나 주기적으로 로컬 데이터를 서버와 동기화하는 작업, 이미지 저장 및 업로드 등의 작업이라면 WorkManager 사용을 선택해도 좋다.

 

---

📄  WorkManager 구성

• Worker
  • Abstract class
  • 클래스를 상속받고 백그라운드에서 실행하고자 하는 코드를 doWork() 메소드에 정의한다.
  • 작업 상태를 나타내는 Result에 정의된 success(), failure(), retry() 등의 메소드를 통해 결과를 반환한다.
    반환된 값에 따라서 이후 동작을 결정할 수 있다. (재시도, 중단 등)
    
    • Result.Sucesss / Result.Failure / Result.Retry
• WorkRequest
  • Worker에 정의된 task를 작동시키기 위한 request를 나타낸다.
  • WorkRequest를 생성할 때 반복 여부, 제약 사항 등의 정보를 담는다.
  • OneTimeWorkRequest
    • 한번만 실행할 작업 요청을 나타내는 WorkRequest
  • PeriodicWorkRequest
    • 일정 주기로, 여러번 실행할 작업 요청을 나타내는 WorkRequest
• WorkManager
  • 실제로 WorkRequest를 스케줄링하고 실행하며 관리하는 클래스
  • 인스턴스를 받아와 WorkRequest를 큐에 추가하여 실행하도록 한다.

 

---

🔨  구현하기

📌 Dependency 추가

dependencies {
    implementation "androidx.work:work-runtime-ktx:2.5.0" // Kotlin + Coroutines
}

 

Java Only 버전 또는 최신 버전은 공식 문서에서 확인할 수 있다. 공식 문서 바로가기

 

 

📌 Worker 작성하기

 Worker를 상속받은 클래스를 생성하고 Context와 WorkerParameters를 생성자에 넘긴다.

 

 doWork() 메소드를 오버라이드하고, 하고자하는 작업 코드를 작성한다.

 

class SomeWorker(ctx: Context, params: WorkerParameters) :
    Worker(ctx, params) { // If you want coroutines, CoroutineWorker()

    override fun doWork(): Result {
        return try {
            Timber.d("I'm hard worker, but i will sleep") // Timber is library for logging
            Thread.sleep(3_000)
            Timber.d("Who woke up. I'm tired.")

            Result.success() // return statement
        } catch (e: Exception) {
            Timber.e("Worker Exception $e")
            Result.failure() // return statement
        }

    }
}

 

 

📌 WorkerRequest 작성하기

 한번만 실행될 작업은 OneTimeWorkRequest, 반복적으로 실행될 작업은 PeriodicWorkRequest를 사용하여 만든다.

 PeriodicWorkRequest의 경우 반복 주기 및 시간 단위를 인자로 넘겨야 하는데 최소값은 15분으로 정의되어 있다.

 

 

// in view(activity, fragment) or viewmodel

// OneTimeWorkRequest
val workRequest = OneTimeWorkRequestBuilder<SomeWorker>().build()

// PeriodicWorkRequest
val workRequest = PeriodicWorkRequestBuilder<SomeWorker>(15, TimeUnit.MINUTES).build()

 

 

📌 WorkerManager 작성 및 큐에 작업 추가하기

  WorkerManager의 인스턴스는 getInstance() 메소드를 통해서 가져올 수 있다.

 그리고 enqueue() 메소드를 통해 WorkRequest를 추가할 수 있다.

 

// in view(activity, fragment) or viewmodel

private val workManager = WorkManager.getInstance(application)

workManager.enqueue(workRequest) // 위에서 작성한 workRequest를 넣어준다.

 

 위와 같이 간단하게 WorkManager에 작업들을 추가하여 실행시킬 수 있다.

 

 

---

🔨  더 알아보기

📌 Constraint(제약 사항) 추가하기

 WorkRequestBuilder에 제약 사항을 추가할 수 있다. 제약 사항은 Constraints.Builder()를 통해 작성할 수 있다.

 네트워크 유형, 충전 상태 등에 따라서 WorkManager를 작동시킬 수 있으며 더 자세한 제약 조건 종류는 공식 문서를 확인하자.
공식 문서 바로가기

 

// in view(activity, fragment) or viewmodel

val constraints = Constraints.Builder()
            .setRequiresCharging(true) // 충전 상태일 때만 작동한다.
            .setRequiresBatteryNotLow(true) // 배터리 부족상태가 아닐 때만 작동한다.
            .build()

val workRequest = OneTimeWorkRequestBuilder<SomeWorker>()
            .setConstraints(constraints)
            .build()

 

 

📌 태그 추가 및 작업 관리하기

 모든 작업 요청에 고유 식별자인 태그를 넣어 해당 작업을 취소하거나 진행 상황을 확인할 수 있다.

WorkRequestBuilder에 addTag() 메소드를 통해 태그를 작성하여 식별할 수 있도록 만들어준다.

 

 태그 값을 통하여 취소는 간단하게 할 수 있으며 작업 진행 상황은 반환되는 WorkInfo 객체를 통해 확인할 수 있다.

• WorkInfo State
  • BLOCKED
  • CANCELLED
  • ENQUEUED
  • FAILED
  • RUNNING
  • SUCCEEDED

  해당 객체는 LiveData로 반환받을 수 있으며, 상태에 따라서 progress를 보여주는 등 다양한 작업을 처리할 수있다.

 

// add tag
val workRequest = OneTimeWorkRequestBuilder<SomeWorker>()
	.addTag("some_worker") // Add this method
    .build()
    
// cancel work
workManager.cancelAllWorkByTag("some_worker")

// get work info to livedata
val workInfos = workManager.getWorkInfosByTagLiveData("some_worker")

// observe example in view
workInfos.observe(lifecycleOwner) { workInfos ->
    if (listOfWorkInfo.isNullOrEmpty()) return@observe
    val workInfo = workInfos[0]
    
    if (workInfo.state.isFinished) { // SUCCEEDED or FAILED or CANCELLED
    	hideProgressBar()
    } else {
    	showProgressBar()
    }
}

 

 

📌 여러 작업 체이닝하기

 작업을 순차적 또는 동시에 실행되도록 만드는 WorkRequest를 생성할 수 있다.

 

 예를 들어, 아래 그림과 같은 상황이 있을 수 있다.

Work1과 Work2 테스크를 동시에 실행하고 해당 작업이 끝난 이후에 Work3, Work4를 순서대로 처리하는 상황이다.

Chain WorkRequest Example

 우선 위 테스크를 정의한 Worker들을 WorkRequest로 만들어준다.

 enqueue() 메소드 내에 WorkRequest를 보내는 것이 아니라, beginWith() 메소드를 통해 시작할 작업을 넘긴다. 이때 두 개 이상의 작업을 동시에 시작하려면 List에 담아 넘겨준다.

위 작업이 끝나면 시작할 작업들을 then() 메소드를 통해 작성한다. then() 메소드를 통해 계속 체이닝할 수 있다.

작업 큐에 보낼 테스크를 모두 작성하였으면, enqueue() 메소드를 통해 큐에 최종적으로 추가하여 작업을 실행한다.

 

val work1 = OneTimeWorkRequestBuilder<Work1Worker>().build()
// ... val work2 ~

// workManager is WorkManager Instance.
workManager
    .beginWith(listOf(work1, work2))
    .then(work3)
    .then(work4)
    .enqueue()

 

 

📌 Worker와 데이터 주고받기

 Key-Value 쌍으로 이루어진 Worker의 Data로 데이터를 담아 Worker로 보낼 수 있으며 작업이 완료된 후 데이터를 받아올 수 있다.

 

 WorkRequest에 setInputData() 메소드를 통해 Data를 보낼 수 있으며, 이때 Data를 만들 때에는 Data.Builder()를 사용한다.

 Worker 클래스의 생성자인 WorkerParameters로 데이터는 전달되며, getInputData()[=inputData in Kotlin] 메소드를 통해 쉽게 받아올 수 있다.

 작업을 완료(성공)한 후에 Result.success() 메소드에 Data를 전달한다.

 

 Data를 만들 때 Data.Builder()를 편하게 작성해주는 함수인 workDataOf()도 존재하며, 아래 Worker 클래스에서 확인해보자.

빌더를 통한 생성은 WorkRequest에 Input할 때 확인 할 수 있다.

 

 Worker에서 전달된 데이터는 WorkInfo에서 확인할 수 있다.

 

// input data for worker
val inputData = Data.Builder().apply {
        putString("secret_key", "genius-dev")
        build()
	}

val workRequest = OneTimeWorkRequestBuilder<SomeWorker>()
    .setInputData(inputData)
    .build()

workManager.enqueue(workRequest)


// in Worker
class BlurWorker(ctx: Context, params: WorkerParameters) : Worker(ctx, params) {
    override fun doWork(): Result {
    	val secretKey = inputData.getString("secret_key")
        
        //..
        
        val outputData = workDataOf("public_key" to "android")
        
        Result.success(outputData)
    }
}

// in view(activity, fragment) or viewmodel
workInfos.observe(lifecycleOwner) { workInfos ->
    if (listOfWorkInfo.isNullOrEmpty()) return@observe
    val workInfo = workInfos[0]
    
    if (workInfo.state.isFinished) {
    	hideProgressBar()
        
        val outputData = workInfo.outputData.getString("public_key") // <<<< HERE
        
        Toast.makeText(this, "worker output data : $outputData", Toast.LENGTH_SHORT).show()
    } else {
    	showProgressBar()
    }
}

 

 

---

📕 References

공식 문서 - WorkManager로 작업 예약

Android Codelabs - WorkManager

공식 문서 - 백그라운드 처리 가이드

GM.Lim(@limgyumin) Blog

공식 문서 - 작업 요청 정의