DataStore (Kotlin multiplataforma)

A biblioteca DataStore armazena dados de forma assíncrona, consistente e transacional, superando algumas das desvantagens de SharedPreferences. Esta página se concentra na criação do DataStore em projetos Kotlin Multiplatform (KMP). Para mais informações sobre o DataStore, consulte a documentação principal do DataStore e os exemplos oficiais.

Como configurar dependências

O DataStore oferece suporte ao KMP nas versões 1.1.0 e mais recentes.

Para configurar o DataStore no projeto do KMP, adicione as dependências dos artefatos no arquivo build.gradle.kts do módulo:

  • androidx.datastore:datastore: biblioteca DataStore
  • androidx.datastore:datastore-preferences: a biblioteca Preferences DataStore

Definir as classes do DataStore

É possível definir a classe DataStore com DataStoreFactory dentro da fonte comum do módulo KMP compartilhado. Colocar essas classes em origens comuns permite que elas sejam compartilhadas em todas as plataformas de destino. É possível usar declarações actual e expect para criar implementações específicas da plataforma.

Criar a instância do DataStore

Você precisa definir como instanciar o objeto DataStore em cada plataforma. Essa é a única parte da API que precisa estar nos conjuntos de origem da plataforma específica devido às diferenças nas APIs do sistema de arquivos.

Comum

// 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

Para criar a instância DataStore, você precisa de um Context com o caminho do arquivo.

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

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

iOS

Para criar a instância do DataStore, você precisa de uma fábrica do DataStore com o caminho do 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"
    }
)