已儲存狀態

編寫可插入的元件,在程序失敗時儲存 UI 狀態,並在程序重新啟動時還原。
最近更新時間 穩定版 候選版 Beta 版 Alpha 版
2026 年 11 月 18 日 1.5.0 - - 1.6.0-alpha06

宣告依附元件

如要新增 SavedState 的依附元件,您必須在專案中新增 Google Maven 存放區。詳情請參閱 Google 的 Maven 存放區。

在應用程式或模組的 build.gradle 檔案中,新增所需構件的依附元件:

Groovy

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

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

Kotlin

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

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

如要進一步瞭解依附元件,請參閱「新增建構依附元件」一文。

意見回饋

您的意見可協助我們改善 Jetpack。如果您發現新問題,或是有改進這個程式庫的建議,請告訴我們。回報新問題前,請先查看這個程式庫的現有問題。只要按一下星號按鈕,即可投票給現有的問題。

建立新問題

詳情請參閱 Issue Tracker 文件。

1.6 版本

1.6.0-alpha06 版

2026 年 11 月 18 日

發布 androidx.savedstate:savedstate-*:1.6.0-alpha06。1.6.0-alpha06 版本包含這些修訂項目。

API 變更

  • 遷移 LocalSavedStateRegistryOwner 以使用 compositionLocalWithHostDefaultOf 和 SavedStateRegistryOwnerHostDefaultKey,將其與 Android 外部檢視樹狀結構中直接擷取的部分分離。(I6768f)

1.6.0-alpha05 版

2026 年 10 月 21 日

發布 androidx.savedstate:savedstate-*:1.6.0-alpha05。1.6.0-alpha05 版包含這些修訂項目。

API 變更

  • 推出新的 SavedStateContainer API,做為 SaveableStateRegistry、SavedStateHandle 和 SavedStateRegisty 的通用實作基礎。(I1da6d)
  • 在 SavedStateRegistry 中新增 asContainer()、getOrCreateContainer(),允許從 SavedStateRegistry 建立子項容器。(Icb709)

1.6.0-alpha04 版本

2026 年 9 月 23 日

發布 androidx.savedstate:savedstate-*:1.6.0-alpha04。1.6.0-alpha04 版本包含這些修訂版本。

修正錯誤

  • androidx.lifecycle:lifecycle-runtime 依附元件已更新至 2.10.0。如要使用 AGP 9.5.0-alpha04 以上版本執行套裝生命週期執行階段 Lint 檢查,則必須使用這個版本。(I99bfd、b/556807521)

1.6.0-alpha03 版本

2026 年 9 月 9 日

發布 androidx.savedstate:savedstate-*:1.6.0-alpha03。1.6.0-alpha03 版包含這些修訂項目。

API 變更

  • SavedStateRegistry 建構函式允許空值初始狀態。(I76006)

1.6.0-alpha02 版本

2026 年 8 月 26 日

發布 androidx.savedstate:savedstate-*:1.6.0-alpha02。1.6.0-alpha02 版包含這些修訂項目。

API 變更

  • 為 SavedStateRegistry 新增公開建構函式,並讓 SavedStateRegistry 實作 SavedStateProvider 和 SavedStateRestorer。(I3c696)
  • 新增頂層 SavedStateProvider 介面。(I20f9d)
  • 新增頂層 SavedStateRestorer 介面和 restoreState(savedState: SavedState?),並移除未發布的 SavedStateRegistry.SavedStateConsumer。(Idc01d)
  • 淘汰 AutoRecreated 和 runOnNextRecreation,並改用 SavedStateProvider 和 SavedStateRestorer (Iadc00)
  • 在 SavedStateRegistry 上推出 SavedStateConsumer 介面。允許已註冊的供應器在還原期間自動接收及使用還原狀態,或在狀態已還原時立即註冊。(I9a378)

1.6.0-alpha01 版本

2026 年 8 月 12 日

發布 androidx.savedstate:savedstate-*:1.6.0-alpha01。1.6.0-alpha01 版包含這些修訂項目。

修正錯誤

  • 必須使用 Compose UI 1.8.0 以上版本。LocalSavedStateRegistryOwner這會移除內部反射備用機制,提升效能,但會強制用戶端升級依附元件。(I16fb0)

1.5 版本

1.5.0 版本

2026 年 5 月 19 日

發布 androidx.savedstate:savedstate-*:1.5.0。1.5.0 版包含這些修訂項目。

