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

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

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

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

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

Определите классы хранилища данных.

Вы можете определить класс 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 (для настольных компьютеров) укажите путь, используя API Java или Kotlin:

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

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