WorkManager

koin-androidx-workmanagerプロジェクトは、Android WorkManagerの機能を提供することに特化しています。

WorkManager DSL

WorkManagerをセットアップする

開始時に、KoinApplicationの宣言でworkManagerFactory()キーワードを使用して、カスタムのWorkManagerインスタンスをセットアップします。

class MainApplication : Application(), KoinComponent {

    override fun onCreate() {
        super.onCreate()

        startKoin {
            // setup a WorkManager instance
            workManagerFactory()
            modules(...)
        }

        setupWorkManagerFactory()
}

AndroidがデフォルトのWorkManagerFactoryを初期化するのを防ぐために、AndroidManifest.xmlを編集することも重要です。これは、https://developer.android.com/topic/libraries/architecture/workmanager/advanced/custom-configuration#remove-default に示されている通りです。そうしないと、アプリがクラッシュします。

    <application . . .>
        . . .
        <provider
            android:name="androidx.startup.InitializationProvider"
            android:authorities="${applicationId}.androidx-startup"
            android:exported="false"
            tools:node="merge">
            <meta-data
                android:name="androidx.work.WorkManagerInitializer"
                android:value="androidx.startup"
                tools:node="remove" />
        </provider>
    </application>

ListenableWorkerを宣言する

val appModule = module {
    single { MyService() }
    worker { MyListenableWorker(get()) }
}

追加のWorkManagerファクトリを作成する

WorkManagerFactoryを記述して、Koinに渡すこともできます。それはデリゲートとして追加されます。

class MainApplication : Application(), KoinComponent {

    override fun onCreate() {
        super.onCreate()

        startKoin {
           workManagerFactory(workFactory1, workFactory2)
           . . .
        }

        setupWorkManagerFactory()
    }
}

KoinとworkFactory1の両方が提供するWorkManagerFactoryがListenableWorkerをインスタンス化できる場合、Koinによって提供されるファクトリが使用されます。

いくつかの仮定

Koinライブラリ自体にマニフェストの変更を追加する

koin-androidx-workmanager自身のマニフェストがデフォルトのワークマネージャーを無効にする場合、アプリケーション開発者にとって手間を1つ減らすことができます。しかし、アプリ開発者がKoinのワークマネージャーインフラストラクチャを初期化しない場合、利用可能なワークマネージャーファクトリがなくなってしまうため、それは紛らわしい可能性があります。

それはcheckModulesが役立つかもしれません。プロジェクト内のいずれかのクラスがListenableWorkerを実装している場合、マニフェストとコードの両方を検査し、それらが適切であることを確認すべきでしょうか？

DSL改善オプション:

val workerFactoryModule = module {
   factory<WorkerFactory> { WorkerFactory1() }
   factory<WorkerFactory> { WorkerFactory2() }
}

その後、Koinの内部が以下のような処理を行うようにします。

fun Application.setupWorkManagerFactory(
  // no vararg for WorkerFactory
) {
. . .
            getKoin().getAll<WorkerFactory>()
                .forEach {
                    delegatingWorkerFactory.addFactory(it)
                }
}