1.4.0 版之後的重要變更:

  • 為 SavedState 物件啟用一般序列化功能,以便在所有平台上使用 CBOR 或 JSON 等標準格式進行編碼和解碼。(Iafda4、b/425919375)
  • 在 SavedStateWriter 和 SavedStateReader 中新增 putKotlinSerializable 和 getKotlinSerializable 擴充功能函式,以便直接使用鍵儲存及擷取 Kotlin Serializable 物件,簡化與 SavedState API 的整合。(Iba02e)
  • 為 LifecycleOwner、ViewModelStoreOwner 和 SavedStateRegistryOwner 新增工廠函式,減少自訂擁有者元件時的樣板。(I9682c)
  • 啟用 rememberSerializable 儲存及還原 SnapshotStateSet (透過 mutableStateSetOf() 建立)。現在可以在 rememberSerializable 中使用 SnapshotStateSet,不需要自訂儲存工具。(I9a4ed、b/449498367)

1.5.0-rc01 版

2026 年 5 月 6 日

發布 androidx.savedstate:savedstate-*:1.5.0-rc01。1.5.0-rc01 版包含以下修訂項目。

1.5.0-beta01 版

2026 年 4 月 22 日

發布 androidx.savedstate:savedstate-*:1.5.0-beta01。1.5.0-beta01 版包含這些修訂項目。

1.5.0-alpha02 版

2026 年 3 月 25 日

發布 androidx.savedstate:savedstate-*:1.5.0-alpha02。1.5.0-alpha02 版包含這些修訂項目。

1.5.0-alpha01 版本

2026 年 3 月 11 日

發布 androidx.savedstate:savedstate-*:1.5.0-alpha01。1.5.0-alpha01 版包含這些修訂項目。

新功能

  • 為 SavedState 物件啟用一般序列化功能,以便在所有平台上使用 CBOR 或 JSON 等標準格式進行編碼和解碼。(Iafda4、b/425919375)

API 變更

  • 在 SavedStateWriter 和 SavedStateReader 中新增 putKotlinSerializable 和 getKotlinSerializable 擴充功能函式,以便直接使用鍵儲存及擷取 Kotlin 可序列化物件,簡化與 SavedState API 的整合。(Iba02e)
  • 為 LifecycleOwner、ViewModelStoreOwner 和 SavedStateRegistryOwner 新增工廠函式,減少自訂擁有者元件時的樣板。(I9682c)
  • 啟用 rememberSerializable 儲存及還原 SnapshotStateSet (透過 mutableStateSetOf() 建立)。現在可以在 rememberSerializable 中使用 SnapshotStateSet,不需要自訂儲存工具。(I9a4ed、b/449498367)

1.4 版

1.4.0 版本

2025 年 11 月 5 日

發布 androidx.savedstate:savedstate-*:1.4.0。1.4.0 版包含此連結所列的修訂項目。

1.4.0-rc01 版本

October 22, 2025

androidx.savedstate:savedstate-*:1.4.0-rc01 自 1.4.0-beta01 版起沒有任何變更。1.4.0-rc01 版包含這些修訂版本。

1.4.0-beta01 版本

2025 年 10 月 8 日

androidx.savedstate:savedstate-*:1.4.0-beta01 發布,自上一個 Alpha 版以來沒有重大異動。1.4.0-beta01 版包含這些修訂項目。

1.4.0-alpha03 版

2025 年 8 月 27 日

發布 androidx.savedstate:savedstate-*:1.4.0-alpha03。1.4.0-alpha03 版包含這些修訂項目。

API 變更

  • 在 encodeToSavedState 和 decodeFromSavedState 中新增對可為空值類型的支援。(I79062、b/439527454)
  • 將 Compose 更新至 1.9.0。(I2b9de)

1.4.0-alpha02 版

2025 年 8 月 13 日

發布 androidx.savedstate:savedstate-*:1.4.0-alpha02。1.4.0-alpha02 版包含這些修訂項目。

1.4.0-alpha01 版

2025 年 7 月 30 日

發布 androidx.savedstate:savedstate-*:1.4.0-alpha01。1.4.0-alpha01 版包含這些修訂項目。

API 變更

  • 在 SavedStateRegistryOwner.saved 中新增對可為空值類型的原生支援,簡化可為空值屬性的儲存和還原作業。(Ia632、b/421325690)

1.3 版本

1.3.3 版本

2025 年 9 月 17 日

