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

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

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

DataStore поддерживает KMP в версиях 1.1.0 и выше.

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

• androidx.datastore:datastore — библиотека хранилища данных
• androidx.datastore:datastore-preferences — библиотека хранилища данных настроек.

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

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

Создайте экземпляр хранилища данных.

Вам необходимо определить, как создать экземпляр объекта 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"

Андроид

Чтобы создать экземпляр 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"
    }
)