Lesson 12: Repository pattern and WorkManager

💡 Teach Android Development

구글에서 제공하는 교육자료를 정리하기 위한 포스트입니다.

Android Development Resources for Educators

Repository pattern

Existing app architecture

ViewModel안에 데이터베이스 처리를 위한 DAO 객체에 직접 참조가 포함되어 있습니다.

앱이 네트워크, 데이터베이스 등 외부 리소스에서 데이터를 가져와야 하는 경우 ViewModel에 추가해야 하며 추가적인 확장에 어려움이 있습니다. 또한 ViewModel이 복잡해지며 직접 데이터 검색을 처리하는 것을 원하지 않습니다.

Relative data speeds

Cache network responses

시간이 오래 걸릴 수 있는 네트워크 요청을 위해 로컬 저장소에 네트워크 응답 캐싱을 고려할 수 있습니다.

• 네트워크 요청 시간이 긴 것을 고려하여 여전히 사용자에게 응답합니다.
• 네트워크에서 검색하는 데 비용이 많이 들거나 어려울 수 있는 경우 로컬에서 Room을 사용합니다.
• LRU(least recently used) 값, FRU(frequently accessed) 값 또는 기타 알고리즘을 기반으로 캐시 할 수 있습니다.

Repository pattern

• 호출자로부터 여러 data source를 추상화할 수 있습니다.
• 전송하는 동안 로컬 데이터베이스를 사용하여 빠른 검색을 지원합니다.
• 데이터 새로 고침을 위한 네트워크 요청.(더 오래 걸릴 수 있음)
• 앱에서 별도로 data source를 테스트할 수 있습니다.

App architecture with repository pattern

Repository는 data source와 앱 사이에 추상화 계층을 추가합니다. 이는 앱 아키텍처에서 이야기한 관심사 분리 원칙을 따릅니다.

Repository를 추가하면서 새로운 data source가 추가되는 경우 앱의 확장성이 향상됩니다. Repository만 변경하면 되고 그 위에 다른 구성 요소(UI controller, ViewModel)는 대부분 동일하게 유지됩니다.

또한 data soucre를 mock 하여 테스트를 진행할 수 있습니다.

Implement a repository class

• 데이터 액세스를 위한 공통 인터페이스 제공.
  • 기본 데이터를 검색하고 수정하기 위한 함수 노출.
• data source에 따라 Repository는 다음을 수행할 수 있습니다.
  • 데이터가 데이터베이스에 있는 경우, DAO에 대한 참조를 유지합니다.
  • 웹 서비스에 연결하는 경우 네트워크 요청을 만듭니다.

WorkManager

• Android Jetpack architecture 구성요소.
• 백그라운드 작업을 실행하기 위한 권장 솔루션.(즉시 또는 연기)
• 기회주의적이고(가능한 빠르게 백그라운드 작업 수행) 보장된 실행.
• 특정 조건에 따라 실행 가능.

When to use WorkManager

Immediate tasks : 사용자 데이터를 서버에 동기화하는 것과 같이 즉시 실행해야 하는 작업. 사용자가 취소할 수 있는 작업의 경우 Coroutines을 사용하는 것이 좋습니다.

Deferred tasks : 사용자 상호 작용에 직접 연결되지 않고 나중에 실행할 수 있는 모든 작업. WorkManager를 사용하는 것이 좋습니다.

Exact tasks : 작업이 특정 미래 시간에 실행되어야 하는 경우 AlarmManager를 사용하는 것이 좋습니다.

Declare WorkManager dependencies

implementation "androidx.work:work-runtime-ktx:$work_version"

Important classes to know

Worker : 백그라운드 스레드에서 작업을 수행하고 doWork() 메서드를 재정의합니다.
WorkRequest : 작업 요청.
Constraint : 작업을 실행할 수 있는 조건.
WorkManager : WorkRequest가 실행되도록 예약합니다.

Define the work

Worker 클래스를 서브클래싱하고 doWork()를 재정의합니다.

class UploadWorker(appContext: Context, workerParams: WorkerParameters) :
       Worker(appContext, workerParams) {

    override fun doWork(): Result {

       // Do the work here. In this case, upload the images.
       uploadImages()

       // Indicate whether work finished successfully with the Result
       return Result.success()
   }
}

Extend CoroutineWorker instead of Worker

WorkManager는 기본적으로 코루틴을 지원합니다. CoroutineWorker를 서브클래싱하고 doWork()를 일시 중단 함수로 구현해야 합니다.

class UploadWorker(appContext: Context, workerParams: WorkerParameters) :
       CoroutineWorker(appContext, workerParams) {

   override suspend fun doWork(): Result {

       // Do the work here (in this case, upload the images)
       uploadImages()

       // Indicate whether work finished successfully with the Result
       return Result.success()
   }
}

WorkRequests

• 한 번 또는 반복적으로 실행되도록 예약할 수 있습니다.
  • OneTimeWorkRequest
  • PeriodicWorkRequest
• 기기 재부팅 시 지속됨.
• 순차적으로 또는 병렬로 실행되도록 연결 가능.
• 실행될 제약 조건을 가질 수 있습니다.

Schedule a OneTimeWorkRequest

WorkRequest를 생성합니다.

val uploadWorkRequest: WorkRequest =
   OneTimeWorkRequestBuilder<UploadWorker>()
       .build()

WorkManager queue에 작업을 더해줍니다.

WorkManager.getInstance(myContext)
    .enqueue(uploadWorkRequest)

Schedule a PeriodicWorkRequest

• 반복 interval 설정
• 가변 interval 설정(optional)

Flex interval

