Настройка DataStore для KMP

Библиотека DataStore хранит данные асинхронно, согласованно и транзакционно, преодолевая некоторые недостатки SharedPreferences. На этой странице рассказывается о том, как создать DataStore в проектах Kotlin Multiplatform (KMP). Дополнительную информацию о DataStore можно найти в основной документации по DataStore и официальных примерах.

Настройте зависимости

Чтобы настроить DataStore в проекте KMP, добавьте зависимости для артефактов в файл build.gradle.kts для модуля:

commonMain.dependencies {
  // DataStore library
  implementation("androidx.datastore:datastore-core:1.2.1")
  // The Preferences DataStore library
  implementation("androidx.datastore:datastore-preferences-core:1.2.1")
}

Определите классы DataStore

Вы можете определить класс DataStore с помощью DataStoreFactory внутри общего источника вашего общего модуля KMP. Размещение этих классов в общих источниках позволяет использовать их на всех целевых платформах. Вы можете использовать объявления actual и expect для создания реализаций, предназначенных для определенных платформ.

Создайте экземпляр DataStore

Вам нужно определить, как создать экземпляр объекта DataStore на каждой платформе. Это единственная часть API, которая должна находиться в наборах исходных файлов для конкретной платформы из-за различий в API файловых систем.

Частое

// shared/src/commonMain/kotlin/createDataStore.kt

/**
 *   Gets the singleton DataStore instance, creating it if necessary.
 */
fun createDataStore(storage: Storage<Preferences>): DataStore<Preferences> =
        DataStoreFactory.create(storage = storage)

internal const val dataStoreFileName = "dice.preferences_pb"

Android

Чтобы создать экземпляр DataStore на Android, вам понадобится Context и путь.

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

fun createDataStore(): DataStore<Preferences> = createDataStore(
    storage = FileStorage(
        serializer = PreferencesSerializer,
        produceFile = { context.filesDir.resolve(dataStoreFileName) }
    )
)

iOS

В iOS путь можно получить из NSDocumentDirectory:

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

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

Веб

Чтобы создать экземпляр DataStore в интернете, можно использовать WebLocalStorage или WebSessionStorage:

// shared/src/jsMain/kotlin/createDataStore.web.kt (also works for wasmJsMain)

fun createDataStore(): DataStore<Preferences> = createDataStore(
    storage = WebLocalStorage(
        serializer = PreferencesSerializer,
        name = dataStoreFileName
    )
)

JVM (компьютер)

Чтобы создать экземпляр DataStore на JVM (настольном компьютере), укажите путь, используя Java или Kotlin API:

// shared/src/jvmMain/kotlin/createDataStore.desktop.kt

fun createDataStore(): DataStore<Preferences> = createDataStore(
    storage = FileStorage(
        serializer = PreferencesSerializer,
        produceFile = { File(System.getProperty("java.io.tmpdir"), dataStoreFileName) }
    )
)