DataStore（Kotlin マルチプラットフォーム）

DataStore ライブラリは、データを非同期で、一貫して、トランザクションとして保存することで、SharedPreferences の欠点の一部を解消します。このページでは、Kotlin マルチプラットフォーム（KMP）プロジェクトでの DataStore の作成について説明します。DataStore の詳細については、DataStore の主なドキュメントと公式サンプルをご覧ください。

依存関係の設定

DataStore は、バージョン 1.1.0 以降で KMP をサポートしています。

KMP プロジェクトで DataStore を設定するには、モジュールの build.gradle.kts ファイルにアーティファクトの依存関係を追加します。

• androidx.datastore:datastore - DataStore ライブラリ
• androidx.datastore:datastore-preferences - Preferences DataStore ライブラリ

DataStore クラスを定義する

共有 KMP モジュールの共通ソース内で、DataStoreFactory を使用して DataStore クラスを定義できます。これらのクラスを共通のソースに配置すると、すべてのターゲット プラットフォーム間で共有できるようになります。actual 宣言と expect 宣言を使用して、プラットフォーム固有の実装を作成できます。

DataStore インスタンスを作成する

各プラットフォームで DataStore オブジェクトをインスタンス化する方法を定義する必要があります。ファイル システム API の違いにより、これは API で特定のプラットフォームのソースセットに含める必要がある唯一の部分です。

一般

// shared/src/androidMain/kotlin/createDataStore.kt

/**
 * Gets the singleton DataStore instance, creating it if necessary.
 */
fun createDataStore(producePath: () -> String): DataStore<Preferences> =
        PreferenceDataStoreFactory.createWithPath(
            produceFile = { producePath().toPath() }
        )

internal const val dataStoreFileName = "dice.preferences_pb"

Android

DataStore インスタンスを作成するには、Context とファイルパスが必要です。

// shared/src/androidMain/kotlin/createDataStore.android.kt

fun createDataStore(context: Context): DataStore<Preferences> = createDataStore(
    producePath = { context.filesDir.resolve(dataStoreFileName).absolutePath }
)

iOS

DataStore インスタンスを作成するには、データベース ファクトリとデータベース パスが必要です。

// shared/src/iosMain/kotlin/createDataStore.kt

fun createDataStore(): DataStore<Preferences> = createDataStore(
    producePath = {
        val documentDirectory: NSURL? = NSFileManager.defaultManager.URLForDirectory(
            directory = NSDocumentDirectory,
            inDomain = NSUserDomainMask,
            appropriateForURL = null,
            create = false,
            error = null,
        )
        requireNotNull(documentDirectory).path + "/$dataStoreFileName"
    }
)