默认情况下,WorkManager 会在您的应用启动时自动配置自身,使用适用于大多数应用的合理选项。如果您需要对 WorkManager 管理和调度工作的方式进行更多控制,可以通过自行初始化 WorkManager 来自定义 WorkManager 配置。
按需初始化
按需初始化让您只在需要 WorkManager 组件时才创建它,而不是在应用每次启动时都创建。这样做将 WorkManager 移出了关键启动路径,从而提高了应用启动性能。要使用按需初始化
移除默认初始化器
要提供您自己的配置,您必须首先移除默认初始化器。为此,请使用合并规则 tools:node="remove"
更新 AndroidManifest.xml
。
自 WorkManager 2.6 起,WorkManager 内部使用 App Startup。要提供自定义初始化器,您需要移除 androidx.startup
节点。
如果您的应用不使用 App 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 之前的自定义初始化
对于 WorkManager 2.1.0 之前的版本,有两种初始化选项。在大多数情况下,默认初始化就足够了。如需更精确地控制 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()
参考文档。