DataStore (мультиплатформенный Kotlin)

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

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

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

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

Определить классы 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(producePath: () -> String): DataStore<Preferences> =
        PreferenceDataStoreFactory.createWithPath(
            produceFile = { producePath().toPath() }
        )

internal const val dataStoreFileName = "dice.preferences_pb"

андроид

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

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

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

iOS

В iOS вы можете получить путь из NSDocumentDirectory :

// shared/src/iosMain/kotlin/createDataStore.ios.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"
    }
)

JVM (настольный компьютер)

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

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

fun createDataStore(): DataStore<Preferences> = createDataStore(
    producePath = {
      val file = File(System.getProperty("java.io.tmpdir"), dataStoreFileName)
      file.absolutePath
    }
)