Savedstate

编写可插入组件,以便在进程终止时保存界面状态,并在进程重启时恢复界面状态。
最近更新时间 稳定版 候选版 Beta 版 Alpha 版
2023 年 3 月 22 日 1.2.1 - - -

声明依赖项

如需添加 SavedState 的依赖项,您必须将 Google Maven 仓库添加到项目中。如需了解详情,请参阅 Google 的 Maven 仓库

在应用或模块的 build.gradle 文件中添加所需工件的依赖项:

Groovy

dependencies {
    // Java language implementation
    implementation "androidx.savedstate:savedstate:1.2.1"

    // Kotlin
    implementation "androidx.savedstate:savedstate-ktx:1.2.1"
}

Kotlin

dependencies {
    // Java language implementation
    implementation("androidx.savedstate:savedstate:1.2.1")

    // Kotlin
    implementation("androidx.savedstate:savedstate-ktx:1.2.1")
}

如需详细了解依赖项,请参阅添加 build 依赖项

反馈

您的反馈将帮助我们改进 Jetpack。如果您发现了新问题,或对此库有任何改进建议,请告诉我们。创建新问题前,请先查看此库中的现有问题。您可以点击星标按钮,为现有问题投票。

创建新问题

如需了解详情,请参阅问题跟踪器文档

版本 1.2.1

版本 1.2.1

2023 年 3 月 22 日

发布了 androidx.savedstate:savedstate:1.2.1androidx.savedstate:savedstate-ktx:1.2.1版本 1.2.1 中包含这些提交内容。

依赖项更新

版本 1.2.0

版本 1.2.0

2022 年 6 月 29 日

发布了 androidx.savedstate:savedstate:1.2.0androidx.savedstate:savedstate-ktx:1.2.0版本 1.2.0 中包含这些提交内容

自 1.1.0 以来的重要变更

  • SavedStateRegistryController 现在允许通过 performAttach() 提前附加 SavedStateRegistry
  • 现在,您可以通过 getSavedStateProvider()SavedStateRegistry 检索之前注册的 SavedStateProvider
  • 用 Kotlin 重写了 SavedState 库。
    • SavedStateRegistryOwner而言,对于用 Kotlin 编写的类,这项变更与源代码不兼容。现在,您必须替换 savedStateRegistry 属性,而不是实现之前的 getSavedStateRegistry() 函数。
    • ViewTreeSavedStateRegistryOwner而言,对于用 Kotlin 编写的类,这项变更与源代码不兼容。现在,您必须直接在 androidx.savedstate.setViewTreeSavedStateRegistryOwnerandroidx.savedstate.findViewTreeSavedStateRegistryOwnerView 上导入并使用 Kotlin 扩展方法,才能设置和查找之前设置的所有者。这取代了 findViewTreeSavedStateRegistryOwnersavedstate-ktx API。

行为变更

  • 如果没有可保存的状态,SavedStateRegistry 不会再保存空的 Bundle。

版本 1.2.0-rc01

2022 年 5 月 11 日

发布了 androidx.savedstate:savedstate:1.2.0-rc01androidx.savedstate:savedstate-ktx:1.2.0-rc01版本 1.2.0-rc01 中包含这些提交内容

