Configurar o DataStore para KMP

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 do Kotlin Multiplatform (KMP). Para mais informações sobre o DataStore, consulte a documentação principal do DataStore.

Configurar dependências

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

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

Definir as classes do DataStore

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

Criar a instância do DataStore

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

Comum

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

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

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

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

iOS

No iOS, é possível recuperar o caminho do NSDocumentDirectory:

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

@OptIn(ExperimentalForeignApi::class)
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()
        }
    )
)

Web

Para criar a instância DataStore na Web, use WebLocalStorage ou WebSessionStorage:

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

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

JVM (computador)

Para criar a instância DataStore na JVM (computador), forneça um caminho usando as APIs Java ou Kotlin:

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

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