안드로이드 앱 만들기 : workmanager kotlin api (번역)

https://medium.com/androiddevelopers/workmanager-kotlin-apis-a0fb9dfbfeb6

WorkManager — Kotlin APIs

 

이제 kotlin 으로 전향(?)을 하기 위해서 배우기 시작...

오늘은 medium 에서 보내온 메일 내용 중에 workmanger 관련된 자료가 있어서 번역을 해 볼까 한다. 

먼저 글을 작성해 주신 분께... 감사합니다. 

 

 먼저 workManager 에 대해서 이해을 해야 한다면... 작업관리자 라고 이해를 하면 되지 않을 까 한다. 나의 앱에서 반복적인 작업을 해야 하는 경우, 작업관리자를 통해서 일회성, 주기적인 반복작업을 나의 앱에 일을 시킬 수 있게 된다. 

이제 어떻게 저자는 설명을 하는 지 읽어보고, 이해를 해 보도록 하겠다.

 

--- 번역글 ---

WorkManager — Kotlin API

WorkManager 는 앱이 닫히거나 장치가 다시 시작되는 경우에도 실행될 것으로 예상되는 즉시 또는 지연된 실행을 위한 비동기 작업을 쉽게 예약할 수 있는 API 세트를 제공합니다. Kotlin 사용자의 경우 WorkManager는 kotlin 에 대한 최고 수준의 지원을 제공합니다. 이 게시물에서는 WorkManager codelab 을 기반으로 하여 kotlin 이 있는 WorkManager의 기본 사항을 보여 드리겠습니다.시작하겠습니다!

 

WorkManager의 기본

WorkManager 라이브러리는 사용자가 특정 화면에서 벗어나거나 사용자가 애플리케이션을 백그라운드로 설정하거나 장치를 다시 시작하더라도 계속 실행되어야 하는 모든 작업에 권장되는 선택입니다. 일반적인 작업은 다음과 같습니다.

• 로그 업로드 또는 보고 데이터
• 이미지에 필터 적용 및 이미지 저장
• 주기적으로 로컬 데이터를 네트워크와 동기화

사용자가 화면과 같은 특정 범위를 벗어나면 즉각적인 작업이 종료될 수 있는 경우 Kotlin Coroutine을 직접 사용하는 것이 좋습니다.

WorkManager 코드 랩은 이미지를 흐리게 처리하고 결과를 디스크에 저장합니다. 이를 달성하기 위해 무엇이 필요했는지 봅시다.

 

work-runtime-ktx종속성을 추가했습니다.

 

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

 

우리는 우리 자신의 Worker 클래스를 구현하는 것으로 시작했습니다. 여기에 백그라운드에서 수행하려는 실제 작업에 대한 코드를 넣습니다. Worker 클래스를 확장하고 doWork() 메서드를 재정의합니다. 이것은 가장 중요한 수업이므로 나중에 자세히 다루겠습니다. 초기 구현은 다음과 같습니다.

 

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

class BlurWorker(ctx: Context, params: WorkerParameters) : Worker(ctx, params) {

    suspend fun doWork(): Result {
        val resourceUri = inputData.getString(KEY_IMAGE_URI)

        return try {
            if (resourceUri.isNullOrEmpty()) {
                Timber.e("Invalid input uri")
                throw IllegalArgumentException("Invalid input uri")
            }

            val outputData = blurAndWriteImageToFile(resourceUri)
            Result.success(outputData)
        } catch (throwable: Throwable) {
            Timber.e(throwable, "Error applying blur")
            Result.failure()
        }
    }
…
}

그런 다음 작업 요청을 작성합니다. 우리의 경우 작업을 한 번만 수행하기를 원하므로 OneTimeWorkRequest.Builder. 입력 Uri으로 흐리게 처리하려는 이미지를 설정합니다.

Kotlin 팁: 입력 데이터 workDataOf를 생성하기 위해 데이터 빌더를 생성하고 키-값 쌍을 넣고 데이터를 생성하는 함수를 사용할 수 있습니다.

 

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