文档变更

  • 更新了 SavedStateRegistryOwner Kdocs,以阐明所有者就如何实现相应接口或何时应在 SavedStateRegistryController 上调用方法需承担的责任或需满足的合同要求。(Iefc95b/228887344

版本 1.2.0-beta01

2022 年 4 月 20 日

发布了 androidx.savedstate:savedstate:1.2.0-beta01androidx.savedstate:savedstate-ktx:1.2.0-beta01版本 1.2.0-beta01 中包含这些提交内容

API 变更

  • 使用 Kotlin 重写了 SavedStateRegistryViewTreeSavedStateRegistryOwner 类。就ViewTreeSavedStateRegistryOwner而言,对于用 Kotlin 编写的类,这项变更与源代码不兼容。现在,您必须直接在 androidx.savedstate.setViewTreeSavedStateRegistryOwnerandroidx.savedstate.findViewTreeSavedStateRegistryOwnerView 上导入并使用 Kotlin 扩展方法,才能设置和查找之前设置的所有者。这取代了 findViewTreeSavedStateRegistryOwnersavedstate-ktx API。对于使用 Java 编程语言编写的实现,这项变更与二进制和源代码兼容。(b/220191285)

版本 1.2.0-alpha02

2022 年 4 月 6 日

发布了 androidx.savedstate:savedstate:1.2.0-alpha02androidx.savedstate:savedstate-ktx:1.2.0-alpha02版本 1.2.0-alpha02 中包含这些提交内容

新功能

  • 现在,您可以通过 getSavedStateProvider()SavedStateRegistry 检索之前注册的 SavedStateProvider。(I7ea47b/215406268

API 变更

  • 使用 Kotlin 重写了 SavedStateRegistryOwnerSavedStateRegistryControllerRecreator 类。就SavedStateRegistryOwner而言,对于使用 Kotlin 编写的类,这项变更与源代码不兼容。现在,您必须替换 savedStateRegistry 属性,而不是实现之前的 getSavedStateRegistry() 函数。对于使用 Java 编程语言编写的实现,这项变更与二进制和源代码兼容。(b/220191285)

版本 1.2.0-alpha01

2022 年 1 月 26 日

发布了 androidx.savedstate:savedstate:1.2.0-alpha01androidx.savedstate:savedstate-ktx:1.2.0-alpha01版本 1.2.0-alpha01 中包含这些提交内容

新功能

  • SavedStateRegistryController 现在允许通过 performAttach() 提前附加 SavedStateRegistry。(Ice4bf)

行为变更

  • 如果没有可保存的状态,SavedStateRegistry 不会再保存空的 Bundle。(aosp/1896865b/203457956

版本 1.1.0

版本 1.1.0

2021 年 2 月 10 日

发布了 androidx.savedstate:savedstate:1.1.0androidx.savedstate:savedstate-ktx:1.1.0版本 1.1.0 中包含这些提交内容

自 1.0.0 以来的重要变更

  • ViewTreeSavedStateRegistryOwner API:新的 ViewTreeSavedStateRegistryOwner.get(View) API 允许您根据 View 实例检索包含的 SavedStateRegistry。您必须升级到 Activity 1.2.0Fragment 1.3.0AppCompat 1.3.0-alpha01 或更高版本,才能正确填充 (populate) 此 API。
  • savedstate-ktx 工件:添加了新的 savedstate-ktx 工件,其中包含用于与 ViewTreeSavedStateRegistryOwner 搭配使用的 findViewTreeSavedStateRegistryOwner() Kotlin 扩展。

版本 1.1.0-rc01

2020 年 12 月 16 日

发布了 androidx.savedstate:savedstate:1.1.0-rc01androidx.savedstate:savedstate-ktx:1.1.0-rc01,这两个版本与 1.1.0-beta01 相比没有变化。版本 1.1.0-rc01 中包含这些提交内容

版本 1.1.0-beta01

2020 年 10 月 1 日

发布了 androidx.savedstate:savedstate:1.1.0-beta01androidx.savedstate:savedstate-ktx:1.1.0-beta01,这两个版本与 1.1.0-alpha01 相比没有变化。版本 1.1.0-beta01 中包含这些提交内容

版本 1.1.0-alpha01

2020 年 5 月 20 日

发布了 androidx.savedstate:savedstate:1.1.0-alpha01androidx.savedstate:savedstate-ktx:1.1.0-alpha01版本 1.1.0-alpha01 中包含这些提交内容

新功能

版本 1.0.0

版本 1.0.0

2019 年 9 月 5 日

发布了 androidx.savedstate:savedstate:1.0.0。点击此处可查看此版本中包含的提交内容。

SavedState 1.0.0 的主要功能

androidx.savedstate 已升级为稳定版本。这组 API 允许开发者将组件以插件形式添加到恢复 /saveInstanceState 进程。该 API 的主要入口点是 SavedStateRegistry,它提供了一种方法来使用 consumeRestoredStateForKey检索之前保存的状态,并注册一个回调,通过调用 registerSavedStateProvider 在系统请求时提供已保存的状态。

版本 1.0.0-rc01

2019 年 7 月 2 日

发布了 androidx.savedstate:savedstate:1.0.0-rc01。点击此处可查看此版本中包含的提交内容。

bug 修复

版本 1.0.0-beta01

2019 年 5 月 7 日

发布了 androidx.savedstate:savedstate:1.0.0-beta01。点击此处可查看此版本中包含的提交内容。

版本 1.0.0-alpha02

2019 年 3 月 13 日

发布了 androidx.savedstate:savedstate:1.0.0-alpha02androidx.savedstate:savedstate 将工件 androidx.savedstate:savedstate-bundleandroidx.savedstate:savedstate-common 合并为一个工件,因为这样可简化 savedstate 基础架构并从 SavedStateRegistry 中移除泛型。因此无需独立模块。

点击此处可查看此版本中包含的完整提交内容列表。

新功能

  • 添加了 SavedStateRegistry.runOnNextRecreaction(Class<? extends AutoRecreated> clazz )。当专属组件重启时,系统会实例化给定类并运行 AutoRecreated.onRecreated 方法。

API 变更

  • 已从 SavedStateRegistry<T> 中移除泛型
  • 移除了 AbstractSavedStateRegistry 和 BundlableSavedStateRegistry,改为使用简单的 SavedStateRegistry
  • 已将 BundleSavedStateRegistryOwner 重命名为 SavedStateRegistryOwner

版本 1.0.0-alpha01

2018 年 12 月 17 日

这是 SavedState 的第一个版本。

新功能

androidx.savedstate 是一组新的 Alpha API,允许开发者将组件以插件形式添加到恢复 /saveInstanceState 进程。该 API 的主要入口点是 SavedStateRegistry<T>,它提供了一种方法来通过 consumeRestoredStateForKey 检索之前保存的状态,并注册一个 registerSavedStateProvider 回调,以便在系统请求时提供已保存的状态。