about datastore

[LeoAndo]

DataStore とは

DataStore は、SharedPreferences に代わるものとして改善された新しいデータ ストレージ ソリューションです。Kotlin のコルーチンと Flow に基づいて構築された DataStore には、次の 2 種類の実装があります。プロトコル バッファに基づく型付きオブジェクトを保存する Proto DataStore と、Key-Value ペアを保存する Preferences DataStore です。データは非同期で一貫性を持ちトランザクションとして保存されるため、SharedPreferences の欠点の一部が解消されます。

#refs
https://developer.android.com/codelabs/android-preferences-datastore#3

[LeoAndo]

preferences DatatStore vs Proto DataStore

https://youtu.be/mdQjuZbLv9Y?list=PLWz5rJ2EKKc8to3Ere-ePuco69yBUmQ9C&t=288

preferences DataStore

• Key Valueのペアで管理
• 型安全ではない

Proto DataStore

• 型安全
• プロトコル バッファを使用してスキーマを定義します。Protobufs を使用すると、強力に型付けされたデータを引き継ぎできます

[LeoAndo]

SharedPreferencesの弱点

SharedPreferences には、UI スレッドで呼び出しても安全に見える同期 API がありますが、これは実際にはディスク I/O オペレーションを行います。さらに、apply() は fsync() で UI スレッドをブロックします。

https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/app/SharedPreferencesImpl.java;l=65?q=SharedPreferencesImpl&ss=android%2Fplatform%2Fsuperproject&hl=ja

https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/app/SharedPreferencesImpl.java;l=505?q=SharedPreferencesImpl&ss=android%2Fplatform%2Fsuperproject&hl=ja

https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/app/SharedPreferencesImpl.java;l=729;drc=master?q=SharedPreferencesImpl&ss=android%2Fplatform%2Fsuperproject&hl=ja

refs

https://developer.android.com/codelabs/android-preferences-datastore#3

[LeoAndo]

Preferences DataStore の概要

• データ更新をトランザクションとして処理する
• データの現在の状態を表す Flow を公開する
• データの永続化メソッドがない（apply()、commit()）
• 内部状態への変更可能な参照が返されない
• 型付けされたキーを使用して Map や MutableMap のような API を公開する

メモ

• 値の取得: 型安全ではない

[LeoAndo]

Proto DataStore - 概要

SharedPreferences と Preferences DataStore の欠点のひとつとして、スキーマを定義したりキーへのアクセスが正しい型によるものか確認したりする方法がないということが挙げられます。Proto DataStore では、プロトコル バッファを使用してスキーマを定義することで、この問題に対処します。Proto DataStore を使用すると、格納される型が認識され、その型のみが提供されるので、キーを使用する必要がなくなります。

メモ

• liteオプションはAndroidに推奨されるオプション
  https://github.com/LeoAndo/android-datastore/blob/proto_datastore/app/build.gradle#L88:L90

• デシリアライズに失敗した場合のエラーハンドリングは,ReplaceFileCorruptionHandlerを利用する.
  https://github.com/LeoAndo/android-datastore/blob/proto_datastore/app/src/main/java/com/codelab/android/datastore/data/UserPreferencesSerializer.kt#L37
  https://github.com/LeoAndo/android-datastore/blob/proto_datastore/app/src/main/java/com/codelab/android/datastore/ui/TasksActivity.kt#L40

[LeoAndo]

protocol-buffersの編集にはプラグインを入れる必要がある

https://plugins.jetbrains.com/plugin/14004-protocol-buffers