發布 androidx.savedstate:savedstate-*:1.3.3。版本 1.3.3 包含 個提交。

修正錯誤

  • 修正未套用 Compose Compiler 外掛程式,導致 SavedState KMP 構件損毀的錯誤。(Id2290、b/443965665)

1.3.2 版

2025 年 8 月 27 日

發布 androidx.savedstate:savedstate-*:1.3.2。1.3.2 版包含這些修訂項目。

新功能

  • 在 SavedState *-compose 構件中新增 Kotlin Multiplatform (KMP) 目標。Lifecycle 現在總共支援下列平台:JVM (Android 和電腦)、原生 (Linux、iOS、watchOS、macOS、MinGW) 和網頁 (JavaScript、WasmJS)。(/Idcf26)

1.3.1 版本

2025 年 7 月 16 日

發布 androidx.savedstate:savedstate-*:1.3.1。1.3.1 版包含這些修訂項目。

修正錯誤

  • 將註解支援的所有 KMP 目標新增至 SavedState 構件。
  • 在 SavedState 構件中新增 Kotlin Multiplatform (KMP) 目標。SavedState 現在總共支援下列平台:JVM (Android 和電腦)、原生 (Linux、iOS、watchOS、macOS、MinGW) 和網頁 (JavaScript、WasmJS)。請注意,*-compose 構件並未新增 KMP 目標,因為這取決於 Compose 1.9 的穩定版本。(I062f4)。

1.3.0 版本

2025 年 5 月 7 日

發布 androidx.savedstate:savedstate-*:1.3.0。1.3.0 版包含這些修訂版本。

自 1.2.0 版以來的重要異動

  • LocalSavedStateRegistryOwner 已從 Compose UI 移至新的 savedstate-compose 模組,因此其以 Compose 為基礎的輔助 API 可在 Compose UI 外部使用。使用 Compose UI 1.9.0-alpha02 以上版本時,請一律使用這個函式。這個函式具備回溯相容性,因此可與所有 Compose 版本搭配使用。
  • savedstate-ktx Kotlin 擴充功能現已移至基礎 savedstate 模組。
  • 現在可以透過檢視畫面的不相交父項 (例如 ViewOverlay),解析透過 findViewTreeSavedStateRegistryOwner 擷取的 SavedStateRegistryOwner 執行個體。詳情請參閱核心版本資訊或 ViewTree.setViewTreeDisjointParent 中的說明文件,瞭解不相交的檢視區塊父項。

Kotlin Multiplatform

  • SavedState 模組現在與 KMP 相容。目前支援的平台包括 Android、iOS、Linux、Mac 和 JVM 桌面環境。
  • 推出 SavedState 不透明類型做為抽象化,提供一致的方式在 KMP 中儲存及還原應用程式狀態。其中包含 SavedStateReader 和 SavedStateWriter,用於修改要儲存的狀態。在 Android 上,SavedState 是 Bundle 的類型別名,可確保二進位檔相容性,並有助於將現有 API 遷移至通用來源集。在其他平台上,SavedState 是 Map<String, Any> 執行個體。

      // Create a new SavedState object using the savedState DSL:
      val savedState = savedState {
        putInt("currentPage", 1)
        putString("filter", "favorites")
      }
    
      // Read from a SavedState object
      val currentPage = savedState.read { getInt("currentPage") }
    
      // Edit an existing SavedState object
      savedState.write {
        remove("currentPage")
      }
    

KotlinX 序列化支援

  • SavedState 現在支援 KotlinX 序列化。您可以使用 encodeToSavedState 和 decodeFromSavedState 方法,將加上 @Serializable 註解的類別轉換為 SavedState。傳回的 SavedState 是 Android 上的常規 Bundle,可供任何接受 Bundle 的 API 使用。

    @Serializable
    data class Person(val firstName: String, val lastName: String)
    
    fun main() {
        val person = Person("John", "Doe")
        val encoded: SavedState = encodeToSavedState(person)
        val decoded: Person = decodeFromSavedState(encoded)
    }
    
  • 雖然大多數類型 (例如原始類型) 都直接支援,不需要任何設定,但您可以在 savedstate 模組的 androidx.savedstate.serialization.serializers 套件和 savedstate-compose 模組的 androidx.savedstate.compose.serialization.serializers 套件中,找到可與 @Serializable(with = ___:class) 搭配使用的其他序列化器。

  • 我們也加入了 saved (延遲屬性委派),可輕鬆將 @Serializable 類別儲存在 SavedStateRegistryOwner (例如 ComponentActivity、Fragment 等) 中,並在程序終止和重新建立時自動還原這些類別。請注意,saved 委派代表是延遲的,在存取之前不會呼叫 init lambda 或將任何內容儲存至 SavedStateRegistry。

    @Serializable
    data class Person(val firstName: String, val lastName: String)
    
    class MyActivity : ComponentActivity() {
        var person by saved { Person("John", "Doe") }
    
        override fun onCreate(savedInstanceState: Bundle?) {
            super.onCreate(savedInstanceState)
            this.person = Person("Jane", "Doe")
        }
    }
    
  • Lifecycle 2.9.0 中新增了類似的 SavedStateHandle saved 屬性委派。