val blurBuilder = OneTimeWorkRequestBuilder<BlurWorker>()
val data = workDataOf(KEY_IMAGE_URI to imageUri.toString())
blurBuilder.setInputData(data)

작업을 예약하고 실행하기 위해 WorkManager 클래스를 사용합니다. 우리는 수행해야 할 작업과 이러한 작업에 대한 제약 조건을 제공할 수 있습니다.

 

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

val workManager = WorkManager.getInstance(application)
val continuation = workManager.beginUniqueWork(blurBuilder.build())
// Actually start the work
continuation.enqueue()

작업자가 작업을 수행하도록 하십시오.

를 사용하면 WorkerWorkManager가 자동으로 Worker.doWork()백그라운드 스레드를 호출합니다. Result반환된 에서 작업 doWork()이 성공했는지 여부와 실패한 경우 작업을 다시 시도해야 하는지 여부를 WorkManager 서비스에 알립니다.

Worker.doWork() 동기 호출입니다. 차단 방식으로 전체 백그라운드 작업을 수행하고 메서드가 종료될 때까지 완료해야 합니다. doWork()에서 비동기 API를 호출하고 결과를 반환하면 콜백이 제대로 작동하지 않을 수 있습니다.

하지만 비동기 작업을 하려면 어떻게 해야 할까요?

예제를 복잡하게 만들고 데이터베이스에서 흐리게 처리된 모든 파일의 Uris를 저장하려고 한다고 가정해 보겠습니다.

이를 위해 다음을 만들었습니다.

• 간단한 BluredImage 엔터티
• 이미지를 삽입하고 가져오는 dao 클래스
• 데이터베이스

여기에서 구현을 확인하십시오.

데이터베이스에 데이터를 저장하거나 네트워크 요청을 수행하는 것과 같은 비동기 작업을 수행해야 하는 경우 Kotlin에서 CoroutineWorker.

CoroutineWorker를 사용하면 Kotlin 코 루틴을 사용하여 비동기 작업을 수행할 수 있습니다.

doWork() 방법은방법 suspend입니다. 그래서 이것은 우리가 여기에서 정지된 도를 쉽게 호출할 수 있음을 의미합니다.

 

/* Copyright 2020 Google LLC.	
   SPDX-License-Identifier: Apache-2.0 */

class BlurWorker(ctx: Context, params: WorkerParameters) : CoroutineWorker(ctx, params) {

    override suspend fun doWork(): Result {
        val resourceUri = inputData.getString(KEY_IMAGE_URI)

        return try {
            if (resourceUri.isNullOrEmpty()) {
                Timber.e("Invalid input uri")
                throw IllegalArgumentException("Invalid input uri")
            }

            val outputData = blurAndWriteImageToFile(resourceUri)

            // save uri in the database 
           val imageDao =     ImagesDatabase.getDatabase(applicationContext).blurredImageDao()
            imageDao.insert(BlurredImage(resourceUri))

            Result.success(outputData)
        } catch (throwable: Throwable) {
            Timber.e(throwable, "Error applying blur")
            Result.failure()
        }
    }
...
}

기본적으로 doWork()를 사용합니다 Dispatchers.Default. 필요한 Dispatcher로 이를 재정의할 수 있습니다. 우리의 경우 Room이 이미 삽입 작업을 다른 Dispatcher로 이동하기 때문에 이 작업을 수행할 필요가 없습니다. 자세한 내용은 Room Kotlin API 게시물을 확인하세요.

 

CoroutineWorker사용자가 앱을 닫아도 완료해야 하는 비동기 작업을 수행하려면 사용을 시작하세요.

WorkManager에 대해 더 자세히 알고 싶다면 이를 심층적으로 다룰 향후 시리즈를 계속 지켜봐 주십시오. 그때까지 코드 랩과 문서를 확인하세요.

• WorkManager 문서
• WorkManager 코드랩 작업
• 고급 WorkManager 코드랩

 

--- 번역글 끝 ---

 

 

작성자님의 노고(?)에 감사드리면서... 덕분에 잘 배워 보도록 하겠습니다.