ライフサイクル
androidx.lifecycle
グループ内のすべてのアーティファクトのリストを以下に示します。
アーティファクト | 安定版リリース | リリース候補版 | ベータ版リリース | アルファ版リリース |
---|---|---|---|---|
lifecycle-* | 2.8.4 | - | - | 2.9.0-alpha01 |
lifecycle-viewmodel-compose | 2.8.4 | - | - | 2.9.0-alpha01 |
依存関係の宣言
Lifecycle への依存関係を追加するには、Google の Maven リポジトリをプロジェクトに追加する必要があります。詳しくは、Google の Maven リポジトリをご覧ください。
アプリまたはモジュールの build.gradle
ファイルに、必要なアーティファクトの依存関係を追加します。
Kotlin
Groovy
dependencies { def lifecycle_version = "2.8.4" def arch_version = "2.2.0" // ViewModel implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version" // ViewModel utilities for Compose implementation "androidx.lifecycle:lifecycle-viewmodel-compose:$lifecycle_version" // LiveData implementation "androidx.lifecycle:lifecycle-livedata-ktx:$lifecycle_version" // Lifecycles only (without ViewModel or LiveData) implementation "androidx.lifecycle:lifecycle-runtime-ktx:$lifecycle_version" // Lifecycle utilities for Compose implementation "androidx.lifecycle:lifecycle-runtime-compose:$lifecycle_version" // Saved state module for ViewModel implementation "androidx.lifecycle:lifecycle-viewmodel-savedstate:$lifecycle_version" // Annotation processor kapt "androidx.lifecycle:lifecycle-compiler:$lifecycle_version" // alternately - if using Java8, use the following instead of lifecycle-compiler implementation "androidx.lifecycle:lifecycle-common-java8:$lifecycle_version" // optional - helpers for implementing LifecycleOwner in a Service implementation "androidx.lifecycle:lifecycle-service:$lifecycle_version" // optional - ProcessLifecycleOwner provides a lifecycle for the whole application process implementation "androidx.lifecycle:lifecycle-process:$lifecycle_version" // optional - ReactiveStreams support for LiveData implementation "androidx.lifecycle:lifecycle-reactivestreams-ktx:$lifecycle_version" // optional - Test helpers for LiveData testImplementation "androidx.arch.core:core-testing:$arch_version" // optional - Test helpers for Lifecycle runtime testImplementation "androidx.lifecycle:lifecycle-runtime-testing:$lifecycle_version" }
Kotlin
dependencies { val lifecycle_version = "2.8.4" val arch_version = "2.2.0" // ViewModel implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version") // ViewModel utilities for Compose implementation("androidx.lifecycle:lifecycle-viewmodel-compose:$lifecycle_version") // LiveData implementation("androidx.lifecycle:lifecycle-livedata-ktx:$lifecycle_version") // Lifecycles only (without ViewModel or LiveData) implementation("androidx.lifecycle:lifecycle-runtime-ktx:$lifecycle_version") // Lifecycle utilities for Compose implementation("androidx.lifecycle:lifecycle-runtime-compose:$lifecycle_version") // Saved state module for ViewModel implementation("androidx.lifecycle:lifecycle-viewmodel-savedstate:$lifecycle_version") // Annotation processor kapt("androidx.lifecycle:lifecycle-compiler:$lifecycle_version") // alternately - if using Java8, use the following instead of lifecycle-compiler implementation("androidx.lifecycle:lifecycle-common-java8:$lifecycle_version") // optional - helpers for implementing LifecycleOwner in a Service implementation("androidx.lifecycle:lifecycle-service:$lifecycle_version") // optional - ProcessLifecycleOwner provides a lifecycle for the whole application process implementation("androidx.lifecycle:lifecycle-process:$lifecycle_version") // optional - ReactiveStreams support for LiveData implementation("androidx.lifecycle:lifecycle-reactivestreams-ktx:$lifecycle_version") // optional - Test helpers for LiveData testImplementation("androidx.arch.core:core-testing:$arch_version") // optional - Test helpers for Lifecycle runtime testImplementation ("androidx.lifecycle:lifecycle-runtime-testing:$lifecycle_version") }
Java
Groovy
dependencies { def lifecycle_version = "2.8.4" def arch_version = "2.2.0" // ViewModel implementation "androidx.lifecycle:lifecycle-viewmodel:$lifecycle_version" // LiveData implementation "androidx.lifecycle:lifecycle-livedata:$lifecycle_version" // Lifecycles only (without ViewModel or LiveData) implementation "androidx.lifecycle:lifecycle-runtime:$lifecycle_version" // Saved state module for ViewModel implementation "androidx.lifecycle:lifecycle-viewmodel-savedstate:$lifecycle_version" // Annotation processor annotationProcessor "androidx.lifecycle:lifecycle-compiler:$lifecycle_version" // alternately - if using Java8, use the following instead of lifecycle-compiler implementation "androidx.lifecycle:lifecycle-common-java8:$lifecycle_version" // optional - helpers for implementing LifecycleOwner in a Service implementation "androidx.lifecycle:lifecycle-service:$lifecycle_version" // optional - ProcessLifecycleOwner provides a lifecycle for the whole application process implementation "androidx.lifecycle:lifecycle-process:$lifecycle_version" // optional - ReactiveStreams support for LiveData implementation "androidx.lifecycle:lifecycle-reactivestreams:$lifecycle_version" // optional - Test helpers for LiveData testImplementation "androidx.arch.core:core-testing:$arch_version" // optional - Test helpers for Lifecycle runtime testImplementation "androidx.lifecycle:lifecycle-runtime-testing:$lifecycle_version" }
Kotlin
dependencies { val lifecycle_version = "2.8.4" val arch_version = "2.2.0" // ViewModel implementation("androidx.lifecycle:lifecycle-viewmodel:$lifecycle_version") // LiveData implementation("androidx.lifecycle:lifecycle-livedata:$lifecycle_version") // Lifecycles only (without ViewModel or LiveData) implementation("androidx.lifecycle:lifecycle-runtime:$lifecycle_version") // Saved state module for ViewModel implementation("androidx.lifecycle:lifecycle-viewmodel-savedstate:$lifecycle_version") // Annotation processor annotationProcessor("androidx.lifecycle:lifecycle-compiler:$lifecycle_version") // alternately - if using Java8, use the following instead of lifecycle-compiler implementation("androidx.lifecycle:lifecycle-common-java8:$lifecycle_version") // optional - helpers for implementing LifecycleOwner in a Service implementation("androidx.lifecycle:lifecycle-service:$lifecycle_version") // optional - ProcessLifecycleOwner provides a lifecycle for the whole application process implementation("androidx.lifecycle:lifecycle-process:$lifecycle_version") // optional - ReactiveStreams support for LiveData implementation("androidx.lifecycle:lifecycle-reactivestreams:$lifecycle_version") // optional - Test helpers for LiveData testImplementation("androidx.arch.core:core-testing:$arch_version") // optional - Test helpers for Lifecycle runtime testImplementation("androidx.lifecycle:lifecycle-runtime-testing:$lifecycle_version") }
依存関係について詳しくは、ビルド依存関係の追加をご覧ください。
フィードバック
お寄せいただいたフィードバックは Jetpack 改善の参考にさせていただきます。新しい問題が見つかった場合や、このライブラリを改善するアイデアをお持ちの場合は、お知らせください。新しい問題を報告していただく前に、このライブラリの既存の問題をご確認ください。スターボタンをクリックすると、既存の問題に投票できます。
詳細については、Issue Tracker のドキュメントをご覧ください。
バージョン 2.8
バージョン 2.8.4
2024 年 7 月 24 日
androidx.lifecycle:lifecycle-*:2.8.4
がリリースされました。バージョン 2.8.4 に含まれる commit については、こちらをご覧ください。
バグの修正
LiveData.asFlow()
は、LiveData
ですでに設定されている値を受け取った直後に、返された Flow が完了したケースを正しく処理できるようになりました(take(1)
を使用する場合など)。(I9c566)。Lifecycle*Effect
の完了がべき等になりました(つまり、Lifecycle が停止したためにonStopOrDispose
が呼び出された場合、Lifecycle が再びSTARTED
に戻らない限り、廃棄時に 2 回呼び出されることはありません)。(I5f607、b/352364595)。
バージョン 2.8.3
2024 年 7 月 1 日
androidx.lifecycle:lifecycle-*:2.8.3
がリリースされました。バージョン 2.8.3 に含まれる commit については、こちらをご覧ください。
バグの修正
- コード圧縮を使用した場合の Compose 1.6.0 以前との Lifecycle 2.8 の下位互換性に関する問題を修正しました。(aosp/3133056、b/346808608)。
バージョン 2.8.2
2024 年 6 月 12 日
androidx.lifecycle:lifecycle-*:2.8.2
がリリースされました。バージョン 2.8.2 に含まれる commit については、こちらをご覧ください。
バグの修正
- Compose 1.6.X 以前で Lifecycle 2.8.X を使用した場合の
CompositionLocal LocalLifecycleOwner not present
エラーを修正しました。回避策なしで、どのバージョンの Compose でも Lifecycle 2.8.2 を使用できるようになりました。(aosp/3105647、b/336842920)。 compileOnly
Lifecycle 依存関係の以前のバージョンとバージョン 2.8 以降を混在させてもViewModelProvider
がクラッシュしなくなり、LeakCanary などのライブラリの問題を修正しました。(I80383、b/341792251)。
バージョン 2.8.1
2024 年 5 月 29 日
androidx.lifecycle:lifecycle-*:2.8.1
がリリースされました。バージョン 2.8.1 に含まれる commit については、こちらをご覧ください。
バグの修正
lifecycle-viewmodel-compose
はcompose-runtime
への共通の依存関係のみを持つようになり、compose-ui
への共通の依存関係が削除されました。互換性のため、Android アーティファクトはcompose-ui
を保持しています。(aosp/3079334、b/339562627)。- プロパティ委譲を使用した
ViewModel
のsaveable
統合で、自動生成キーの一部としてクラス名が使用されるようになりました。これにより、複数のクラスが同じSavedStateHandle
を使用している場合の競合を回避できます。(aosp/3063463)。
バージョン 2.8.0
2024 年 5 月 14 日
androidx.lifecycle:lifecycle-*:2.8.0
がリリースされました。バージョン 2.8.0 に含まれる commit については、こちらをご覧ください。
2.7.0 以降の重要な変更
LocalLifecycleOwner
が Compose UI からlifecycle-runtime-compose
に移動され、Compose ベースのヘルパー API を Compose UI の外部で使用できるようになりました。lifecycle-runtime-compose
アーティファクトにdropUnlessResumed
API とdropUnlessStarted
API が追加されました。これにより、LifecycleOwner
が指定されたLifecycle.State
を下回った後でも発生するクリックやその他のイベントを削除できるようになりました。たとえば、次のように Navigation Compose で使用して、別の画面への遷移がすでに開始された後のクリック イベントの処理を回避できます。onClick: () -> Unit = dropUnlessResumed { navController.navigate(NEW_SCREEN) }
ViewModel.viewModelScope
がオーバーライド可能なコンストラクタ パラメータになりました。これにより、独自のディスパッチャとSupervisorJob()
を挿入したり、runTest
内で使用可能なbackgroundScope
を使用してデフォルトをオーバーライドしたりできます。(I2817c、b/264598574)。class MyViewModel( // Make Dispatchers.Main the default, rather than Dispatchers.Main.immediate viewModelScope: CoroutineScope = Dispatchers.Main + SupervisorJob() ) : ViewModel(viewModelScope) { // Use viewModelScope as before, without any code changes } // Allows overriding the viewModelScope in a test fun Test() = runTest { val viewModel = MyViewModel(backgroundScope) }
ViewModel
が Kotlin で書き換えられ、Closeable
ではなくAutoClosable
を使用するようになりました。getCloseable()
で取得できるkey
を使用して、AutoCloseable
オブジェクトを追加できるようになりました。これらの API がミラーリングする
DisposableEffect
API と同じ規則に従い、キーなしでLifecycleStartEffect
とLifecycleResumeEffect
を呼び出すとエラーになりました。LiveDataReactiveStreams.toPublisher(lifecycleOwner, liveData)
のサポートが終了し、LiveData.toPublisher(lifecycleOwner)
に置き換えられました。lifecycle-livedata-core-ktx
Kotlin 拡張機能がlifecycle-livedata-core
モジュールに移動されました。多くの誤検出を回避するために、
NullSafeMutableLiveData
がリファクタリングされました。
ライフサイクル Kotlin マルチプラットフォームの互換性
Lifecycle
、LifecycleOwner
、LifecycleObserver
、Lifecycle.State
、Lifecycle.Event
、LifecycleRegistry
のコア Lifecycle API が、Kotlin マルチプラットフォームと互換性のあるアーティファクトで提供されるようになりました。
影響を受けるアーティファクト:
lifecycle-common
では、ほとんどの API がcommon
に移行され、Android に加えて jvm と iOS がサポートされます。lifecycle-runtime
では、ほとんどの API がcommon
に移行され、Android に加えて jvm と iOS がサポートされます。lifecycle-runtime-ktx
が空になり、すべての API がlifecycle-runtime
に移動されました。lifecycle-runtime-compose
はすべての API をcommon
に移動し、androidx.compose
のマルチプラットフォーム サポートに対応する Android アーティファクトを出荷します。
ViewModel Kotlin マルチプラットフォームの互換性
lifecycle-viewmodel
アーティファクトと、ViewModel
、ViewModelStore
、ViewModelStoreOwner
、ViewModelProvider
などの API が、Kotlin マルチプラットフォームと互換性のあるアーティファクトで提供されるようになりました。
この変更に対応するために、java.lang.Class<T>
を受け取る ViewModelProvider
のメソッドなどに、kotlin.reflect.KClass<T>
を受け取る同等のメソッドが追加されました。
Android のバイナリ互換性は維持されますが、Android API サーフェスを共通 API サーフェスと比較すると、いくつかの重要な変更点があります。
ViewModelProvider
インスタンスの構築は、コンストラクタを直接呼び出すのではなく、ViewModelProvider.create()
メソッドで行うようになりました。ViewModelProvider.NewInstanceFactory
とViewModelProvider.AndroidViewModelFactory
は Android でのみご利用いただけます。- カスタム ファクトリを
ViewModelProvider.Factory
から拡張し、CreationExtras
を受け取るcreate
メソッドを使用するか、viewModelFactory
Kotlin DSL を使用することをおすすめします。
- カスタム ファクトリを
- JVM 以外のプラットフォームでカスタム ファクトリを指定せずに
ViewModelProvider
を使用すると、UnsupportedOperationException
になります。JVM プラットフォームでは、カスタム ファクトリが指定されていない場合、引数なしの ViewModel コンストラクタを使用することで互換性が維持されます。 Dispatchers.Main
が使用できないプラットフォーム(viewModelScope
EmptyCoroutineContext
Linux)。
影響を受けるアーティファクト:
lifecycle-viewmodel
では、ほとんどの API がcommon
に移行され、Android に加えて jvm と iOS がサポートされます。lifecycle-viewmodel-ktx
が空になり、すべての API がlifecycle-viewmodel
に移動されました。lifecycle-viewmodel-compose
はすべての API をcommon
に移動し、androidx.compose
のマルチプラットフォーム サポートに対応する Android アーティファクトを出荷します。
動作の変更
- 同じ
clazz: KClass<VM : ViewModel>
のinitializer
がすでに追加されている場合、InitializerViewModelFactory
(viewModelFactory
ビルダー関数を含む)がIllegalArgumentException
をスローするようになりました。(Ic3a36)。
既知の問題
lifecycle-*:2.8.0
を使用するには、Compose の最小バージョン 1.7.0-alpha05(b/336842920)が必要です。
バージョン 2.8.0-rc01
2024 年 5 月 1 日
androidx.lifecycle:lifecycle-*:2.8.0-rc01
がリリースされました。バージョン 2.8.0-rc01 に含まれる commit については、こちらをご覧ください。
バグの修正
lifecycle-common
クラスのベースライン プロファイルが正しくパッケージ化されない問題を修正しました。これらの最適化案は、lifecycle-runtime
AAR に統合されました。(aosp/3038274、b/322382422)。- ViewModel にアタッチされた
AutoCloseable
インスタンスのクリア方法における意図しない変更(addCloseable(String, AutoCloseable)
、addClosable(AutoCloseable)
、onCleared()
の順)が復元されました。(aosp/3041632)。 - ネイティブ環境と JVM デスクトップ環境での
viewModelScope
のデフォルト作成動作を改善しました。(aosp/3039221)。
外部からの協力
- JVM Desktop のメインスレッドのチェックを改善してくれた Victor Kropp 氏に感謝します。(aosp/3037116)。
バージョン 2.8.0-beta01
2024 年 4 月 17 日
androidx.lifecycle:lifecycle-*:2.8.0-beta01
がリリースされました。バージョン 2.8.0-beta01 に含まれる commit については、こちらをご覧ください。
新機能
lifecycle-runtime-compose
アーティファクトが Kotlin マルチプラットフォームと互換性を持つようになりました。コードをcommon
に移動し、androidx.compose
のマルチプラットフォーム サポートと一致する Android アーティファクトを提供します。(If7a71、I4f4a0、b/331769623)。
バージョン 2.8.0-alpha04
2024 年 4 月 3 日
androidx.lifecycle:lifecycle-*:2.8.0-alpha04
がリリースされました。バージョン 2.8.0-alpha04 に含まれる commit については、こちらをご覧ください。
新機能
lifecycle-viewmodel-compose
アーティファクトが Kotlin マルチプラットフォームと互換性を持つようになりました。コードをcommon
に移動し、androidx.compose
のマルチプラットフォーム サポートに対応する Android アーティファクトを提供します。この変更に対応するため、コンポーズ可能なviewModel
メソッドは、java.lang.Class
に加えてKClass
を受け入れるようになりました。(b/330323282)。
バグの修正
依存関係の更新
lifecycle-viewmodel-compose
アーティファクトが Compose 1.6.0 に依存するようになりました。- Lifecycle がプロファイル インストーラ 1.3.1 に依存するようになりました。
バージョン 2.8.0-alpha03
2024 年 3 月 20 日
androidx.lifecycle:lifecycle-*:2.8.0-alpha03
がリリースされました。バージョン 2.8.0-alpha03 に含まれる commit については、こちらをご覧ください。
新機能
ViewModel.viewModelScope
がオーバーライド可能なコンストラクタ パラメータになりました。これにより、独自のディスパッチャとSupervisorJob()
を挿入したり、runTest
内で使用可能なbackgroundScope
を使用してデフォルトをオーバーライドしたりできます。(I2817c、b/264598574)。class MyViewModel( // Make Dispatchers.Main the default, rather than Dispatchers.Main.immediate viewModelScope: CoroutineScope = Dispatchers.Main + SupervisorJob() ) : ViewModel(viewModelScope) { // Use viewModelScope as before, without any code changes } // Allows overriding the viewModelScope in a test fun Test() = runTest { val viewModel = MyViewModel(backgroundScope) }
Kotlin マルチプラットフォームの互換性
lifecycle-viewmodel
アーティファクトと、ViewModel
、ViewModelStore
、ViewModelStoreOwner
、ViewModelProvider
などの API が、Kotlin マルチプラットフォームと互換性のあるアーティファクトで提供されるようになりました。(b/214568825)。
この変更に対応するために、java.lang.Class<T>
を受け取る ViewModelProvider
のメソッドなどに、kotlin.reflect.KClass<T>
を受け取る同等のメソッドが追加されました。
Android のバイナリ互換性は維持されますが、Android API サーフェスを共通 API サーフェスと比較すると、いくつかの重要な変更点があります。
ViewModelProvider
インスタンスの構築は、コンストラクタを直接呼び出すのではなく、ViewModelProvider.create()
メソッドで行うようになりました。ViewModelProvider.NewInstanceFactory
とViewModelProvider.AndroidViewModelFactory
は Android でのみご利用いただけます。- カスタム ファクトリを
ViewModelProvider.Factory
から拡張し、CreationExtras
を受け取るcreate
メソッドを使用するか、viewModelFactory
Kotlin DSL を使用することをおすすめします。
- カスタム ファクトリを
- JVM 以外のプラットフォームでカスタム ファクトリを指定せずに
ViewModelProvider
を使用すると、UnsupportedOperationException
になります。JVM プラットフォームでは、カスタム ファクトリが指定されていない場合、引数なしの ViewModel コンストラクタを使用することで互換性が維持されます。 Dispatchers.Main
が使用できないプラットフォーム(viewModelScope
EmptyCoroutineContext
Linux)。
動作の変更
- 同じ
clazz: KClass<VM : ViewModel>
のinitializer
がすでに追加されている場合、InitializerViewModelFactory
(viewModelFactory
ビルダー関数を含む)がIllegalArgumentException
をスローするようになりました。(Ic3a36)。
バグの修正
ViewModel.getCloseable
が重複するキーを処理するようになりました。key
にすでにAutoCloseable
リソースが関連付けられている場合、古いリソースは置き換えられてすぐに閉じられます。(Ibeb67)。ViewModel
のviewModelScope
へのアクセスがスレッドセーフになりました。(If4766、b/322407038)。
外部からの協力
LocalLifecycleOwner
が Compose UI から Lifecycle-runtime-compose に移動され、Compose ベースのヘルパー API を Compose UI の外部で使用できるようになりました。Jake Wharton 氏の貢献に感謝します。(I6c41b、b/328263448)。
バージョン 2.8.0-alpha02
2024 年 2 月 21 日
androidx.lifecycle:lifecycle-*:2.8.0-alpha02
がリリースされました。バージョン 2.8.0-alpha02 に含まれる commit については、こちらをご覧ください。
新機能
dropUnlessResumed
API とdropUnlessStarted
API が追加され、LifecycleOwner
が指定のLifecycle.State
を下回った後でも発生するクリックやその他のイベントを削除できるようになりました。たとえば、次のように Navigation Compose で使用して、別の画面への遷移がすでに開始された後のクリック イベントの処理を回避できます。onClick: () -> Unit = dropUnlessResumed { navController.navigate(NEW_SCREEN) }
(Icba83、b/317230685)
Kotlin 変換
ViewModel
が Kotlin で記述されるようになりました。(I16f26、b/214568825)lifecycle-viewmodel-ktx
Kotlin 拡張機能がベース ライフサイクル モジュールに移動されました。(Id787b、b/274800183)。lifecycle-runtime-ktx
Kotlin 拡張機能がベース ライフサイクル モジュールに移動されました。(Ic3686、b/274800183)。lifecycle-livedata-core-ktx
Kotlin 拡張機能がベース ライフサイクル モジュールに移動されました。(I54a3d、b/274800183)。
Kotlin マルチプラットフォームの互換性
Lifecycle
、LifecycleOwner
、LifecycleObserver
、Lifecycle.State
、Lifecycle.Event
、LifecycleRegistry
のコア Lifecycle API が、Kotlin マルチプラットフォームと互換性のあるアーティファクトで提供されるようになりました。(b/317249252)。
API の変更
- これらの API がミラーリングする
DisposableEffect
API と同じ規則に従い、キーなしでLifecycleStartEffect
とLifecycleResumeEffect
を呼び出すとエラーになりました。(Ib0e0c、b/323518079)。 ViewModel
はCloseable
の代わりにAutoCloseable
を使用するようになりました。これは下位互換性のある変更です。(I27f8e、b/214568825)。LiveDataReactiveStreams.toPublisher(lifecycleOwner, liveData)
のサポートが終了し、LiveData.toPublisher(lifecycleOwner)
に置き換えられました。(Iabe29、b/262623005)。
外部からの協力
- Lifecycle を Kotlin マルチプラットフォームに移行するのを支援してくれた JetBrains の Ivan Matkov 氏に感謝します。(aosp/2926690、I0c5ac、If445d)。
バージョン 2.8.0-alpha01
2024 年 1 月 24 日
androidx.lifecycle:lifecycle-*:2.8.0-alpha01
がリリースされました。バージョン 2.8.0-alpha01 に含まれるコミットについては、こちらをご覧ください。
新機能
ViewModel
で、getCloseable()
を介して取得できるkey
を使用して、Closeable
オブジェクトを追加できるようになりました。(I3cf63)。
バージョン 2.7
バージョン 2.7.0
2024 年 1 月 10 日
androidx.lifecycle:lifecycle-*:2.7.0
がリリースされました。バージョン 2.7.0 に含まれる commit については、こちらをご覧ください。
2.6.0 以降の重要な変更
TestLifecycleOwner
に suspend 関数setCurrentState()
が追加されました。これにより、状態変化とすべてのLifecycleObserver
コールバックが完了する前に戻ります。特に、currentState
プロパティを直接設定する場合とは異なり、runBlocking
は使用しません。したがって、runTest
によって提供されるようなコルーチン内で安全に使用できます。map
とswitchMap
のLiveData
拡張機能は、distinctUntilChanged
の動作をミラーリングするようになりました。LiveData
にvalue
が設定されている場合、map
/switchMap
関数が直ちに呼び出され、返されたLiveData
のvalue
が入力されます。これにより、初期値が最初の合成の一部として設定されるようになります(observeAsState()
で使用する場合)。ただし、モニタリング動作は変更されません。ソースLiveData
からの更新値は、LiveData
のモニタリングを開始した後にのみ適用されます。- このリリースでは、プロセスの終了と再作成後に
SavedStateHandle
がカスタムParcelable
クラスを適切に復元しない問題を修正しました。Android フレームワークでは型情報が失われるため、カスタム Parcelable の配列は追加の作業(適切な型の型付き配列を手動で作成する)を必要とし、get
、getLiveData
、getStateFlow
のドキュメントではこの制限が明確に示されています。 LifecycleObserver
に関連付けられた ProGuard Keep ルールが削除されました。つまり、リフレクションを介して API を使用する ProGuard コード(非推奨の@OnLifecycleEvent
アノテーションを使用するなど)は、特定のユースケースに合わせて独自の保持ルールを提供する必要があります。
ライフサイクル イベントのオブザーバビリティ
LifecycleEventObserver
を使用する代わりに、Lifecycle.asFlow()
拡張メソッドを使用してLifecycle.Event
のFlow
を監視できるようになりました。- Jetpack Compose のユーザーは、
LifecycleEventEffect
を使用して、Lifecycle.Event
に基づく Compose の副作用を実行できるようになりました。
@Composable
fun HomeScreen(viewModel: HomeViewModel = viewModel()) {
LifecycleEventEffect(Lifecycle.Event.ON_RESUME) {
viewModel.refreshData()
}
// …
}
- Jetpack Compose のユーザーは、
LifecycleStartEffect
とLifecycleResumeEffect
を使用して、開始から再開、一時停止からそれぞれ再開したイベントのペアを処理できます。この API は、DisposableEffect
にある API をミラーリングしており、状態が上がるときに行われた変更を、下に戻るときに元に戻す必要がある場合に適しています。
fun HomeScreen(viewModel: HomeViewModel = viewModel()) {
LifecycleStartEffect(viewModel) {
val timeTracking = viewModel.startTrackingTimeOnScreen()
onStopOrDispose {
timeTracking.stopTrackingTimeOnScreen()
}
}
// …
}
詳しくは、ライフサイクル イベントに対してコードを実行するをご覧ください。
ライフサイクル状態のオブザーバビリティ
- 現在の
Lifecycle.State
は、Lifecycle.currentStateFlow
プロパティを介して監視できるようになりました。このプロパティは、value
が現在のLifecycle.State
であるStateFlow
を返します。 - Jetpack Compose のユーザーは、
Lifecycle.currentStateAsState()
拡張機能を使用してLifecycle.State
を ComposeState
として直接公開できます。これはlifecycle.currentStateFlow.collectAsState()
と同等であり、より短い代替手段です。
詳細については、フローを使用してライフサイクルの状態を収集するをご覧ください。
バージョン 2.7.0-rc02
2023 年 12 月 13 日
androidx.lifecycle:lifecycle-*:2.7.0-rc02
がリリースされました。バージョン 2.7.0-rc02 に含まれる commit については、こちらをご覧ください。
バグの修正
- プロセスの終了と再作成後に
SavedStateHandle
がカスタムParcelable
クラスを適切に復元しない問題を修正しました。Android フレームワークでは型情報が失われるため、カスタム Parcelable の配列は追加の作業(適切な型の型付き配列を手動で作成する)を必要とし、get
、getLiveData
、getStateFlow
のドキュメントではこの制限が明確に示されています。(I0b55a)。
バージョン 2.7.0-rc01
2023 年 11 月 15 日
androidx.lifecycle:lifecycle-*:2.7.0-rc01
がリリースされました。バージョン 2.7.0-rc01 に含まれる commit については、こちらをご覧ください。
バグの修正
LifecycleStartEffect
とLifecycleResumeEffect
は、LifecycleOwner
が変更された場合に作用ブロックを正しく破棄して再作成するようになりました。(Ia25c6)。
バージョン 2.7.0-beta01
2023 年 11 月 1 日
androidx.lifecycle:lifecycle-*:2.7.0-beta01
がリリースされました。変更はありません。バージョン 2.7.0-beta01 に含まれる commit については、こちらをご覧ください。
- ベータ版公開。このリリース バージョンには大きな変更はありません。
バージョン 2.7.0-alpha03
2023 年 10 月 18 日
androidx.lifecycle:lifecycle-*:2.7.0-alpha03
がリリースされました。バージョン 2.7.0-alpha03 に含まれる commit については、こちらをご覧ください。
新機能
- コルーチン内で
currentState
フィールドを使用することでTestLifecycleOwner
のLifecycle.State
が設定されないように、lifecycle-runtime-testing
に新しい lint チェックが追加されました。lint チェックで、setCurrentState
の一時停止が提案されるようになりました。これにより、ブロックせずにLifecycle.State
を設定できます。(Icf728、b/297880630)。
バグの修正
- 最初の呼び出しと後続の呼び出しの両方で同じ
LiveData
インスタンスを返すと、LiveData
インスタンスがソースとして追加されないLiveData.switchMap
の問題を修正しました。(Ibedcba7)。
バージョン 2.7.0-alpha02
2023 年 9 月 6 日
androidx.lifecycle:lifecycle-*:2.7.0-alpha02
がリリースされました。バージョン 2.7.0-alpha02 に含まれる commit については、こちらをご覧ください。
新機能
TestLifecycleOwner
に suspend 関数setCurrentState()
が追加され、runTest
によって提供されるようなコルーチン内からTestLifecycleOwner
を使用できるようになりました。(I329de、b/259344129)。
API の変更
lifecycle-livedata-ktx
モジュールのすべてのファイルをメインのlifecycle-livedata
モジュールに移動しました。(I10c6f、b/274800183)。
動作の変更
LiveData.map()
拡張機能とLiveData.switchMap()
拡張機能は、以前のLiveData
に値が設定されている場合、返されたLiveData
のvalue
を設定するようになりました。これにより、Jetpack Compose で結果の LiveData を使用して、最初のコンポジションで適切な状態を維持できるようになりました。(I91d2b、b/269479952)。ViewModel
がonCleared()
の呼び出しをすでに受け取っている場合、ViewModel
のaddCloseable()
が直ちにCloseable
を閉じるようになりました。(I4712e、b/280294730)。
バグの修正
- Lifecycle
2.6.2
以降: 状態が復元された場合、プロセス終了後にSavedStateHandle
が正しく復元されず、親のSavedStateRegistry
に実際に状態を保存せずにsave()
が呼び出され、状態が再び復元される問題を修正しました。これにより、rememberSaveable
と Navigation Compose のNavHost
の間のインタラクションが修正されました。(aosp/2729289)。
バージョン 2.7.0-alpha01
2023 年 7 月 26 日
androidx.lifecycle:lifecycle-*:2.7.0-alpha01
がリリースされました。バージョン 2.7.0-alpha01 に含まれる commit については、こちらをご覧ください。
API の変更
Lifecycle.State
がLifecycle.currentStateFlow
を介して Compose で監視できるようになりました。これにより、value
が現在のLifecycle.State
であるStateFlow
が返されます。(Ib212d、b/209684871)。Lifecycle.Event
をLifecycle.asFlow().
でFlow
として監視できるようになりました(If2c0f、b/176311030)。Lifecycle.Event.ON_RESUME
とLifecycle.Event.ON_PAUSE
の両方のイベント コールバックに基づいて ComposeSideEffect
を実行するLifecycleResumeEffect
API が追加されました。(I60386、b/235529345)。Lifecycle.Event.ON_START
とLifecycle.Event.ON_STOP
のイベント コールバックに基づいて ComposeSideEffect
を実行するLifecycleStartEffect
API が追加されました。(I5a8d1、b/235529345)。Lifecycle.Event
に基づいて ComposeSideEffect
を実行するためのLifecycleEventEffect
API が追加されました。(Ic9794、b/235529345)。Lifecycle.State
を ComposeState
として直接公開するために、Lifecycle.collectAsState()
拡張機能が追加されました。これはlifecycle.currentStateFlow.collectAsState()
と同等であり、より短い代替手段です。(I11015、b/235529345)。
バグの修正
LiveData.distinctUntilChanged()
拡張機能は、以前のLiveData
に値が設定されている場合、返されたLiveData
のvalue
を設定するようになりました。これによって監視の動作が変わることはありません。ソースのLiveData
から更新された値は引き続き、distinctUntilChanged()
から返されるLiveData
の監視を開始した後にのみ、適用されることになります。(Ib482f)LifecycleObserver
に関連付けられた ProGuard Keep ルールが削除されました。つまり、リフレクションを介して API を使用する ProGuard のコードは、特定のユースケースに対して独自の保持ルールを提供する必要があります。(Ia12fd)。
バージョン 2.6
バージョン 2.6.2
2023 年 9 月 6 日
androidx.lifecycle:lifecycle-*:2.6.2
がリリースされました。バージョン 2.6.2 に含まれる commit については、こちらをご覧ください。
バグの修正
- 状態が復元され、親
SavedStateRegistry
に実際に状態を保存せずにsave()
が呼び出され、状態が再び復元された場合、プロセス終了後にSavedStateHandle
が正しく復元されない問題を修正しました。これにより、rememberSaveable
と Navigation Compose のNavHost
の間のインタラクションが修正されました。(aosp/2729289)。
バージョン 2.6.1
2023 年 3 月 22 日
androidx.lifecycle:lifecycle-*:2.6.1
がリリースされました。バージョン 2.6.1 に含まれる commit については、こちらをご覧ください。
依存関係の更新
lifecycle-viewmodel-savedstate
が SavedState1.2.1
に依存するようになりました。(cd7251)。- Lifecycle が ProfileInstaller
1.3.0
に依存するようになりました。(f9d30b)。
バージョン 2.6.0
2023 年 3 月 8 日
androidx.lifecycle:lifecycle-*:2.6.0
がリリースされました。バージョン 2.6.0 に含まれる commit については、こちらをご覧ください。
2.5.0 以降の重要な変更
LiveData
に、LiveData
に明示的な値が設定済みかどうかを示す新しいisInitialized
プロパティが追加されました。これにより、値が設定されていないためにnull
を返すliveData.value
と明示的なnull
値を区別できるようになりました。MediatorLiveData
に、初期値を設定するコンストラクタが追加されました。collectAsStateWithLifecycle()
のStateFlow
とFlow
に新しい拡張機能を追加しました。この拡張機能は、フローから収集し、ライフサイクルを意識した方法で Compose の状態として最新の値を表します。Lifecycle.launchWhenX
のメソッドとLifecycle.whenX
のメソッドが非推奨になりました。一時停止しているディスパッチャを使用するとリソースが無駄になることがあったためです。Lifecycle.repeatOnLifecycle
の使用をおすすめします。1 回限りの一時停止処理について詳しくは、本質的に安全でない理由に関するこちらの説明をご覧ください。- Kotlin 変換 - 多くの Lifecycle クラスが Kotlin に変換されました。変換されたすべてのクラスは、引き続き以前のバージョンとのバイナリ互換性を保持します。次のクラスには、Kotlin で記述されたクラスに対してソース互換性のない変更があります:
ViewTreeLifecycleOwner
、LiveDataReactiveStreams
、HasDefaultViewModelProviderFactory
、ViewTreeViewModelStoreOwner
、Transformations
、ViewModelStoreOwner
、LifecycleOwner
次の表に、ライフサイクルの新しいバージョンでのソース コンバージョンを示します。
ライフサイクル 2.5 | Lifecycle 2.5(KTX) | ライフサイクル 2.6 |
---|---|---|
Transformations.switchMap(liveData) {...} |
liveData.switchMap {...} |
liveData.switchMap {...} |
Transformations.map(liveData) {...} |
liveData.map {...} |
liveData.map {...} |
Transformations.distinctUntilChanged(liveData) {...} |
liveData.distinctUntilChanged{...} |
liveData.distinctUntilChanged{...} |
LiveDataReactiveStreams.fromPublisher(publisher) |
publisher.toLiveData() |
publisher.toLiveData() |
LiveDataReactiveStreams.toPublisher(lifecycleOwner, liveData) |
liveData.toPublisher(lifecycleOwner) |
liveData.toPublisher(lifecycleOwner) |
override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory = factory |
override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory = factory |
override val defaultViewModelProviderFactory = factory |
override fun getDefaultViewModelCreationExtras(): CreationExtras = extras |
override fun getDefaultViewModelCreationExtras(): CreationExtras = extras |
override val defaultViewModelProviderCreationExtras = extras |
ViewTreeLifecycleOwner.set(view, owner) |
ViewTreeLifecycleOwner.set(view, owner) |
view.setViewTreeLifecycleOwner(owner) |
ViewTreeLifecycleOwner.get(view) |
view.findViewTreeLifecycleOwner() |
view.findViewTreeLifecycleOwner() |
override fun getViewModelStore(): ViewModelStore = store |
override fun getViewModelStore(): ViewModelStore = store |
override val viewModelStore: ViewModelStore = store |
override fun getLifecycle(): Lifecycle = registry |
override fun getLifecycle(): Lifecycle = registry |
override val lifecycle: Lifecycle get() = registry |
- Kotlin で作成された
Observer
のonChanged
メソッドの null 可能性が、汎用型の null 可能性と一致するようになりました。Observer.onChanged()
で null 値許容型を受け入れるには、null 値許容型でObserver
をインスタンス化する必要があります。 - 以下のクラスも Kotlin に変換されましたが、ソース互換のままです:
DefaultLifecycleObserver
、LifecycleEventObserver
、Lifecycle
、LifecycleRegistry
、LifecycleObserver
、ViewModelStore
、AndroidViewModel
、AbstractSavedStateViewModelFactory
、LifecycleService
、ServiceLifecycleDispatcher
、ProcessLifecycleOwner
バージョン 2.6.0-rc01
2023 年 2 月 22 日
androidx.lifecycle:lifecycle-*:2.6.0-rc01
がリリースされました。バージョン 2.6.0-rc01 に含まれる commit については、こちらをご覧ください。
バグの修正
LiveData.distinctUntilChanged()
拡張機能は、以前のLiveData
に値が設定されている場合、返されたLiveData
のvalue
を設定するようになりました。これによって監視の動作が変わることはありません。ソースのLiveData
から更新された値は引き続き、distinctUntilChanged()
から返されるLiveData
の監視を開始した後にのみ、適用されることになります。(Ib482f)
バージョン 2.6.0-beta01
2023 年 2 月 8 日
androidx.lifecycle:lifecycle-*:2.6.0-beta01
がリリースされました。バージョン 2.6.0-beta01 に含まれる commit については、こちらをご覧ください。
Kotlin 変換
LifecycleOwner
が Kotlin で記述されるようになりました。Kotlin で記述されたコードに対するソース互換性のない変更であるため、以前のgetLifecycle()
関数を実装するのではなく、lifecycle
プロパティをオーバーライドしなければならなくなりました。(I75b4b、b/240298691)ViewModelStoreOwner
が Kotlin で記述されるようになりました。Kotlin で記述されたコードに対するソース互換性のない変更であるため、以前のgetViewModelStore()
関数を実装するのではなく、viewModelStore
プロパティをオーバーライドしなければならなくなりました。(I86409、b/240298691)lifecycleScope
フィールドを提供するLifecycleOwner
の Kotlin 拡張機能がlifecycle-runtime-ktx
からlifecycle-common
アーティファクトに移動しました。(I41d78、b/240298691)coroutineScope
フィールドを提供するLifecycle
の Kotlin 拡張機能がlifecycle-runtime-ktx
からlifecycle-common
アーティファクトに移動しました。(Iabb91、b/240298691)
バージョン 2.6.0-alpha05
2023 年 1 月 25 日
androidx.lifecycle:lifecycle-*:2.6.0-alpha05
がリリースされました。バージョン 2.6.0-alpha05 に含まれる commit については、こちらをご覧ください。
Kotlin 変換
Transformations
が Kotlin で記述されるようになりました。これは、Transformations.map
などの構文を直接使用して Kotlin で記述されたクラスに対する、ソース互換性のない変更となります。Kotlin コードは、Kotlin 拡張メソッド構文を使用することが必要になります。この構文は以前はlifecycle-livedata-ktx
を使用している場合にのみ使用可能だったものです。Java プログラミング言語を使用している場合、androidx.arch.core.util.Function
メソッドを受け取るこれらのメソッドのバージョンは非推奨となり、Kotlin のFunction1
を受け取るバージョンが代わりとなります。この変更はバイナリ互換性を維持します。(I8e14f)ViewTreeViewModelStoreOwner
が Kotlin で記述されるようになりました。これは Kotlin で記述されたクラスに対するソース互換性のない変更です。以前に設定したオーナーを設定、確認するには、androidx.lifecycle.setViewTreeViewModelStoreOwner
とandroidx.lifecycle.findViewTreeViewModelStoreOwner
のView
で Kotlin 拡張メソッドを直接インポートして使用する必要があります。Java プログラミング言語で記述された実装に対しては、バイナリ互換性があり、ソース互換性を維持しています。(Ia06d8、Ib22d8、b/240298691)HasDefaultViewModelProviderFactory
インターフェースが Kotlin で記述されるようになりました。これは Kotlin で記述されたクラスに対するソース互換性のない変更となります。これまで対応していた関数を実装するのではなく、defaultViewModelProviderFactory
プロパティとdefaultViewModelCreationExtras
プロパティをオーバーライドすることが必要になります。(Iaed9c、b/240298691)Observer
が Kotlin で記述されるようになりました。onChanged()
メソッドのパラメータにvalue
という名前を使用するようになりました。(Iffef2、I4995e、b/240298691)AndroidViewModel
、AbstractSavedStateViewModelFactory
、LifecycleService
、ServiceLifecycleDispatcher
、ProcessLifecycleOwner
が Kotlin で記述されるようになりました。(I2e771、Ibae40、I160d7、I08884、I1cda7、b/240298691)
バージョン 2.6.0-alpha04
2023 年 1 月 11 日
androidx.lifecycle:lifecycle-*:2.6.0-alpha04
がリリースされました。バージョン 2.6.0-alpha04 に含まれる commit については、こちらをご覧ください。
新機能
LiveData
に明示的な値が設定されたことがあるかどうかを示す新しいisInitialized
プロパティが、LiveData
に追加されました。これにより、値が設定されたことがないliveData.value
により返されたnull
値か、明示的に返されたnull
値かを区別できるようになりました。(Ibd018)
API の変更
lifecycle-runtime-compose
のcollectAsStateWithLifecycle()
API が試験運用版ではなくなりました。(I09d42、b/258835424)Lifecycle.launchWhenX
のメソッドとLifecycle.whenX
のメソッドが非推奨になりました。一時停止しているディスパッチャを使用するとリソースが無駄になることがあったためです。Lifecycle.repeatOnLifecycle
を使用することをおすすめします。(Iafc54、b/248302832)
Kotlin 変換
ViewTreeLifecycleOwner
が Kotlin で記述されるようになりました。これは Kotlin で記述されたクラスに対するソース互換性のない変更です。以前に設定したオーナーを設定、確認するには、androidx.lifecycle.setViewTreeLifecycleOwner
とandroidx.lifecycle.findViewTreeLifecycleOwner
のView
で Kotlin 拡張メソッドを直接インポートして使用する必要があります。lifecycle-runtime-ktx
にある以前の Kotlin 拡張機能に代わるものです。Java プログラミング言語で記述された実装に対しては、バイナリ互換性があり、ソース互換性を維持しています。(I8a77a、I5234e、b/240298691)LiveDataReactiveStreams
が Kotlin で記述されるようになりました。以前lifecycle-reactivestreams-ktx
にあった Kotlin 拡張機能がlifecycle-reactivestreams
モジュールに移動し、Kotlin で記述されたコードのメインのサーフェスになりました。Kotlin 拡張メソッド API を使用していなかった場合は、Kotlin で記述されたコードに対するソース互換性のない変更となります。(I2b1b9、I95d22、b/240298691)DefaultLifecycleObserver
、LifecycleEventObserver
、Lifecycle
、LifecycleRegistry
、LifecycleObserver
、ViewModelStore
が Kotlin で記述されるようになりました。(Iadffd、I60034、I8c52c、I9593d、I01fe1、I59a23、b/240298691)
バグの修正
- 間違ったクラスタイプで
get()
を呼び出してもClassCastException
でSavedStateHandle
がクラッシュしなくなりました。(I6ae7c)
バージョン 2.6.0-alpha03
2022 年 10 月 24 日
androidx.lifecycle:lifecycle-*:2.6.0-alpha03
がリリースされました。バージョン 2.6.0-alpha03 に含まれる commit については、こちらをご覧ください。
バグの修正
- 異なる Lifecycle モジュール間の制約が意図したとおりに動作しない問題を修正しました。(I18d0d、b/249686765)
LifecycleRegistry.moveToState()
がスローするエラーに、エラーの原因となるコンポーネントをデベロッパーに知らせるためのより有用なエラー メッセージが含まれるようになりました。(Idf4b2、b/244910446)
バージョン 2.6.0-alpha02
2022 年 9 月 7 日
androidx.lifecycle:lifecycle-*:2.6.0-alpha02
がリリースされました。バージョン 2.6.0-alpha02 に含まれる commit については、こちらをご覧ください。
API の変更
MediatorLiveData
に初期値を設定するためのコンストラクタが追加されました。(Ib6cc5、b/151244085)
バグの修正
Lifecycle
のアーティファクトに制約が追加され、依存関係のあるすべての Lifecycle アーティファクトで必ず同じバージョンが使用されるようになりました。それによって、依存関係にあるアーティファクトのいずれかがアップグレードされると、自動的に他もすべてアップグレードされるようになりました。(b/242871265)FlowLiveData.asFlow()
は、独自のChannel
実装を使用する代わりにcallbackFlow
を作成することで、スレッドセーフを確保し、コンテキストを保持できるようになりました。(I4a8b2、b/200596935)FlowLiveData
のasLiveData
関数が、新しいLiveData
オブジェクトの作成時にStateFlow
の初期値を保持するようになりました。(I3f530、b/157380488)- Lifecycle
2.5.1
以降:AndroidViewModelFactory
のカスタム実装で、ステートフル コンストラクタをLifecycle
2.4 以降で使用している際に、create(modelClass)
関数を正しく呼び出せるようになりました。(I5b315、b/238011621)
バージョン 2.6.0-alpha01
2022 年 6 月 29 日
androidx.lifecycle:lifecycle-*:2.6.0-alpha01
がリリースされました。バージョン 2.6.0-alpha01 に含まれる commit については、こちらをご覧ください。
新機能
collectAsStateWithLifecycle
のStateFlow
とFlow
に、フローから収集してライフサイクル対応の方法で Compose の状態として最新の値を表す拡張機能を追加しました。フローが収集されて、ライフサイクルが少なくとも特定のLifecycle.State
に達すると新しい出力が状態の値に設定されます。ライフサイクルがLifecycle.State
を下回ると、フローの収集は停止し、状態の値は更新されなくなります。(I1856e、b/230557927)
バージョン 2.5
バージョン 2.5.1
2022 年 7 月 27 日
androidx.lifecycle:lifecycle-*:2.5.1
がリリースされました。バージョン 2.5.1 に含まれる commit については、こちらをご覧ください。
バグの修正
- ステートフル
AndroidViewModelFactory
コンストラクタをLifecycle
2.4 以降で使用している際に、AndroidViewModelFactory
のカスタムの実装がcreate(modelClass)
関数を正しく呼び出せるようになりました。(I5b315、b/238011621)
バージョン 2.5.0
2022 年 6 月 29 日
androidx.lifecycle:lifecycle-*:2.5.0
がリリースされました。バージョン 2.5.0 に含まれる commit については、こちらをご覧ください。
2.4.0 以降の重要な変更
LiveData
を使用する代わりに値の変更をモニタリングする KotlinStateFlow
を返すgetStateFlow()
API をSavedStateHandle
が提供するようになりました。ViewModel CreationExtras - カスタムの
ViewModelProvider.Factory
を記述する際、AndroidViewModelFactory
またはAbstractSavedStateViewModelFactory
を拡張してそれぞれApplication
またはSavedStateHandle
へのアクセス権を取得する必要がなくなりました。今後これらのフィールドは、create
の新しいオーバーロードであるcreate(Class<T>, CreationExtras)
を介してCreationExtras
としてすべてのViewModelProvider.Factory
サブクラスに提供されます。このようなエクストラは、Activity1.5.0
または Fragment1.5.0
を使用している場合にそれぞれ Activity または Fragment から自動的に提供されます。class CustomFactory : ViewModelProvider.Factory { override fun <T : ViewModel> create(modelClass: Class<T>, extras: CreationExtras): T { return when (modelClass) { HomeViewModel::class -> { // Get the Application object from extras val application = checkNotNull(extras[ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY]) // Pass it directly to HomeViewModel HomeViewModel(application) } DetailViewModel::class -> { // Create a SavedStateHandle for this ViewModel from extras val savedStateHandle = extras.createSavedStateHandle() DetailViewModel(savedStateHandle) } else -> throw IllegalArgumentException("Unknown class $modelClass") } as T } }
lifecycle-viewmodel
がviewModelFactory
Kotlin DSL を提供するようになりました。これにより、CreationExtras
をメインのデータソースとして使用して、1 つ以上のラムダ初期化子(カスタム ファクトリがサポートする特定のViewModel
クラスごとに 1 つ)に関してViewModelProvider.Factory
を定義できるようになります。val customFactory = viewModelFactory { // The return type of the lambda automatically sets what class this lambda handles initializer { // Get the Application object from extras provided to the lambda val application = checkNotNull(get(ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY)) HomeViewModel(application) } initializer { val savedStateHandle = createSavedStateHandle() DetailViewModel(savedStateHandle) } }
lifecycle-viewmodel-compose
がラムダ ファクトリを受け取るviewModel()
API を提供するようになりました。これにより、カスタムのViewModelProvider.Factory
を作成せずに、ViewModel
インスタンスを作成できるようになります。// Within a @Composable, you can now skip writing a custom Factory // and instead write a lambda to do the initialization of your ViewModel val detailViewModel = viewModel { // This lambda is only called the first time the ViewModel is created // and all CreationExtras are available inside the lambda val savedStateHandle = createSavedStateHandle() DetailViewModel(savedStateHandle) }
SavedStateHandle Compose セーバー統合 -
lifecycle-viewmodel-compose
アーティファクトがSavedStateHandle.saveable
に新しい試験運用版 API を取り入れるようになりました。これにより、ViewModel のSavedStateHandle
によってサポートされたrememberSaveable
のような動作が可能となります。class ListScreenViewModel(handle: SavedStateHandle): ViewModel() { // This value survives both configuration changes and process death and recreation val editMode by handle.saveable { mutableStateOf(false) } }
addCloseable()
API と新しいコンストラクタ オーバーロードを追加しました。これにより、ViewModel
がクリアされるときに閉じられる 1 つ以上のCloseable
オブジェクトをViewModel
に追加できるようになり、onCleared()
で手動の作業が不要になります。たとえば、ViewModel に追加するが、テストで制御することができるコルーチン スコープを作成するために、
Closeable
を実装するCoroutineScope
を作成できます。class CloseableCoroutineScope( context: CoroutineContext = SupervisorJob() + Dispatchers.Main.immediate ) : Closeable, CoroutineScope { override val coroutineContext: CoroutineContext = context override fun close() { coroutineContext.cancel() } }
これは、
viewModelScope
と同じ存続期間を保ちつつViewModel
コンストラクタで使用できます。class TestScopeViewModel( val customScope: CloseableCoroutineScope = CloseableCoroutineScope() ) : ViewModel(customScope) { // You can now use customScope in the same way as viewModelScope }
動作の変更
Lifecycle.State
をINITIALIZED
からDESTROYED
に変更しようとすると、Lifecycle
にオブザーバーがアタッチされているかどうかにかかわらず、常にIllegalStateException
がスローされるようになりました。LifecycleRegistry
は、オブザーバーがDESTROYED
状態に達したときにオブザーバーをクリアするようになりました。
バージョン 2.5.0-rc02
2022 年 6 月 15 日
androidx.lifecycle:lifecycle-*:2.5.0-rc02
がリリースされました。バージョン 2.5.0-rc02 に含まれる commit については、こちらをご覧ください。
バグの修正
- compileOnly Lifecycle 依存関係の以前のバージョンとバージョン 2.5 以降を混在させたときに
ViewModelProvider
がクラッシュしなくなりました。(I81a66、b/230454566)
バージョン 2.5.0-rc01
2022 年 5 月 11 日
androidx.lifecycle:lifecycle-*:2.5.0-rc01
がリリースされました。バージョン 2.5.0-rc01 に含まれる commit については、こちらをご覧ください。
バグの修正
MediatorLiveData.addSource()
がnull
ソースを渡すとき、これまでのようにnull
ソースをオブザーバーに伝播するのではなく、NullPointerException
をスローするようになりました。(Ibd0fb、b/123085232)
バージョン 2.5.0-beta01
2022 年 4 月 20 日
androidx.lifecycle:lifecycle-*:2.5.0-beta01
がリリースされました。バージョン 2.5.0-beta01 に含まれる commit については、こちらをご覧ください。
API の変更
- 状態を
SavedStateHandle
に維持するためのキーとしてプロパティ名を使用するSavedStateHandle.saveable
プロパティ デリゲートを追加しました。(I8bb86、b/225014345)
バグの修正
- メインでない下部のナビゲーション タブで別の
NavHost
内に 1 つのNavHost
をネストすると、複数のバックスタックを使用する場合にIllegalStateException
が発生する問題を修正しました。(I11bd5、b/228865698)
バージョン 2.5.0-alpha06
2022 年 4 月 6 日
androidx.lifecycle:lifecycle-*:2.5.0-alpha06
がリリースされました。バージョン 2.5.0-alpha06 に含まれる commit については、こちらをご覧ください。
新機能
rememberSaveable
と同等の機能を実現するため、試験運用版のMutableState
のオーバーロードをSavedStateHandle.saveable
に追加しました。(I38cfe、b/224565154)
API の変更
CreationExtras
がシールクラスではなく抽象クラスになりました。(Ib8a7a)
バグの修正
SavedStateHandleController
によって引き起こされるIllegalStateException: Already attached to lifecycleOwner
エラーを修正しました。(I7ea47、b/215406268)
バージョン 2.5.0-alpha05
2022 年 3 月 23 日
androidx.lifecycle:lifecycle-*:2.5.0-alpha05
がリリースされました。バージョン 2.5.0-alpha05 に含まれる commit については、こちらをご覧ください。
新機能
lifecycle-viewmodel-compose
モジュールでSavedStateHandleSaver
が提供されるようになりました。この試験運用版 API は、SavedStateHandle
の値が、rememberSaveable
が使用するものと同じ保存済みインスタンスの状態と正しく統合されるようにします。(Ia88b7、b/195689777)
API の変更
- Java での Lifecycle 2.3 と Lifecycle のそれより新しいバージョンとの互換性に関する問題を修正しました。(I52c8a、b/219545060)
バグの修正
SavedStateViewFactory
が、SavedStateRegistryOwner
で初期化された場合でもCreationExtras
を使用できるようになりました。エクストラが指定されている場合、初期化された引数は無視されます。(I6c43b、b/224844583)
バージョン 2.5.0-alpha04
2022 年 3 月 9 日
androidx.lifecycle:lifecycle-*:2.5.0-alpha04
がリリースされました。バージョン 2.5.0-alpha04 に含まれる commit については、こちらをご覧ください。
API の変更
LiveData
を使用する代わりに値の変更をモニタリングする KotlinStateFlow
を返すgetStateFlow()
API をSavedStateHandle
が提供するようになりました。(Iad3ab、b/178037961)
バージョン 2.5.0-alpha03
2022 年 2 月 23 日
androidx.lifecycle:lifecycle-*:2.5.0-alpha03
がリリースされました。バージョン 2.5.0-alpha03 に含まれる commit については、こちらをご覧ください。
新機能
addCloseable()
API と新しいコンストラクタ オーバーロードを追加しました。これにより、ViewModel
がクリアされるときに閉じられる 1 つ以上のCloseable
オブジェクトをViewModel
に追加できるようになり、onCleared()
で手動の作業が不要になります。(I55ea0)lifecycle-viewmodel
がInitializerViewModelFactory
を提供するようになりました。これにより、CreationExtras
をメインのデータソースとして使用して、特定のViewModel
クラスを処理するためのラムダを追加できるようになります。(If58fc、b/216687549)lifecycle-viewmodel-compose
がラムダ ファクトリを受け取るviewModel()
API を提供するようになりました。これにより、カスタムのViewModelProvider.Factory
を作成せずに、ViewModel
インスタンスを作成できるようになります。(I97fbb、b/216688927)
API の変更
lifecycle-viewmodel-compose
からCreationExtras
でViewModel
を作成できるようになりました。(I08887、b/216688927)
動作の変更
Lifecycle.State
をINITIALIZED
からDESTROYED
に変更しようとすると、Lifecycle
にオブザーバーがアタッチされているかどうかにかかわらず、常にIllegalStateException
がスローされるようになりました。(I7c390、b/177924329)LifecycleRegistry
は、オブザーバーがDESTROYED
状態に達したときにオブザーバーをクリアするようになりました。(I4f8dd、b/142925860)
バージョン 2.5.0-alpha02
2022 年 2 月 9 日
androidx.lifecycle:lifecycle-*:2.5.0-alpha02
がリリースされました。バージョン 2.5.0-alpha02 に含まれる commit については、こちらをご覧ください。
API の変更
SavedStateHandle
とSavedStateViewModelFactory
が Kotlin に変換されました。これにより、両クラスのジェネリクスの null 可能性が改善されました。(Ib6ce2、b/216168263、I9647a、b/177667711)LiveData
switchMap
関数パラメータの出力が null 許容型になりました。(I40396、b/132923666)LiveData
-ktx 拡張機能に@CheckResult
アノテーションが付けられ、これらの関数を呼び出すときに結果を使用することが強制されるようになりました。(Ia0f05、b/207325134)
動作の変更
SavedStateHandle
が、指定されたキーの値が存在しない場合に defaultValue を適切に保存するようになりました。(I1c6ce、b/178510877)
バグの修正
- Lifecycle
2.4.1
以降:ProcessLifecycleInitializer
がStartupException
をスローしないようにする修正をデフォルトで利用できるようにするため、Startup 1.1.1 に依存するようにlifecycle-process
を更新しました。(Ib01df、b/216490724) - パラメータの順序が誤っているカスタム
AndroidViewModel
クラスでViewModel
を作成しようとするときのエラー メッセージを改善しました。(I340f7、b/177667711) - アプリを設定せずに、
AndroidViewModelFactory
を使用してCreationExtras
を介してビューモデルを作成できるようになりました。(I6ebef、b/217271656)
バージョン 2.5.0-alpha01
2022 年 1 月 26 日
androidx.lifecycle:lifecycle-*:2.5.0-alpha01
がリリースされました。バージョン 2.5.0-alpha01 に含まれる commit については、こちらをご覧ください。
ViewModel CreationExtras
今回のリリースでは、ViewModel
の作成方法を再構築するための土台作りを行いました。これにより、それぞれが機能を追加する ViewModelProvider.Factory
のサブクラスの厳密なセット(AndroidViewModelFactory
による Application
コンストラクタ パラメータの許可、SavedStateViewModelFactory
や AbstractSavedStateViewModelFactory
による SavedStateHandle
コンストラクタ パラメータの許可など)を提供する代わりに、CreationExtras
という新しいコンセプトに基づくステートレスなファクトリの世界に移行しようとしています。(Ia7343、b/188691010、b/188541057)
この変更により、ViewModelProvider
は ViewModelProvider.Factory
の以前の create(Class<T>)
メソッドを直接呼び出すことはなくなりました。代わりに、create
の新しいオーバーロードである create(Class<T>, CreationExtras)
を呼び出します。ViewModelProvider.Factory
インスタンスの直接実装は、この新しい CreationExtras
のそれぞれに次のようにアクセスできます。
ViewModelProvider.NewInstanceFactory.VIEW_MODEL_KEY
: このString
により、ViewModelProvider.get()
に渡したカスタムキーにアクセスできます。ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY
により、Application
クラスにアクセスできます。SavedStateHandleSupport.SAVED_STATE_REGISTRY_OWNER_KEY
により、この ViewModel の作成に使用するSavedStateRegistryOwner
にアクセスできます。SavedStateHandleSupport.VIEW_MODEL_STORE_OWNER_KEY
により、この ViewModel の作成に使用するViewModelStoreOwner
にアクセスできます。SavedStateHandleSupport.DEFAULT_ARGS_KEY
により、SavedStateHandle
の作成に使用する引数のBundle
にアクセスできます。
上記のエクストラは、Activity 1.5.0-alpha01
、Fragment 1.5.0-alpha01
、Navigation 2.5.0-alpha01
を使用する場合に、デフォルトで提供されます。これより前のバージョンのライブラリを使用すると、CreationExtras
は空になります。ViewModelProvider.Factory
の既存のサブクラスはすべて、前のバージョンのライブラリが使用する以前の作成パスと、今後使用される CreationExtras
のパスの両方をサポートするよう書き換えられました。
この CreationExtras
を使用することで、厳密な Factory サブクラスの階層に依存せずに、必要な情報のみを各 ViewModel
に渡す ViewModelProvider.Factory
を作成できます。
class CustomFactory : ViewModelProvider.Factory {
override fun <T : ViewModel> create(modelClass: Class<T>, extras: CreationExtras): T {
return when (modelClass) {
HomeViewModel::class -> {
// Get the Application object from extras
val application = checkNotNull(extras[ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY])
// Pass it directly to HomeViewModel
HomeViewModel(application)
}
DetailViewModel::class -> {
// Create a SavedStateHandle for this ViewModel from extras
val savedStateHandle = extras.createSavedStateHandle()
DetailViewModel(savedStateHandle)
}
else -> throw IllegalArgumentException("Unknown class $modelClass")
} as T
}
}
SavedStateHandleSupport
の CreationExtras
で createSavedStateHandle()
Kotlin 拡張関数を使用して、それを必要とする 1 つの ViewModel に対してのみ SavedStateHandle
を作成します。(Ia6654、b/188541057)
カスタムの CreationExtras
を作成するには、ComponentActivity
または Fragment
で getDefaultViewModelCreationExtras()
をオーバーライドすることにより、組み込み型のアシスト付きインジェクションとしてカスタム ViewModelProvider.Factory
向けに使えるようにします。このようなエクストラは、ViewModelProvider
で直接使用する場合、または by viewModels()
や by activityViewModels()
の Kotlin プロパティ拡張を使用する場合に、自動的にカスタム Factory で利用できるようになります。(I79f2b、b/207012584、b/207012585、b/207012490)
バグの修正
SavedStateHandle
に指定されたデフォルト値が、SavedStateHandle
から明確に削除された場合でも、プロセスの終了および再作成後に再表示される問題を修正しました。その結果、SavedStateHandle
がデフォルト値と復元値を結合することはなくなり、復元値のみを信頼できる情報源として使用するようになります。(I53a4b)
バージョン 2.4
バージョン 2.4.1
2022 年 2 月 9 日
androidx.lifecycle:lifecycle-*:2.4.1
がリリースされました。バージョン 2.4.1 に含まれる commit については、こちらをご覧ください。
バグの修正
- Lifecycle
2.5.0-alpha01
からのバックポート:SavedStateHandle
に指定されたデフォルト値が、SavedStateHandle
から明確に削除された場合でも、プロセスの終了と再作成の後に再表示される問題を修正しました。その結果、SavedStateHandle
がデフォルト値と復元値を結合することはなくなり、復元値のみを信頼できる情報源として使用するようになります。(I53a4b) lifecycle-process
が Androidx Startup 1.1.1 に依存するようになり、ProcessLifecycleInitializer
を使用するとStartupException
が発生する回帰が修正されました。(b/216490724)
バージョン 2.4.0
2021 年 10 月 27 日
androidx.lifecycle:lifecycle-*:2.4.0
がリリースされました。バージョン 2.4.0 に含まれる commit については、こちらをご覧ください。
2.3.0 以降の重要な変更
@OnLifecycleEvent
のサポートが終了しました。代わりにLifecycleEventObserver
またはDefaultLifecycleObserver
を使用してください。androidx.lifecycle:lifecycle-viewmodel-compose
ライブラリが追加されました。viewModel()
コンポーザブルとLocalViewModelStoreOwner
が用意されています。- ソースレベルで互換性を破る変更:
ViewModelProvider
が Kotlin で書き換えられました。ViewModelProvider.Factory.create
メソッドで null 許容のジェネリックが使用できなくなりました。
- ソースレベルで互換性を破る変更:
- 新しいコルーチン API が
androidx.lifecycle:lifecycle-runtime-ktx
に追加されました。 Lifecycle.repeatOnLifecycle
: Lifecycle が特定の状態にあるときに、コルーチン内のコードブロックを実行する API。ライフサイクルがターゲット状態になるかターゲット状態でなくなるたびに、ブロックがキャンセルされて再起動されます。Flow.flowWithLifecycle
: ライフサイクルが特定の状態にあるときに、アップストリーム Flow から値を出力する API。DefaultLifecycleObserver
がlifecycle.lifecycle-common-java8
からlifecycle.lifecycle-common
に移動しました。lifecycle.lifecycle-common-java8
がlifecycle.lifecycle-common
に機能を追加することがなくなったため、依存関係をlifecycle.lifecycle-common
に置き換えることができます。lifecycle-viewmodel-ktx
からの非コルーチン API がlifecycle-viewmodel
モジュールに移動しました。lifecycle-process
がandroidx.startup
を使用してProcessLifecycleOwner
を初期化するようになりました。以前は、これは
androidx.lifecycle.ProcessLifecycleOwnerInitializer
によって行われていました。過去にプロセスのライフサイクルの初期化に使用されていた
ContentProvider
でtools:node="remove"
を使用していた場合は、以下のようにする必要があります。<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.lifecycle.ProcessLifecycleInitializer" android:value="androidx.startup" tools:node="remove" /> </provider>
(または)
<!-- If you want to disable androidx.startup completely. --> <provider android:name="androidx.startup.InitializationProvider" android:authorities="${applicationId}.androidx-startup" tools:node="remove"> </provider>
バージョン 2.4.0-rc01
2021 年 9 月 29 日
androidx.lifecycle:lifecycle-*:2.4.0-rc01
がリリースされました。Lifecycle 2.4.0-beta01 からの変更はありません。バージョン 2.4.0-rc01 に含まれる commit については、こちらをご覧ください。
バージョン 2.4.0-beta01
2021 年 9 月 15 日
androidx.lifecycle:lifecycle-*:2.4.0-beta01
がリリースされました。バージョン 2.4.0-beta01 に含まれる commit については、こちらをご覧ください。
API の変更
@OnLifecycleEvent
のサポートが終了しました。代わりにLifecycleEventObserver
またはDefaultLifecycleObserver
を使用してください。(I5a8fa)- DefaultLifecycleObserver が
androidx.lifecycle.lifecycle-common-java8
からandroidx.lifecycle.lifecycle-common
に移動しました。androidx.lifecycle.lifecycle-common-java8
がandroidx.lifecycle.lifecycle-common
に機能を追加することがなくなったため、依存関係をandroidx.lifecycle.lifecycle-common
に置き換えることができます。(I021aa) lifecycle-viewmodel-ktx
からの非コルーチン API がlifecycle-viewmodel
モジュールに移動しました。(I6d5b2)
外部からの協力
バージョン 2.4.0-alpha03
2021 年 8 月 4 日
androidx.lifecycle:lifecycle-*:2.4.0-alpha03
がリリースされました。バージョン 2.4.0-alpha03 に含まれる commit については、こちらをご覧ください。
API の変更
- ソースレベルで互換性を破る変更: ViewModelProvider が Kotlin で書き換えられました。
ViewModelProvider.Factory.create
メソッドで null 許容のジェネリックが使用できなくなりました。(I9b9f6)
動作の変更
Lifecycle.repeatOnLifecycle
:block
が、実行を繰り返すたびに常に連続的に呼び出されるようになりました。(Ibab33)
外部からの協力
repeatOnLifecycle
ドキュメントのコード スニペットを修正していただいた chao2zhang 氏に感謝いたします。#205
バージョン 2.4.0-alpha02
2021 年 6 月 16 日
androidx.lifecycle:lifecycle-*:2.4.0-alpha02
がリリースされました。バージョン 2.4.0-alpha02 に含まれる commit については、こちらをご覧ください。
新機能
onStart()
またはonResume()
でrepeateOnLifecycle
が正しく使用されていないことを検出する、新しいRepeatOnLifecycleWrongUsage
lint チェックをlifecycle-runtime-ktx
に追加しました。(706078、b/187887400)
API の変更
LifecycleOwner.addRepeatingJob
API が削除され、構造化された同時実行が優先される、推論が容易なLifecycle.repeatOnLifecycle
に置き換えられました。(I4a3a8)- 他の
androidx.startup.Initializer
が依存関係として使用できるようにProcessLifecycleInitializer
を一般公開しました。(I94c31)
バグの修正
- フィールドに修飾子がある場合の
NullSafeMutableLiveData
lint チェックに関する問題を修正しました。(#147、b/183696616) - ジェネリックを使用した場合の
NullSafeMutableLiveData
lint チェックに関する別の問題を修正しました。(#161、b/184830263)
外部からの協力
NullSafeMutableLiveData
lint チェックの改善にご協力いただいた maxsav 氏に感謝いたします。(#147、b/183696616)NullSafeMutableLiveData
lint チェックの改善にご協力いただいた kozaxinan 氏に感謝いたします。(#161、b/184830263)
バージョン 2.4.0-alpha01
2021 年 3 月 24 日
androidx.lifecycle:lifecycle-*:2.4.0-alpha01
がリリースされました。バージョン 2.4.0-alpha01 に含まれる commit については、こちらをご覧ください。
動作の変更
lifecycle-process
がandroidx.startup
を使用してProcessLifecycleOwner
を初期化するようになりました。以前は、これは
androidx.lifecycle.ProcessLifecycleOwnerInitializer
によって行われていました。過去にプロセスのライフサイクルの初期化に使用されていた
ContentProvider
でtools:node="remove"
を使用していた場合は、以下のようにする必要があります。<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.lifecycle.ProcessLifecycleInitializer" android:value="androidx.startup" tools:node="remove" /> </provider>
(または)
<!-- If you want to disable androidx.startup completely. --> <provider android:name="androidx.startup.InitializationProvider" android:authorities="${applicationId}.androidx-startup" tools:node="remove"> </provider>
API の変更
Lifecycle.repeatOnLifecycle
API を使用してライフサイクルが特定の状態にあるときに、アップストリーム Flow から値を出力するFlow.flowWithLifecycle
API を追加しました。これは新しいLifecycleOwner.addRepeatinJob
API に代わるものです。(I0f4cd)
バグの修正
- Lifecycle 2.3.1 以降:
NonNullableMutableLiveData
lint ルールで、null 許容が異なるフィールド変数を適切に区別できるようになりました。(b/169249668)
Lifecycle Viewmodel Compose バージョン 1.0.0
バージョン 1.0.0-alpha07
2021 年 6 月 16 日
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha07
がリリースされました。バージョン 1.0.0-alpha07 に含まれる commit については、こちらをご覧ください。
API の互換性を破る変更
viewModel()
がオプションのViewModelStoreOwner
を受け取るようになったことで、LocalViewModelStoreOwner
以外のオーナーを簡単に操作できるようになりました。たとえば、viewModel(navBackStackEntry)
を使用して、特定のナビゲーション グラフに関連付けられている ViewModel を取得できるようになりました。(I2628d、b/188693123)
バージョン 1.0.0-alpha06
2021 年 6 月 2 日
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha06
がリリースされました。バージョン 1.0.0-alpha06 に含まれる commit については、こちらをご覧ください。
Compose バージョン 1.0.0-beta08
との互換性を確保するために更新しました。
バージョン 1.0.0-alpha05
2021 年 5 月 18 日
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha05
がリリースされました。バージョン 1.0.0-alpha05 に含まれる commit については、こちらをご覧ください。
新機能
- Compose バージョン
1.0.0-beta07
との互換性を確保するために更新しました。
バグの修正
- ui-test-manifest と ui-tooling-data の AndroidManifest ファイルに、Android 12 との互換性が備わりました。(I6f9de、b/184718994)
バージョン 1.0.0-alpha04
2021 年 4 月 7 日
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha04
がリリースされました。バージョン 1.0.0-alpha04 に含まれる commit については、こちらをご覧ください。
依存関係の変更
- このバージョンを使用すると、
androidx.hilt:hilt-navigation-compose
とandroidx.navigation:navigation-compose
がandroidx.compose.compiler:compiler:1.0.0-beta04
とandroidx.compose.runtime:runtime:1.0.0-beta04
に対する依存関係を同期できます。1.0.0 の場合、コンパイラとランタイムが一致する必要があります。
バージョン 1.0.0-alpha03
2021 年 3 月 10 日
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha03
がリリースされました。バージョン 1.0.0-alpha03 に含まれる commit については、こちらをご覧ください。
API の変更
LocalViewModelStoreOwner.current
が null 許容のViewModelStoreOwner
を返すようになり、現在の合成中にViewModelStoreOwner
が使用可能かどうかを判断しやすくなりました。ViewModelStoreOwner
を必要とする API(viewModel()
やNavHost
など)は、ViewModelStoreOwner
が設定されていない場合、引き続き例外をスローします。(Idf39a)
Lifecycle-Viewmodel-Compose バージョン 1.0.0-alpha02
2021 年 2 月 24 日
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha02
がリリースされました。バージョン 1.0.0-alpha02 に含まれる commit については、こちらをご覧ください。
API の変更
LocalViewModelStoreOwner
にCompositionLocalProvider
で使用できるprovides
関数が追加され、asProvidableCompositionLocal()
API が置き換えられました。(I45d24)
Lifecycle-Viewmodel-Compose バージョン 1.0.0-alpha01
2021 年 2 月 10 日
androidx.lifecycle:lifecycle-viewmodel-compose:1.0.0-alpha01
がリリースされました。バージョン 1.0.0-alpha01 に含まれる commit については、こちらをご覧ください。
新機能
viewModel()
コンポーザブルとLocalViewModelStoreOwner
は、androidx.compose.ui.viewinterop
からandroidx.lifecycle.viewmodel.compose
パッケージのこのアーティファクトに移動しました。(I7a374)
バージョン 2.3.1
Lifecycle バージョン 2.3.1
2021 年 3 月 24 日
androidx.lifecycle:lifecycle-*:2.3.1
がリリースされました。バージョン 2.3.1 に含まれる commit については、こちらをご覧ください。
バグの修正
NonNullableMutableLiveData
lint ルールで、null 許容が異なるフィールド変数を適切に区別できるようになりました。(b/169249668)
バージョン 2.3.0
バージョン 2.3.0
2021 年 2 月 10 日
androidx.lifecycle:lifecycle-*:2.3.0
がリリースされました。バージョン 2.3.0 に含まれる commit については、こちらをご覧ください。
2.2.0 以降の主な変更
SavedStateHandle
非 Parcelable クラスのサポート: 指定されたキーのsetSavedStateProvider()
を呼び出せるようにすることで、SavedStateHandle
が遅延シリアル化をサポートするようになりました。これにより、SavedStateHandle
がその状態を保存するよう求められたときにsaveState()
へのコールバックを取得するSavedStateProvider
を提供します。非 Parcelable クラスを保存するをご覧ください。- Lifecycle Behavior Enforcement:
- LifecycleRegistry は最終状態として
DESTROYED
を適用するようになりました。 LifecycleRegistry
は、そのメソッドがメインスレッドで呼び出されることを確認するようになりました。これは、アクティビティやフラグメントなどのライフサイクルでは常に必須でしたが、メインスレッド以外のスレッドからオブザーバーを追加すると、実行時にクラッシュをキャッチすることが困難になっていました。独自のコンポーネントが所有するLifecycleRegistry
オブジェクトでは、LifecycleRegistry.createUnsafe(...)
を使用して明示的にチェックをオプトアウトできますが、その場合、このLifecycleRegistry
が別のスレッドからアクセスされたときに適切な同期が行われることを保証する必要があります。
- LifecycleRegistry は最終状態として
- Lifecycle State と Event Helpers:
State
と移行方向に応じてEvent
を生成するために、downFrom(State)
、downTo(State)
、upFrom(State)
、upTo(State)
の静的ヘルパー メソッドをLifecycle.Event
に追加しました。Lifecycle がEvent
の後で直接移行するState
を提供するgetTargetState()
メソッドを追加しました。 withStateAtLeast
:Lifecycle.withStateAtLeast
API を追加しました。これらの API は、ライフサイクルの状態を待機し、状態が変化した時点でコードの非停止ブロックを同期的に実行して、その結果により再開します。これらの API は、停止コードの実行を許可せず、カスタム ディスパッチャを使用しない点で、既存のwhen*
メソッドと異なります。(aosp/1326081)ViewTree
API: 新しいViewTreeLifecycleOwner.get(View)
API とViewTreeViewModelStoreOwner.get(View)
API を使用すると、それぞれView
インスタンスを指定して、含まれているLifecycleOwner
とViewModelStoreOwner
をそれぞれ取得できます。これを正しく入力するには、Activity1.2.0
、Fragment1.3.0
、AppCompat 1.3.0-alpha01 以降にアップグレードする必要があります。findViewTreeLifecycleOwner
とfindViewTreeViewModelStoreOwner
の Kotlin 拡張機能は、lifecycle-runtime-ktx
とlifecycle-viewmodel-ktx
でそれぞれ利用できます。LiveData.observe()
Kotlin 拡張機能のサポート終了: ラムダ構文を使用するために必要なLiveData.observe()
Kotlin 拡張機能のサポートが終了しました(Kotlin 1.4 を使用する際は不要となるため)。
バージョン 2.3.0-rc01
2020 年 12 月 16 日
androidx.lifecycle:lifecycle-*:2.3.0-rc01
がリリースされました。バージョン 2.3.0-rc01 に含まれる commit については、こちらをご覧ください。
バグの修正
SavedStateHandle
のkeys()
メソッドについて、状態の保存前と保存後で整合性が保たれるようになりました。set()
とgetLiveData()
で使用されるキーに加えて、これまでsetSavedStateProvider()
で使用されていたキーが含まれるようになりました。(aosp/1517919、b/174713653)
外部からの協力
- ライフサイクル対応コルーチンを中断する API が、
yield()
の呼び出しを適切に処理できるようになりました。Nicklas Ansman Giertz 氏に感謝いたします。(aosp/1430830、b/168777346)
バージョン 2.3.0-beta01
2020 年 10 月 1 日
androidx.lifecycle:lifecycle-*:2.3.0-beta01
がリリースされました。バージョン 2.3.0-beta01 に含まれる commit については、こちらをご覧ください。
API の変更
- ラムダ構文を使用するために必要な
LiveData.observe()
Kotlin 拡張機能のサポートが終了しました(Kotlin 1.4 を使用する際は不要となるため)。(I40d3f)
バグの修正
- Kotlin 1.4 を使用できるように、AndroidX をアップグレードしました。(Id6471、b/165307851、b/165300826)
ドキュメントの変更
- 特定のタイムアウト値の変更に関する詳細が含まれるように、
liveData
ビルダーとasLiveData()
ドキュメントが更新されました。(aosp/1122324)
バージョン 2.3.0-alpha07
2020 年 8 月 19 日
androidx.lifecycle:lifecycle-*:2.3.0-alpha07
がリリースされました。バージョン 2.3.0-alpha07 に含まれる commit については、こちらをご覧ください。
バグの修正
NullSafeMutableLiveData
lint チェックで発生するクラッシュの問題を修正しました。(aosp/1395367)
バージョン 2.3.0-alpha06
2020 年 7 月 22 日
androidx.lifecycle:lifecycle-*:2.3.0-alpha06
がリリースされました。バージョン 2.3.0-alpha06 に含まれる commit については、こちらをご覧ください。
新機能
State
と遷移方向に応じてEvent
を生成するため、downFrom(State)
、downTo(State)
、upFrom(State)
、upTo(State)
の静的ヘルパー メソッドをLifecycle.Event
に追加しました。Lifecycle がEvent
の後で直接移行するState
を提供するgetTargetState()
メソッドを追加しました。(I00887)Lifecycle.withStateAtLeast
API を追加しました。これらの API は、ライフサイクルの状態を待機し、状態が変化した時点でコードの非停止ブロックを同期的に実行して、その結果により再開します。これらの API は、停止コードの実行を許可せず、カスタム ディスパッチャを使用しない点で、既存のwhen*
メソッドと異なります。(aosp/1326081)
動作の変更
- LifecycleRegistry は最終状態として
DESTROYED
を適用するようになりました。(I00887) LifecycleRegistry
は、そのメソッドがメインスレッドで呼び出されることを確認するようになりました。これは、アクティビティやフラグメントなどのライフサイクルでは常に必須でしたが、メインスレッド以外のスレッドからオブザーバーを追加すると、実行時にクラッシュをキャッチすることが困難になっていました。独自のコンポーネントが所有するLifecycleRegistry
オブジェクトでは、LifecycleRegistry.createUnsafe(...)
を使用して明示的にチェックをオプトアウトできますが、その場合、このLifecycleRegistry
が別のスレッドからアクセスされたときに適切な同期が行われることを保証する必要があります。(Ie7280、b/137392809)
バグの修正
NullSafeMutableLiveData
で発生するクラッシュを解決しました。(b/159987480)lifecycle-livedata-core-ktx
(および特にNullSafeMutableLiveData
)にバンドルされている lint チェックのObsoleteLintCustomCheck
を修正しました。(b/158699265)
バージョン 2.3.0-alpha05
2020 年 6 月 24 日
androidx.lifecycle:lifecycle-*:2.3.0-alpha05
がリリースされました。バージョン 2.3.0-alpha05 に含まれる commit については、こちらをご覧ください。
バグの修正
LiveData
でリエントラントの処理が改善され、onActive()
またはonInactive()
への呼び出しの重複を防ぐようになりました(b/157840298)。- Android Studio 4.1 Canary 6 以上を使用している場合に Lint チェックが行われない問題を修正しました(aosp/1331903)。
バージョン 2.3.0-alpha04
2020 年 6 月 10 日
androidx.lifecycle:lifecycle-*:2.3.0-alpha04
がリリースされました。バージョン 2.3.0-alpha04 に含まれる commit については、こちらをご覧ください。
バグの修正
NonNullableMutableLiveData
lint チェックで発生するクラッシュを修正しました。(b/157294666)NonNullableMutableLiveData
lint チェックが、非 null 型のパラメータを持つMutableLiveData
にnull
値が設定されているケースを大幅にカバーするようになりました。(b/156002218)
バージョン 2.3.0-alpha03
2020 年 5 月 20 日
androidx.lifecycle:lifecycle-*:2.3.0-alpha03
がリリースされました。バージョン 2.3.0-alpha03 に含まれる commit については、こちらをご覧ください。
新機能
- 指定されたキーの
setSavedStateProvider()
を呼び出せるようにすることで、SavedStateHandle
が遅延シリアル化をサポートするようになりました。SavedStateHandle
が状態を保存するよう求められたときにsaveState()
へのコールバックを取得するSavedStateProvider
を提供します。(b/155106862) - 新しい
ViewTreeViewModelStoreOwner.get(View)
API を使用すると、View
インスタンスを指定して、含まれているViewModelStoreOwner
を取得できます。これを正しく入力するには、Activity1.2.0-alpha05
、Fragment1.3.0-alpha05
、AppCompat1.3.0-alpha01
にアップグレードする必要がありますfindViewModelStoreOwner()
Kotlin 拡張機能がlifecycle-viewmodel-ktx
に追加されました。(aosp/1295522)
バグの修正
- Lifecycle
2.3.0-alpha01
でリリースされたMutableLiveData
lint チェックがlifecycle-livedata-core-ktx
アーティファクトと一緒に公開されない問題を修正しました。(b/155323109)
バージョン 2.3.0-alpha02
2020 年 4 月 29 日
androidx.lifecycle:lifecycle-*:2.3.0-alpha02
がリリースされました。バージョン 2.3.0-alpha02 に含まれる commit については、こちらをご覧ください。
API の変更
SavedStateViewModelFactory
を使用することで、null のApplication
をコンストラクタに渡せるようになりました。これにより、Application がすぐに利用できず、AndroidViewModel
のサポートが不要な場合のサポートが向上しました。(aosp/1285740)
バグの修正
- API 28 以前のデバイスでのクラス検証エラーを回避することで、コールド スタートのパフォーマンスを改善しました。(aosp/1282118)
バージョン 2.3.0-alpha01
2020 年 3 月 4 日
androidx.lifecycle:lifecycle-*:2.3.0-alpha01
がリリースされました。バージョン 2.3.0-alpha01 に含まれる commit については、こちらをご覧ください。
新機能
- 新しい
ViewTreeLifecycleOwner.get(View)
API を使用すると、View
インスタンスを指定して、含まれているLifecycleOwner
を取得できます。これを正しく入力するには、Activity1.2.0-alpha01
と Fragment1.3.0-alpha01
にアップグレードする必要があります。findViewTreeLifecycleOwner
Kotlin 拡張機能はlifecycle-runtime-ktx
で利用できます。(aosp/1182361、aosp/1182956) - Kotlin で非 null として定義されている
MutableLiveData
にnull
値を設定すると警告する、新しい Lint チェックを追加しました。これは、livedata-core-ktx
またはlivedata-ktx
アーティファクトを使用する場合に利用できます。(aosp/1154723、aosp/1159092) LifecycleOwner
を実装するTestLifecycleOwner
を提供し、スレッドセーフで変更可能なLifecycle
を提供する、新しいlifecycle-runtime-testing
アーティファクトを利用できます。(aosp/1242438)
バグの修正
lifecycle-runtime
アーティファクトが一意のパッケージ名を持つようになりました。(aosp/1187196)
バージョン 2.2.0
ViewModel-Savedstate バージョン 2.2.0
2020 年 2 月 5 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:2.2.0
がリリースされました。バージョン 2.2.0 に含まれる commit については、こちらをご覧ください。
Lifecycle ViewModel SavedState は他の Lifecycle アーティファクトと同じバージョンを共有するようになりました。2.2.0
の動作は 1.0.0
の動作と同じです。
バージョン 2.2.0
2020 年 1 月 22 日
androidx.lifecycle:lifecycle-*:2.2.0
がリリースされました。バージョン 2.2.0 に含まれる commit については、こちらをご覧ください。
2.1.0 以降の重要な変更
- Lifecycle コルーチンの統合: 新しい
lifecycle-runtime-ktx
アーティファクトにより、Lifecycle コルーチンと Kotlin コルーチンとの統合機能が追加されています。また、コルーチンを活用できるようにlifecycle-livedata-ktx
が拡張されました。詳細については、アーキテクチャ コンポーネントで Kotlin コルーチンを使用するをご覧ください。 ViewModelProviders.of()
のサポート終了:ViewModelProviders.of()
のサポートが終了しました。Fragment1.2.0
を使用する場合、Fragment
またはFragmentActivity
を新しいViewModelProvider(ViewModelStoreOwner)
コンストラクタに渡すと、同じ機能を実現できます。lifecycle-extensions
アーティファクトのサポート終了: 上記ViewModelProviders.of()
のサポート終了をもって、このリリースのlifecycle-extensions
で最後に残った API がサポート終了となったため、このアーティファクトは完全にサポート終了とみなされます。今後リリースされる2.3.0
にlifecycle-extensions
が含まれる予定はないため、lifecycle-extensions
ではなく、必要な Lifecycle アーティファクト(たとえば、LifecycleService
を使用している場合はlifecycle-service
、ProcessLifecycleOwner
を使用している場合はlifecycle-process
)を利用することを強くおすすめします。- Gradle Incremental Annotation Processor: Lifecycle のアノテーション プロセッサはデフォルトでインクリメンタルです。
アプリが Java 8 プログラミング言語で作成されている場合は
DefautLifecycleObserver
を、Java 7 の場合はLifecycleEventObserver
を使用できます。
バージョン 2.2.0-rc03
2019 年 12 月 4 日
androidx.lifecycle:lifecycle-*:2.2.0-rc03
がリリースされました。バージョン 2.2.0-rc03 に含まれる commit については、こちらをご覧ください。
バグの修正
- モックされた
ViewModel
がViewModelStore
に保存され、後でデフォルト ファクトリでクエリが実行されたときに発生するエラーを修正しました。 launchWhenCreated
および同様のメソッドでDispatchers.Main.immediate
が対応するライフサイクル イベント中に同期的に呼び出されるように修正しています。(aosp/1156203)
外部寄与
- 本修正に寄与した AndersJärleberg 氏に感謝いたします。(aosp/1156203)
- インライン実行の実装に対するレビューを実施した JetBrains 社の Vsevolod Tolstopyatov 氏に感謝いたします。
依存関係の変更
- Lifecycle Extensions が Fragment
1.2.0-rc03
に依存するようになりました。
バージョン 2.2.0-rc02
2019 年 11 月 7 日
androidx.lifecycle:lifecycle-*:2.2.0-rc02
がリリースされました。バージョン 2.2.0-rc02 に含まれる commit については、こちらをご覧ください。
バグの修正
- ライブラリの ProGuard セットアップのバグを修正しました。このライブラリは、ターゲット API が 29 未満の場合、API 28 以降を搭載しているデバイスに影響します。(b/142778206)
バージョン 2.2.0-rc01
2019 年 10 月 23 日
androidx.lifecycle:lifecycle-*:2.2.0-rc01
がリリースされました。バージョン 2.2.0-rc01 に含まれる commit については、こちらをご覧ください。
バグの修正
Dispatchers.Main.immediate
の代わりにDispatchers.Main
を使用するため、launchWhenCreated
と関連メソッドが関連するライフサイクル メソッドより 1 フレーム遅れて実行される問題を修正しました。(aosp/1145596)
外部寄与
- 本修正に寄与した Nicklas Ansman 氏に感謝いたします。(aosp/1145596)
バージョン 2.2.0-beta01
2019 年 10 月 9 日
androidx.lifecycle:lifecycle-*:2.2.0-beta01
がリリースされました。バージョン 2.2.0-beta01 に含まれる commit については、こちらをご覧ください。
バグの修正
ProcessLifecycleOwner
の順序で Lifecycle 2.2.0-alpha05 に生じる回帰と、アクティビティのLifecycleOwner
が Android 10 デバイスで開始および再開に移行する問題を修正しました。(aosp/1128132)- Lifecycle
2.2.0-alpha05
で生じる回帰を修正しました。バージョン2.0.0
や2.1.0
のlifecycle-process
を使用するとNullPointerException
が発生していました。(b/141536990)
バージョン 2.2.0-alpha05
2019 年 9 月 18 日
androidx.lifecycle:lifecycle-*:2.2.0-alpha05
がリリースされました。バージョン 2.2.0-alpha05 に含まれる commit については、こちらをご覧ください。
バグの修正
- コルーチンのライブデータ ビルダーの競合状態を修正しました。(b/140249349)
バージョン 2.2.0-alpha04
2019 年 9 月 5 日
androidx.lifecycle:lifecycle-*:2.2.0-alpha04
がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。
新機能
lifecycleScope
、whenCreated
、whenStarted
、whenResumed
、viewModelScope
、またliveData
の基となる実装では、Dispatchers.Main
ではなくDispatchers.Main.immediate
が使用されるようになりました。(b/139740492)
外部寄与
Dispatchers.Main.immediate
への移行に寄与した Nicklas Ansman 氏に感謝いたします。(aosp/1106073)
バージョン 2.2.0-alpha03
2019 年 8 月 7 日
androidx.lifecycle:lifecycle-*:2.2.0-alpha03
がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。
新機能
ViewModelStoreOwner
の実装では、オプションでHasDefaultViewModelProviderFactory
を実装して、デフォルトのViewModelProvider.Factory
を提供できるようになりました。これは Activity1.1.0-alpha02
、Fragment1.2.0-alpha02
、Navigation2.2.0-alpha01
に対して行われました。(aosp/1092370、b/135716331)
API の変更
ViewModelProviders.of()
が非推奨になりました。Fragment
またはFragmentActivity
を新しいViewModelProvider(ViewModelStoreOwner)
コンストラクタに渡すと、同じ機能を実現できます。(aosp/1009889)
バージョン 2.2.0-alpha02
2019 年 7 月 2 日
androidx.lifecycle:*:2.2.0-alpha02
がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。
API の変更
LiveDataScope.initialValue
を、liveData
ブロックの現在の出力値をトラックするLiveDataScope.latestValue
に置き換えました。- タイプ
Duration
としてtimeout
パラメータを受け取るliveData
ビルダーに新しいオーバーロードを追加しました。
Version 2.2.0-alpha01
2019 年 5 月 7 日
androidx.lifecycle:*:2.2.0-alpha01
がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。
新機能
- このリリースでは、Lifecycle と LiveData の Kotlin コルーチンのサポートを追加する新機能が追加されています。 詳細なドキュメントについては、こちらをご覧ください。
ViewModel-SavedState バージョン 1.0.0
バージョン 1.0.0
2020 年 1 月 22 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0
がリリースされました。バージョン 1.0.0 に含まれる commit については、こちらをご覧ください。
1.0.0 の重要な機能
- 新しい SavedStateHandle クラスが追加されました。これにより、
ViewModel
クラスが保存済み状態にアクセスして簡単に扱うことができるようになります。このオブジェクトはViewModel
クラスのコンストラクタで受け取ることができ、Fragment によってデフォルトで提供されるファクトリと AppCompatActivity がSavedStateHandle
を自動的に追加します。 - AbstractSavedStateViewModelFactory が追加されました。
ViewModel
のカスタム ファクトリを作成し、これらのファクトリがSavedStateHandle
にアクセスできるようにします。
ViewModel-SavedState バージョン 1.0.0-rc03
2019 年 12 月 4 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-rc03
がリリースされました。バージョン 1.0.0-rc03 に含まれる commit については、こちらをご覧ください。
依存関係の変更
- Lifecycle ViewModel SavedState は Lifecycle
2.2.0-rc03
に依存するようになりました。
ViewModel-Savedstate バージョン 1.0.0-rc02
2019 年 11 月 7 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-rc02
がリリースされました。バージョン 1.0.0-rc02 に含まれる commit については、こちらをご覧ください。
依存関係の変更
- Lifecycle
2.2.0-rc02
に依存するようになりました。
ViewModel-SavedState バージョン 1.0.0-rc01
2019 年 10 月 23 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-rc01
がリリースされました。1.0.0-beta01
からの変更はありません。バージョン 1.0.0-rc01 に含まれる commit については、こちらをご覧ください。
ViewModel-Savedstate バージョン 1.0.0-beta01
2019 年 10 月 9 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-beta01
がリリースされました。バージョン 1.0.0-beta01 に含まれる commit については、こちらをご覧ください。
バグの修正
Activity.onActivityResult()
で SavedState ViewModel に初めてアクセスするとIllegalStateException
が発生する問題を修正しました。(b/139093676)AbstractSavedStateViewModelFactory
の使用時のIllegalStateException
を修正しました。(b/141225984)
ViewModel-SavedState バージョン 1.0.0-alpha05
2019 年 9 月 18 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-alpha05
がリリースされました。バージョン 1.0.0-alpha05 に含まれる commit については、こちらをご覧ください。
API の変更
SavedStateViewModelFactory
はAbstractSavedStateViewModelFactory
を拡張することはなく、SavedStateHandle
は ViewModel が必要とする場合にのみ作成されます。(aosp/1113593)
ViewModel-SavedState バージョン 1.0.0-alpha03
2019 年 8 月 7 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-alpha03
がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。
互換性を破る変更
lifecycle-viewmodel-savedstate
がfragment
に依存しなくなり、関連するSavedStateViewModelFactory(Fragment)
とSavedStateViewModelFactory(FragmentActivity)
のコンストラクタが削除されました。代わりにSavedStateViewModelFactory
が、Activity1.1.0-alpha02
、Fragment1.2.0-alpha02
、Navigation2.2.0-alpha01
のデフォルト ファクトリになりました。(b/135716331)
ViewModel-SavedState バージョン 1.0.0-alpha02
2019 年 7 月 2 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-alpha02
がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。
新機能
- デフォルト値を受け入れる
SavedStateHandle.getLiveData()
オーバーロードを追加しました。
API の変更
SavedStateVMFactory
の名前がSavedStateViewModelFactory
に変更されました。AbstractSavedStateVMFactory
の名前がAbstractSavedStateViewModelFactory
に変更されました。
ViewModel-Savedstate バージョン 1.0.0-alpha01
2019 年 3 月 13 日
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-alpha01
がリリースされました。この初回リリースの完全な commit ログについては、こちらをご覧ください。
新機能
ViewModels
で savedstate を使用できるようになりました。そのためには、新しく導入されたビューモデルのファクトリSavedStateVMFactory
を使用し、ViewModel にはパラメータとしてSavedStateHandle
オブジェクトを受け取るコンストラクタが必要です。
バージョン 2.1.0
2.0.0 以降の重要な変更
- ライフサイクル イベントのストリームが必要な場合のために、
LifecycleEventObserver
を追加しました。非表示のGenericLifecycleObserver
クラスではなく、公開 API です。 LiveData.observe
メソッドとTransformations.*
メソッドの ktx 拡張機能を追加しました。- ソースの
LiveData
値が変更されるまで値を出力しない新しい LiveData オブジェクトを作成する、Transformations.distinctUntilChanged
を追加しました。 - 拡張プロパティ
ViewModel.viewModelScope
を追加することで、ViewModels にコルーチンのサポートを追加しました。
バージョン 2.1.0
2019 年 9 月 5 日
androidx.lifecycle:lifecycle-*:2.1.0
がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。
バージョン 2.1.0-rc01
2019 年 7 月 2 日
androidx.lifecycle:*:2.1.0-rc01
がリリースされました。androidx.lifecycle:*:2.1.0-beta01
からの変更はありません。このバージョンに含まれる commit については、こちらをご覧ください。
バージョン 2.1.0-beta01
2019 年 5 月 7 日
androidx.lifecycle:*:2.1.0-beta01
がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。
新機能
- Lifecycle はベータ版に進みました。変換と観察のための
liveData
拡張関数、プロパティ委任によるViewModel
初期化など、以前のアルファ版で導入された API は安定しており、変更予定はありません。
バージョン 2.1.0-alpha04
2019 年 4 月 3 日
androidx.lifecycle:*:2.1.0-alpha04
がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。
API の変更
- 互換性を破る変更:
by viewModels()
とby activityViewModels()
の基になる API は、ViewModelStoreOwner
だけでなくViewModelStore
を直接サポートするように変更されました。(aosp/932932)
バージョン 2.1.0-alpha03
2019 年 3 月 13 日
androidx.lifecycle:*:2.1.0-alpha03
がリリースされました。このバージョンに含まれる commit の完全なリストについては、こちらをご覧ください。
API の変更
ViewModelProvider.KeyedFactory
が削除されました。ViewModelProvider.Factory
に続く 2 番目のインターフェースでしたが、Kotlin のby viewmodels {}
のプロパティ委任の新機能と十分にコンポーズしませんでした。(aosp/914133)
バージョン 2.1.0-alpha02
2019 年 1 月 30 日
androidx.lifecycle 2.1.0-alpha02
がリリースされました。
API の変更
LifecycleRegistry
にsetCurrentState()
メソッドが追加されました。このメソッドは、サポートが終了したsetState()
メソッドを置き換えるものです。(aosp/880715)
バグの修正
- 含まれている
ViewModelStore
がクリアされるとモックのViewModel
インスタンスがクラッシュするという問題を修正しました。(b/122273087)
バージョン 2.1.0-alpha01
2018 年 12 月 17 日
androidx.lifecycle 2.1.0-alpha01
がリリースされました。
新機能
- ライフサイクル イベントのストリームが必要な場合のために、
LifecycleEventObserver
を追加しました。非表示のGenericLifecycleObserver
クラスではなく、公開 API です。 LiveData.observe
メソッドとTransformations.*
メソッドの ktx 拡張機能を追加しました。- メソッド
Transformations.distinctUntilChanged
が追加されました。ソースの LiveData 値が変更されるまで値を出力しない新しいLiveData
オブジェクトを作成します。 - ViewModels のコルーチンのサポート: 拡張プロパティ
ViewModel.viewModelScope
が追加されました。 ViewModelProvider.KeyedFactory
を追加しました。create
メソッドでkey
とClass
を受け取る ViewModels のファクトリです。
バージョン 2.0.0
バージョン 2.0.0
2018 年 9 月 21 日
Lifecycle 2.0.0
のリリースでは、ViewModel に関する 2.0.0-rc01
のバグが 1 件修正されています。
バグの修正
- コンストラクタを誤って削除する ViewModel ProGuard ルールを修正しました。b/112230489
バージョン 2.0.0-beta01
2018 年 7 月 2 日
バグの修正
- 実装のみを保持し、サブインターフェースは保持しないように LifecycleObserver ProGuard ルールを修正しました。b/71389427
- 難読化と圧縮を許可するように ViewModel ProGuard ルールを修正しました。
AndroidX 以前のバージョン
AndroidX 以前のバージョンの Lifecycle では、次の依存関係を含めます。
dependencies {
def lifecycle_version = "1.1.1"
// ViewModel and LiveData
implementation "android.arch.lifecycle:extensions:$lifecycle_version"
// alternatively - just ViewModel
implementation "android.arch.lifecycle:viewmodel:$lifecycle_version" // For Kotlin use viewmodel-ktx
// alternatively - just LiveData
implementation "android.arch.lifecycle:livedata:$lifecycle_version"
// alternatively - Lifecycles only (no ViewModel or LiveData).
// Support library depends on this lightweight import
implementation "android.arch.lifecycle:runtime:$lifecycle_version"
annotationProcessor "android.arch.lifecycle:compiler:$lifecycle_version" // For Kotlin use kapt instead of annotationProcessor
// alternately - if using Java8, use the following instead of compiler
implementation "android.arch.lifecycle:common-java8:$lifecycle_version"
// optional - ReactiveStreams support for LiveData
implementation "android.arch.lifecycle:reactivestreams:$lifecycle_version"
// optional - Test helpers for LiveData
testImplementation "android.arch.core:core-testing:$lifecycle_version"
}
バージョン 1.1.1
2018 年 3 月 21 日
1 つの小規模な変更のみ: android.arch.core.util.Function
が arch:runtime
から arch:common
に移動されました。これにより、(下記の paging:common
のような)ランタイムの依存関係がなくてもこのメソッドを使用できるようになりました。
lifecycle:common
は lifecycle:runtime
の依存関係であるため、この変更による lifecycle:runtime
への直接的な影響はありません。影響を受けるのは、Paging と同様に、lifecycle:common
に直接依存するモジュールだけです。
バージョン 1.1.0
2018 年 1 月 22 日
パッケージの変更
以下の新しい、極めて小さな依存関係を利用できるようになりました。
android.arch.lifecycle:livedata:1.1.0
android.arch.lifecycle:viewmodel:1.1.0
API の変更
- サポートが終了した
LifecycleActivity
とLifecycleFragment
は削除されました。FragmentActivity
、AppCompatActivity
を使用するか、Fragment
をサポートしてください。 @NonNull
アノテーションがViewModelProviders
とViewModelStores
に追加されました。ViewModelProviders
コンストラクタのサポートが終了しました。その静的メソッドを直接使用してください。ViewModelProviders.DefaultFactory
のサポートが終了しました。ViewModelProvider.AndroidViewModelFactory
を使用してください。- 静的な
ViewModelProvider.AndroidViewModelFactory.getInstance(Application)
メソッドが追加され、ViewModel
インスタンスやAndroidViewModel
インスタンスの作成に適した静的なFactory
を取得できるようになりました。