1.3.0-rc01 版本

2025 年 4 月 23 日

發布 androidx.savedstate:savedstate-*:1.3.0-rc01。1.3.0-rc01 版包含這些修訂項目。

1.3.0-beta01 版本

2025 年 4 月 9 日

發布 androidx.savedstate:savedstate-*:1.3.0-beta01。1.3.0-beta01 版包含這些修訂項目。

依附元件更新

  • 這個程式庫現在指定 Kotlin 2.0 語言層級,且需要 KGP 2.0.0 以上版本。(Idb6b5)

1.3.0-alpha11 版

2025 年 3 月 26 日

androidx.savedstate:savedstate-*:1.3.0-alpha11 已發布,沒有重大公開異動。1.3.0-alpha11 版包含這些修訂項目。

1.3.0-alpha10 版

2025 年 3 月 12 日

發布 androidx.savedstate:savedstate-*:1.3.0-alpha10。1.3.0-alpha10 版包含這些修訂項目。

新功能

  • 在 SavedStateReader 中,為 get 集合新增非實體化方法變體。(I0b641、b/399820614)
  • 將 encodeDefaults 新增至 SavedStateConfiguration,允許自訂是否應編碼具有預設值的屬性。(I893cc、b/395104517)
  • 新增 SnapshotStateMapSerializer 以支援 mutableStateMapOf。(Ie6f19、b/378895074)
  • 新增 SnapshotStateListSerializer 以支援 mutableStateListOf。(I4d888、b/378895074)
  • 為 SavedStateReader.get 變化版本新增 getOrNull 替代方法。這些方法會自動封裝原始值。(I6228c、b/399820614)

API 變更

  • 從 SavedStateReader 移除 getOrElse,改用 getOrNull() ?: else()。(I87317、b/399820614)
  • 從 SavedStateReader 和 SavedStateWriter 方法中移除 inline 修飾符。(If2a02、b/399820614)
  • 從公開 API 移除內建的 Android 專用 List 和 Array 序列化工具 (Ida293)
  • 將 SparseParcelableArraySerializer 替換為 SparseArraySerializer (I91de8)
  • 當值類型與傳回類型不符時,擲回例外狀況,讓所有 SavedStateReader.get 的行為一致 (I78c4a、b/399317598)
  • 將 SavedState*Delegates 重新命名為 SavedState*Delegate。(I8589b、b/399629301)
  • 將 SavedStateConfig 重新命名為 SavedStateConfiguration。(I043a5、b/399629301)

1.3.0-alpha09 版

2025 年 2 月 26 日

發布 androidx.savedstate:savedstate-*:1.3.0-alpha09。1.3.0-alpha09 版包含這些修訂項目。

新功能

  • 為內建類型新增備用方案,確保 Bundle 支援的所有類型預設都能與 encodeAsSavedState/decodeFromSavedState 搭配使用,或透過 @Contextual 註解與 @Serializable 類別中的屬性搭配使用。(Ic01d2)
  • 在 SavedStateConfig 上支援 classDiscriminator 和 classDiscriminatorMode。(I69b66、b/395104517)

API 變更

  • 在 saved() 委派中新增 SavedStateConfig 參數 (I39b3a)
  • 將內建序列化工具設為單例模式物件 (Ifeee4)
  • SavedStateConfig 屬性現在已公開,其他模組可以使用這些設定。(Ie5f49、b/378897438)
  • 支援 MutableStateFlowSerializer 和 MutableStateSerializer 的 @Serializer(with = ...) (I90953)
  • 將 contentDeepToString 新增至 SavedStateReader (I14d10)

1.3.0-alpha08 版

