Kotlin ユーザー向けに、WorkManager にはコルーチンのサポートが組み込まれています。まず、work-runtime-ktx を Gradle ファイルに追加します。Worker を拡張する代わりに、CoroutineWorker を拡張します。これには、doWork のサスペンド バージョンが含まれています。たとえば、ネットワーク オペレーションを実行するシンプルな CoroutineWorker を作成するには、次の手順を行います。
class CoroutineDownloadWorker(
context: Context,
params: WorkerParameters
) : CoroutineWorker(context, params) {
override suspend fun doWork(): Result {
val data = downloadSynchronously("https://www.google.com")
saveData(data)
return Result.success()
}
}
CoroutineWorker.doWork() は suspending 関数です。Worker とは異なり、このコードは Configuration で指定された Executor では実行されません。代わりに、デフォルトで Dispatchers.Default に設定されます。これは、独自の CoroutineContext を指定することでカスタマイズできます。上記の例では、次のように Dispatchers.IO でこの処理を行う必要があります。
class CoroutineDownloadWorker(
context: Context,
params: WorkerParameters
) : CoroutineWorker(context, params) {
override suspend fun doWork(): Result {
withContext(Dispatchers.IO) {
val data = downloadSynchronously("https://www.google.com")
saveData(data)
return Result.success()
}
}
}
CoroutineWorker は、コルーチンをキャンセルしてキャンセル信号を伝達することにより、停止を自動的に処理します。処理の停止に対処するために特別な操作は必要ありません。
CoroutineWorker を別のプロセスで実行する
ListenableWorker の実装である RemoteCoroutineWorker を使用して、ワーカーを特定のプロセスにバインドすることもできます。
RemoteCoroutineWorker は、2 つの引数 ARGUMENT_CLASS_NAME と ARGUMENT_PACKAGE_NAME を追加で使用して、特定のプロセスにバインドします。これらの引数は、処理リクエストの作成時に入力データの一部として指定します。
次の例は、特定のプロセスにバインドされた処理リクエストの作成を示しています。
Kotlin
val PACKAGE_NAME = "com.example.background.multiprocess"
val serviceName = RemoteWorkerService::class.java.name
val componentName = ComponentName(PACKAGE_NAME, serviceName)
val data: Data = Data.Builder()
.putString(ARGUMENT_PACKAGE_NAME, componentName.packageName)
.putString(ARGUMENT_CLASS_NAME, componentName.className)
.build()
return OneTimeWorkRequest.Builder(ExampleRemoteCoroutineWorker::class.java)
.setInputData(data)
.build()
Java
String PACKAGE_NAME = "com.example.background.multiprocess";
String serviceName = RemoteWorkerService.class.getName();
ComponentName componentName = new ComponentName(PACKAGE_NAME, serviceName);
Data data = new Data.Builder()
.putString(ARGUMENT_PACKAGE_NAME, componentName.getPackageName())
.putString(ARGUMENT_CLASS_NAME, componentName.getClassName())
.build();
return new OneTimeWorkRequest.Builder(ExampleRemoteCoroutineWorker.class)
.setInputData(data)
.build();
また、RemoteWorkerService ごとに、AndroidManifest.xml ファイルにサービス定義を追加する必要もあります。
<manifest ... >
<service
android:name="androidx.work.multiprocess.RemoteWorkerService"
android:exported="false"
android:process=":worker1" />
<service
android:name=".RemoteWorkerService2"
android:exported="false"
android:process=":worker2" />
...
</manifest>