デフォルトでは、WorkManager はアプリの起動時に自動的に構成され、ほとんどのアプリに適した合理的なオプションが設定されます。WorkManager が作業を管理およびスケジュールする方法を詳細に制御する必要がある場合は、WorkManager を自分で初期化して、WorkManager 構成をカスタマイズできます。
オンデマンド初期化
オンデマンド初期化では、アプリが起動するたびではなく、そのコンポーネントが必要な場合にのみ WorkManager を作成できます。これにより、クリティカルなスタートアップ パスから WorkManager が除外され、アプリのスタートアップのパフォーマンスが向上します。オンデマンド初期化を使用するには、以下の手順を実施します。
デフォルトのイニシャライザを削除する
カスタム構成を設定するには、まずデフォルトのイニシャライザを削除する必要があります。これを行うには、マージルール tools:node="remove" を使用して AndroidManifest.xml を更新します。
WorkManager 2.6 以降では、WorkManager 内で App Startup が内部的に使用されます。カスタム初期化子を指定するには、androidx.startup ノードを削除する必要があります。
アプリでアプリの起動を使用しない場合は、完全に削除できます。
<!-- If you want to disable android.startup completely. -->
<provider
android:name="androidx.startup.InitializationProvider"
android:authorities="${applicationId}.androidx-startup"
tools:node="remove">
</provider>
それ以外の場合は、WorkManagerInitializer ノードのみを削除します。
<provider
android:name="androidx.startup.InitializationProvider"
android:authorities="${applicationId}.androidx-startup"
android:exported="false"
tools:node="merge">
<!-- If you are using androidx.startup to initialize other components -->
<meta-data
android:name="androidx.work.WorkManagerInitializer"
android:value="androidx.startup"
tools:node="remove" />
</provider>
2.6 より前のバージョンの WorkManager を使用している場合は、代わりに workmanager-init を削除します。
<provider
android:name="androidx.work.impl.WorkManagerInitializer"
android:authorities="${applicationId}.workmanager-init"
tools:node="remove" />
マニフェストにおけるマージルールの使用の詳細については、複数のマニフェスト ファイルをマージする方法のドキュメントをご覧ください。
Configuration.Provider を実装する
Application クラスに Configuration.Provider インターフェースを実装させ、Configuration.Provider.getWorkManagerConfiguration の独自の実装を提供します。WorkManager を使用する必要がある場合は、必ず WorkManager.getInstance(Context) メソッドを呼び出してください。WorkManager は、アプリのカスタム getWorkManagerConfiguration メソッドを呼び出して Configuration を検出します。WorkManager.initialize を自分で呼び出す必要はありません。
カスタム getWorkManagerConfiguration() 実装の例を次に示します。
Kotlin
class MyApplication() : Application(), Configuration.Provider {
override fun getWorkManagerConfiguration() =
Configuration.Builder()
.setMinimumLoggingLevel(android.util.Log.INFO)
.build()
}
Java
class MyApplication extends Application implements Configuration.Provider {
@Override
public Configuration getWorkManagerConfiguration() {
return new Configuration.Builder()
.setMinimumLoggingLevel(android.util.Log.INFO)
.build();
}
}
WorkManager 2.1.0 より前のカスタム初期化
バージョン 2.1.0 より前の WorkManager には、2 つの初期化方法があります。ほとんどの場合、デフォルトの初期化だけで十分です。WorkManager をより細かく制御するには、独自の構成を指定します。
デフォルトの初期化
WorkManager は、アプリの起動時に、カスタム ContentProvider により自動的に初期化されます。このコードは内部クラス androidx.work.impl.WorkManagerInitializer にあり、デフォルトの Configuration を使用します。明示的に無効にしない限り、デフォルトの初期化子が自動的に使用されます。デフォルトのイニシャライザは、ほとんどのアプリに適しています。
カスタム初期化
初期化プロセスを制御する場合は、デフォルトの初期化子を無効にして、独自のカスタム構成を定義する必要があります。
デフォルトのイニシャライザを削除したら、WorkManager を手動で初期化できます。
Kotlin
// provide custom configuration
val myConfig = Configuration.Builder()
.setMinimumLoggingLevel(android.util.Log.INFO)
.build()
// initialize WorkManager
WorkManager.initialize(this, myConfig)
Java
// provide custom configuration
Configuration myConfig = new Configuration.Builder()
.setMinimumLoggingLevel(android.util.Log.INFO)
.build();
//initialize WorkManager
WorkManager.initialize(this, myConfig);
WorkManager シングルトンの初期化が Application.onCreate() または ContentProvider.onCreate() で実行されるようにします。
利用可能なカスタマイズの完全なリストについては、Configuration.Builder() のリファレンス ドキュメントをご覧ください。