2025 年 2 月 12 日

發布 androidx.savedstate:savedstate-*:1.3.0-alpha08。1.3.0-alpha08 版包含這些修訂項目。

新功能

  • 將 MutableStateSerializer 從 lifecycle-viewmodel-compose 移至 savedstate-compose,以便搭配 Compose 的 MutableState 使用 SavedState 序列化 API。(I4f690、b/378895074)

API 變更

  • 新增工廠函式,從現有的 SavedState 建立 SavedState。(I39f9a)
  • 在 androidx.savedstate 中新增對 Array<SavedState> 和 List<SavedState> 的支援。(Idd8a5)
  • 在 SavedState 編碼/解碼中新增 SavedStateConfig 選用參數 (I6c4c0)

1.3.0-alpha07 版

2025 年 1 月 29 日

發布 androidx.savedstate:savedstate-*:1.3.0-alpha07。1.3.0-alpha07 版包含這些修訂項目。

新功能

  • 新增 MutableStateFlowSerializer 以序列化 kotlinx.coroutines.flow.MutableStateFlow。(I6a892、b/378895070)

API 變更

  • 將超載的 SavedStateRegistryOwner.saved() 委派函式替換為預設參數 (Icd1c1)
  • 將 JavaSerializableSerializer 和 ParcelableSerializer 設為抽象 (I268f6)
  • 從 CharSequenceSerializer 移除一般 T : CharSequence (Ib40bd)

1.3.0-alpha06 版

2024 年 12 月 11 日

發布 androidx.savedstate:savedstate-*:1.3.0-alpha06。1.3.0-alpha06 版包含這些修訂項目。

新功能

  • SavedState KMP 現在支援:IBinder、Size、SizeF、Array<Parcelable>、SparseArray<Parcelable> 和 Serializable (Android)。(I1ba94、b/334076622)
  • 新增 KSerializer 例項,可用於編碼/解碼 Bundle 支援的 Java 和 Android 類型,方法是在類別中以 @Serializable(with = ParcelableSerializer::class) 標記相關欄位。(I8c10f、I28caf、b/376026712)
  • 現在可以透過檢視畫面的不相交父項 (例如 ViewOverlay),解析透過 findViewTreeSavedStateRegistryOwner 擷取的 SavedStateRegistryOwner 執行個體。詳情請參閱核心版本資訊或 ViewTree.setViewTreeDisjointParent 中的說明文件,瞭解不相交的檢視區塊父項。(Iccb33)

API 變更

  • 讓命名和套件組織與 SavedStateRegistryOwnerDelegate 更加一致 (I8c135、b/376026744)

1.3.0-alpha05 版

2024 年 11 月 13 日

發布 androidx.savedstate:savedstate-*:1.3.0-alpha05。1.3.0-alpha05 版包含這些修訂項目。

KotlinX 序列化支援

  • SavedState 現在支援 KotlinX 序列化。您可以使用 encodeToSavedState 和 decodeFromSavedState 方法,將加上 @Serializable 註解的類別轉換為 SavedState。傳回的 SavedState 是 Android 上的常規 Bundle,可供任何接受 Bundle 的 API 使用。(I6f59f、b/374102924)

    @Serializable
    data class Person(val firstName: String, val lastName: String)
    
    fun main() {
        val person = Person("John", "Doe")
        val encoded: SavedState = encodeToSavedState(person)
        val decoded: Person = decodeFromSavedState(encoded)
    }
    
  • 我們也加入了 saved (延遲屬性委派),可輕鬆將 @Serializable 類別儲存在 SavedStateRegistryOwner (例如 ComponentActivity、Fragment 等) 中,並在程序終止和重新建立時自動還原這些類別。請注意,saved 委派函式為延遲函式,在存取前不會呼叫 init lambda,也不會將任何內容儲存至 SavedStateRegistry。(I66739、b/376027806)

    @Serializable
    data class Person(val firstName: String, val lastName: String)
    
    class MyActivity : ComponentActivity() {
        var person by saved { Person("John", "Doe") }
    
        override fun onCreate(savedInstanceState: Bundle?) {
            super.onCreate(savedInstanceState)
            this.person = Person("Jane", "Doe")
        }
    }
    
  • Lifecycle 2.9.0-alpha07 中新增了類似的 SavedStateHandle saved 屬性委派。

