应用启动 Android Jetpack 的一部分。
借助 App Startup 库,可在应用启动时简单、高效地初始化组件。库开发者和应用开发者都可以使用 App Startup 来简化启动序列并明确设置初始化顺序。
借助 App Startup,您可以定义共用一个 content provider 的组件初始化程序,而无需为需要初始化的每个组件定义单独的 content provider。这可以显著缩短应用启动时间。
初始设置
如需在您的库或应用中使用 Jetpack Startup,请将以下代码添加到 Gradle 文件中:
Groovy
dependencies { implementation "androidx.startup:startup-runtime:1.1.1" }
Kotlin
dependencies { implementation("androidx.startup:startup-runtime:1.1.1") }
在应用启动时初始化组件
应用和库通常依赖于在应用启动时立即初始化组件。您可以通过使用 content provider 初始化每个依赖项来满足此需求,但 content provider 的实例化成本高昂,并且可能会不必要地减慢启动序列的速度。此外,Android 还会以不确定的顺序初始化 content provider。应用启动提供了一种更高效的方式,让您能够在应用启动时初始化组件并明确定义其依赖项。
如需使用应用启动在启动时自动初始化组件,您必须为应用需要初始化的每个组件定义一个组件初始化程序。
实现组件初始化器
您可以通过创建一个实现 Initializer<T>
接口的类来定义每个组件初始化程序。此接口定义了两个重要的方法:
create()
方法,包含初始化组件并返回T
实例所需的所有操作。dependencies()
方法,用于返回初始化程序所依赖的其他Initializer<T>
对象的列表。您可以使用此方法控制应用在启动时运行初始化程序的顺序。
例如,假设您的应用依赖于 WorkManager
并且需要在启动时对其进行初始化。定义一个实现 Initializer<WorkManager>
的 WorkManagerInitializer
类:
Kotlin
// Initializes WorkManager. class WorkManagerInitializer : Initializer<WorkManager> { override fun create(context: Context): WorkManager { val configuration = Configuration.Builder().build() WorkManager.initialize(context, configuration) return WorkManager.getInstance(context) } override fun dependencies(): List<Class<out Initializer<*>>> { // No dependencies on other libraries. return emptyList() } }
Java
// Initializes WorkManager. class WorkManagerInitializer implements Initializer<WorkManager> { @Override public WorkManager create(Context context) { Configuration configuration = Configuration.Builder().build(); WorkManager.initialize(context, configuration); return WorkManager.getInstance(context); } @Override public List<Class<Initializer<?>>> dependencies() { // No dependencies on other libraries. return emptyList(); } }
dependencies()
方法会返回一个空列表,因为 WorkManager
不依赖于任何其他库。
假设您的应用还依赖于一个名为 ExampleLogger
的库,而该库又依赖于 WorkManager
。此依赖项意味着您需要确保应用启动首先初始化 WorkManager
。定义一个实现 Initializer<ExampleLogger>
的 ExampleLoggerInitializer
类:
Kotlin
// Initializes ExampleLogger. class ExampleLoggerInitializer : Initializer<ExampleLogger> { override fun create(context: Context): ExampleLogger { // WorkManager.getInstance() is non-null only after // WorkManager is initialized. return ExampleLogger(WorkManager.getInstance(context)) } override fun dependencies(): List<Class<out Initializer<*>>> { // Defines a dependency on WorkManagerInitializer so it can be // initialized after WorkManager is initialized. return listOf(WorkManagerInitializer::class.java) } }
Java
// Initializes ExampleLogger. class ExampleLoggerInitializer implements Initializer<ExampleLogger> { @Override public ExampleLogger create(Context context) { // WorkManager.getInstance() is non-null only after // WorkManager is initialized. return ExampleLogger(WorkManager.getInstance(context)); } @Override public List<Class<Initializer<?>>> dependencies() { // Defines a dependency on WorkManagerInitializer so it can be // initialized after WorkManager is initialized. return Arrays.asList(WorkManagerInitializer.class); } }
由于您在 dependencies()
方法中添加了 WorkManagerInitializer
,因此 App Startup 会在 ExampleLogger
之前初始化 WorkManager
。
设置清单条目
App Startup 包含一个名为 InitializationProvider
的特殊 content provider,它可用于发现和调用组件初始化程序。应用启动功能会首先检查 InitializationProvider
清单条目下是否有 <meta-data>
条目,从而发现组件初始化程序。然后,应用启动会针对其已发现的所有初始化程序调用 dependencies()
方法。
这意味着,为了让应用启动能够发现组件初始化程序,必须满足以下条件之一:
- 组件初始化程序在
InitializationProvider
清单条目下具有相应的<meta-data>
条目。 - 组件初始化程序列在已发现的初始化程序的
dependencies()
方法中。
我们再来看一下带有 WorkManagerInitializer
和 ExampleLoggerInitializer
的示例。为了确保应用启动能够发现这些初始化程序,请将以下内容添加到清单文件中:
<provider
android:name="androidx.startup.InitializationProvider"
android:authorities="${applicationId}.androidx-startup"
android:exported="false"
tools:node="merge">
<!-- This entry makes ExampleLoggerInitializer discoverable. -->
<meta-data android:name="com.example.ExampleLoggerInitializer"
android:value="androidx.startup" />
</provider>
您无需为 WorkManagerInitializer
添加 <meta-data>
条目,因为 WorkManagerInitializer
是 ExampleLoggerInitializer
的依赖项。这意味着,如果 ExampleLoggerInitializer
可被检测到,那么 WorkManagerInitializer
也可供检测到。
tools:node="merge"
属性可确保清单合并工具正确解析任何冲突的条目。
运行 lint 检查
App Startup 库包含一组 lint 规则,可用于检查是否已正确定义组件初始化程序。您可以通过从命令行运行 ./gradlew :app:lintDebug
来执行这些 lint 检查。
手动初始化组件
通常,当您使用应用启动时,InitializationProvider
对象会使用名为 AppInitializer
的实体在应用启动时自动发现并运行组件初始化程序。不过,您也可以直接使用 AppInitializer
,以便手动初始化应用在启动时不需要的组件。这称为“延迟初始化”,有助于最大限度地降低启动费用。
您必须先为要手动初始化的任何组件停用自动初始化功能。
为单个组件停用自动初始化
如需停用单个组件的自动初始化功能,请从清单中移除该组件初始化程序的 <meta-data>
条目。
例如,将以下代码添加到清单文件中,可停用 ExampleLogger
的自动初始化功能:
<provider
android:name="androidx.startup.InitializationProvider"
android:authorities="${applicationId}.androidx-startup"
android:exported="false"
tools:node="merge">
<meta-data android:name="com.example.ExampleLoggerInitializer"
tools:node="remove" />
</provider>
您需要在该条目中使用 tools:node="remove"
,而不是简单地移除该条目,以确保合并工具也会从所有其他合并后的清单文件中移除该条目。
为所有组件停用自动初始化
如需停用所有自动初始化功能,请从清单中移除 InitializationProvider
的整个条目:
<provider
android:name="androidx.startup.InitializationProvider"
android:authorities="${applicationId}.androidx-startup"
tools:node="remove" />
手动调用组件初始化程序
如果某个组件的自动初始化功能已停用,您可以使用 AppInitializer
手动初始化该组件及其依赖项。
例如,以下代码会调用 AppInitializer
并手动初始化 ExampleLogger
:
Kotlin
AppInitializer.getInstance(context) .initializeComponent(ExampleLoggerInitializer::class.java)
Java
AppInitializer.getInstance(context) .initializeComponent(ExampleLoggerInitializer.class);
因此,应用启动还会初始化 WorkManager
,因为 WorkManager
是 ExampleLogger
的依赖项。
提供反馈
通过以下资源与我们分享您的反馈和想法:
- 问题跟踪器
- 报告问题,以便我们可以修复错误。
为您推荐
- 注意:当 JavaScript 处于关闭状态时,系统会显示链接文字
- 应用架构:数据层 - 使用 WorkManager 调度任务 - Android 开发者
- 应用架构:数据层 - DataStore - Android 开发者