예를 들어 작업 요청이 하루에 한 번 실행되기를 원한다고 했을 때 PeriodicWorkRequest를 사용해 설정할 수 있습니다. 그러나 첫 번째는 오후 11시 50분, 다음날 오전 12시 10분에 작업을 실행할 수 있는 경우가 발생할 수 있습니다. 이러한 결과는 작업 요청의 의도가 아닐 수 있습니다.

작업 요청이 대략 하루 간격으로 실행되도록 하려면 가변 간격을 사용합니다. 가변 기간은 repeatInterval - flexInterval에서 시작하여 간격이 끝날 때까지입니다. 플렉스와 반복을 함께 사용하면 가상의 예를 들어 매일 마지막 시간에 실행되도록 예약된 작업을 만들 수 있습니다.

두 번째 예는 특정 가변 간격 내에서 실행되도록 반복 간격을 조정하는 방법을 보여줍니다. 이 시나리오를 사용하면 요청이 약 하루 간격으로 실행될 것이라고 확신할 수 있습니다.

PeriodicWorkRequest example

가변 기간으로 주기적 작업을 정의하려면 PeriodicWorkRequest를 생성할 때 repeatInterval과 함께 flexInterval을 전달합니다. 플렉스 기간은 repeatInterval - flexInterval에서 시작하여 간격이 끝날 때까지입니다.

반복 간격은 PeriodicWorkRequest.MIN_PERIODIC_INTERVAL_MILLIS보다 크거나 같아야 하고 가변 간격은 PeriodicWorkRequest.MIN_PERIODIC_FLEX_MILLIS보다 크거나 같아야 합니다.

아래 예시는 매 1시간을 기준으로 마지막 15분 동안 실행됩니다.

val repeatingRequest = PeriodicWorkRequestBuilder<RefreshDataWorker>(
        1, TimeUnit.HOURS,    // repeatInterval
        15, TimeUnit.MINUTES  // flexInterval
    ).build()

Enqueue periodic work

정기 작업은 고유한 이름으로 식별되어야 하며 기존 요청에 동일한 이름이 있는 경우 이 요청을 무시할지 이전 요청을 취소하고 대체할지 여부를 나타내는 ExistingPeriodicWorkPolicy가 포함되어야 합니다.

ExistingPeriodicWorkPolicy: 충돌 시 고유한 PeriodicWorkRequest에 사용할 수 있는 충돌 해결 정책을 열거합니다.

ExistingPeriodicWorkPolicy.KEEP: 동일한 고유 이름을 가진 기존 보류(완료되지 않은) 작업이 있는 경우 아무 작업도 수행하지 않습니다. 그렇지 않으면 새로 지정된 작업을 삽입하십시오.

ExistingPeriodicWorkPolicy.REPLACE: 동일한 고유 이름을 가진 기존 보류(미완료) 작업이 있는 경우 취소 및 삭제 후 새로 지정된 작업을 삽입합니다.

WorkManager.getInstance().enqueueUniquePeriodicWork(
    "Unique Name",
    ExistingPeriodicWorkPolicy.KEEP, // or REPLACE 
    repeatingRequest
)

Work input and output

Define Worker with input and output

작업을 수행하기 위해 입력 데이터가 필요할 수 있습니다. 입력 값은 데이터 객체에 key-value 쌍으로 저장되며 작업 요청 시 설정할 수 있습니다.

입력 값의 경우 inputData 객체에 접근하여 처리하고 결과는 Result.success(output)을 사용하여 작업의 출력으로 설정됩니다.

class MathWorker(context: Context, params: WorkerParameters):
      CoroutineWorker(context, params)  {

    override suspend fun doWork(): Result {
        val x = inputData.getInt(KEY_X_ARG, 0)
        val y = inputData.getInt(KEY_Y_ARG, 0)
        val result = computeMathFunction(x, y)
        val output: Data = workDataOf(KEY_RESULT to result)
        return Result.success(output)
    }
}

Result output from doWork()

doWork()에서 반환되는 Result 객체의 경우 성공과 실패 선택적으로 출력 Data 객체를 반환할 수 있습니다.

Send input data to Worker

WorkRequest를 통해 inputData를 Worker에 전달합니다.

val complexMathWork = OneTimeWorkRequest<MathWorker>()
   .setInputData(
       workDataOf(
           "X_ARG" to 42,
           "Y_ARG" to 421,
       )
   ).build()

WorkManager.getInstance(myContext).enqueue(complexMathWork)

WorkRequest constraints

Constraints

Worker가 실행되어야 할 때 제약 조건을 지정할 수 있습니다. Constraints.Builder를 사용하여 WorkRequest 내에서 정의할 수 있습니다.

• setRequiredNetworkType
• setRequiresBatteryNotLow
• setRequiresCharging
• setTriggerContentMaxDelay
• requiresDeviceIdle

Constraints example

setRequiredNetworkType() : 장치가 WorkRequest를 실행할 특정 NetworkType을 가져야 하는지를 설정합니다. NetworkType.UNMETERED는 장치의 네트워크 유형에 데이터 상한 또는 제한이 없음을 의미합니다.(일반적으로 Wi-Fi를 의미함)

setRequiresCharging() : 충전을 위해 기기를 연결해야 하는지.

setRequiresBatteryNotLow() : 장치 배터리가 낮아서는 안 됩니다.

setRequiresDeviceIdle() : WorkRequest를 실행하려면 장치가 유휴 상태여야 합니다.

정기적인 작업에 제약을 적용할 수 있습니다. 이 경우 정의된 반복 간격이 지나도 제약 조건에 충족될 때까지 PeriodicWorkRequest가 실행되지 않습니다.

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

val myWorkRequest: WorkRequest = OneTimeWorkRequestBuilder<MyWork>()
    .setConstraints(constraints)
    .build()