API 變更

  • 將 toMap 新增至 SavedState,允許將任何 SavedState 轉換為一般 Map (淺層複製)。(I487b9、b/334076622)
  • SavedState KMP 現在支援陣列。(Ic0552、b/334076622)

1.3.0-alpha04 版本

2024 年 10 月 30 日

發布 androidx.savedstate:savedstate-*:1.3.0-alpha04。1.3.0-alpha04 版包含這些修訂項目。

API 變更

1.3.0-alpha03 版

2024 年 10 月 16 日

已發布「androidx.savedstate:savedstate-*:1.3.0-alpha03」,目前沒有任何重大異動。1.3.0-alpha03 版包含這些修訂項目。

1.3.0-alpha02 版本

2024 年 10 月 2 日

發布 androidx.savedstate:savedstate-*:1.3.0-alpha02。1.3.0-alpha02 版包含這些修訂項目。

Kotlin Multiplatform

  • SavedState 模組現在與 KMP 相容。目前支援的平台包括 Android、iOS、Linux、Mac 和 JVM 桌面環境。(I26305、b/334076622)

新功能

  • 推出 SavedState 不透明類型做為抽象化,提供一致的方式在 KMP 中儲存及還原應用程式狀態。其中包含 SavedStateReader 和 SavedStateWriter,用於修改要儲存的狀態。在 Android 上,SavedState 是 Bundle 的類型別名,可確保二進位檔相容性,並有助於將現有 API 遷移至通用來源集。在其他平台上,SavedState 是 Map<String, Any> 執行個體。(I18575、b/334076622)
  // Create a new SavedState object using the savedState DSL:
  val savedState = savedState {
    putInt("currentPage", 1)
    putString("filter", "favorites")
  }

  // Read from a SavedState object
  val currentPage = savedState.read { getInt("currentPage") }

  // Edit an existing SavedState object
  savedState.write {
    remove("currentPage")
  }

API 變更

  • SavedStateRegistry 和 SavedStateRegistryController 現已與 KMP 相容。(Id7bb8、b/334076622)
  • SavedState、SavedStateWriter 和 SavedStateReader 現在與 KMP 相容。(I26305、b/334076622)

1.3.0-alpha01 版本

2024 年 8 月 7 日

發布 androidx.savedstate:savedstate:1.3.0-alpha01 和 androidx.savedstate:savedstate-ktx:1.3.0-alpha01。1.3.0-alpha01 版包含這些修訂項目。

API 變更

  • savedstate-ktx Kotlin 擴充功能現已移至基礎 savedstate 模組。(I1cc18、b/274803094)

注意事項

  • 將 compileSdk 更新至 35 (5dc41be)

1.2.1 版本

1.2.1 版本

2023 年 3 月 22 日

發布 androidx.savedstate:savedstate:1.2.1 和 androidx.savedstate:savedstate-ktx:1.2.1。1.2.1 版本包含以下修訂項目。

依附元件更新

1.2.0 版本

1.2.0 版本

2022 年 6 月 29 日

發布 androidx.savedstate:savedstate:1.2.0 和 androidx.savedstate:savedstate-ktx:1.2.0。1.2.0 版本包含以下修訂項目。

自 1.1.0 版以來的重要異動

  • SavedStateRegistryController 現在允許透過 performAttach() 提前附加 SavedStateRegistry。
  • 您現在可以透過 getSavedStateProvider() 從 SavedStateRegistry 擷取先前註冊的 SavedStateProvider。
  • SavedState 程式庫已改用 Kotlin 重寫。
    • 對 SavedStateRegistryOwner 而言,這些類別屬於與原始碼不相容的變更,因此您現在必須覆寫 savedStateRegistry 屬性,而不是導入先前的 getSavedStateRegistry() 函式。
    • 對這些使用 Kotlin 程式語言編寫的類別而言,例如 ViewTreeSavedStateRegistryOwner,這是與原始碼不相容的變更,因此您現在必須為 androidx.savedstate.setViewTreeSavedStateRegistryOwner 和 androidx.savedstate.findViewTreeSavedStateRegistryOwner 的 View 直接匯入及使用 Kotlin 擴充功能方法,才能設定及找出先前設定的擁有者。這會取代 findViewTreeSavedStateRegistryOwner 的 savedstate-ktx API。

行為變更

  • 如果沒有要儲存的狀態,SavedStateRegistry 不會再儲存空白的 Bundle。

1.2.0-rc01 版本

2022 年 5 月 11 日

發布 androidx.savedstate:savedstate:1.2.0-rc01 和 androidx.savedstate:savedstate-ktx:1.2.0-rc01。1.2.0-rc01 版包含此連結所列的修訂項目。

說明文件變更

  • 《SavedStateRegistryOwner Kdocs》已更新,明確指出擁有者在應如何實作介面,或何時可透過 SavedStateRegistryController 呼叫方法時應承擔的責任以及受到的約束 (Iefc95、b/228887344)

1.2.0-beta01 版本

2022 年 4 月 20 日

發布 androidx.savedstate:savedstate:1.2.0-beta01 和 androidx.savedstate:savedstate-ktx:1.2.0-beta01。1.2.0-beta01 版包含此連結所列的修訂項目。

API 變更

  • 我們已使用 Kotlin 重新編寫 SavedStateRegistry 和 ViewTreeSavedStateRegistryOwner 類別。對這些使用 Kotlin 程式語言編寫的類別而言,例如 ViewTreeSavedStateRegistryOwner,這是與原始碼不相容的變更,因此您現在必須為 androidx.savedstate.setViewTreeSavedStateRegistryOwner 和 androidx.savedstate.findViewTreeSavedStateRegistryOwner 的 View 直接匯入及使用 Kotlin 擴充功能方法,才能設定及找出先前設定的擁有者。這會取代 findViewTreeSavedStateRegistryOwner 的 savedstate-ktx API,另外,這與二進位檔相容,而且以 Java 程式設計語言編寫的實作仍保持原始碼相容性 (b/220191285)

1.2.0-alpha02 版本

2022 年 4 月 6 日

發布 androidx.savedstate:savedstate:1.2.0-alpha02 和 androidx.savedstate:savedstate-ktx:1.2.0-alpha02。1.2.0-alpha02 版包含此連結所列的修訂項目。

新功能

  • 您現在可以透過 getSavedStateProvider() 從 SavedStateRegistry 擷取先前註冊的 SavedStateProvider。(I7ea47、b/215406268)

API 變更

  • 我們已使用 Kotlin 重新編寫 SavedStateRegistryOwner、SavedStateRegistryController 和 Recreator 類別。對 SavedStateRegistryOwner 而言,這些類別屬於與原始碼不相容的變更,因此您現在必須覆寫 savedStateRegistry 屬性,而不是導入先前的 getSavedStateRegistry() 函式。這與二進位檔相容,而且原始碼相容於以 Java 程式設計語言編寫的導入作業 (b/220191285)

1.2.0-alpha01 版本

2022 年 1 月 26 日

已釋出「androidx.savedstate:savedstate:1.2.0-alpha01」和「androidx.savedstate:savedstate-ktx:1.2.0-alpha01」。1.2.0-alpha01 版包含此連結所列的修訂項目。

新功能

  • SavedStateRegistryController 現在允許透過 performAttach() 提前附加 SavedStateRegistry。(Ice4bf)

行為變更

  • 如果無法儲存任何狀態,「SavedStateRegistry」就不會再儲存空白的軟體包。(aosp/1896865、b/203457956)

1.1.0 版本

1.1.0 版本

2021 年 2 月 10 日

已釋出「androidx.savedstate:savedstate:1.1.0」和「androidx.savedstate:savedstate-ktx:1.1.0」。1.1.0 版本包含以下修訂項目。

自 1.0.0 版本以來的重大異動

  • ViewTreeSavedStateRegistryOwner API:新的 ViewTreeSavedStateRegistryOwner.get(View) API 可讓您擷取 View 執行個體中包含的 SavedStateRegistry 執行個體。您必須升級為Activity 1.2.0、Fragment 1.3.0,以及AppCompat 1.3.0-alpha01 以上版本,才能正確填入資料。
  • savedstate-ktx成果:新的savedstate-ktx成果已新增可與ViewTreeSavedStateRegistryOwner搭配使用的findViewTreeSavedStateRegistryOwner()Kotlin 擴充功能。

1.1.0-rc01 版本

2020 年 12 月 16 日

androidx.savedstate:savedstate:1.1.0-rc01 和 androidx.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-beta01 和 androidx.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-alpha01」和「androidx.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。您可以前往這裡查看這個版本包含的修訂項目。

修正錯誤

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-alpha02。androidx.savedstate:savedstate 將成果 androidx.savedstate:savedstate-bundle 和 androidx.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 註冊回呼,以在系統要求時提供已儲存的狀態。