Die DataStore-Bibliothek speichert Daten asynchron, konsistent und transaktional und behebt so einige der Nachteile von SharedPreferences. Auf dieser Seite geht es um das Erstellen von DataStore in Kotlin Multiplatform-Projekten (KMP). Weitere Informationen zu DataStore finden Sie in der Primärdokumentation für DataStore und in den offiziellen Beispielen.
Abhängigkeiten einrichten
Wenn Sie DataStore in Ihrem KMP-Projekt einrichten möchten, fügen Sie die Abhängigkeiten für die Artefakte in die Datei build.gradle.kts für Ihr Modul ein:
commonMain.dependencies { // DataStore library implementation("androidx.datastore:datastore:1.1.7") // The Preferences DataStore library implementation("androidx.datastore:datastore-preferences:1.1.7") } DataStore-Klassen definieren
Sie können die DataStore-Klasse mit DataStoreFactory in der gemeinsamen Quelle Ihres freigegebenen KMP-Moduls definieren. Wenn Sie diese Klassen in gemeinsamen Quellen platzieren, können sie auf allen Zielplattformen verwendet werden. Sie können actual- und expect-Deklarationen verwenden, um plattformspezifische Implementierungen zu erstellen.
DataStore-Instanz erstellen
Sie müssen definieren, wie das DataStore-Objekt auf jeder Plattform instanziiert wird. Dies ist der einzige Teil der API, der aufgrund der Unterschiede bei den Dateisystem-APIs in den spezifischen Quellsätzen der Plattform enthalten sein muss.
Verbreitet
// 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" Android
Zum Erstellen der DataStore-Instanz unter Android benötigen Sie einen Context zusammen mit dem Pfad.
// shared/src/androidMain/kotlin/createDataStore.android.kt fun createDataStore(context: Context): DataStore<Preferences> = createDataStore( producePath = { context.filesDir.resolve(dataStoreFileName).absolutePath } ) iOS
Unter iOS können Sie den Pfad über NSDocumentDirectory abrufen:
// 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 (Desktop)
Wenn Sie die DataStore-Instanz in der JVM (Desktop) erstellen möchten, geben Sie einen Pfad mit Java- oder Kotlin-APIs an:
// shared/src/jvmMain/kotlin/createDataStore.desktop.kt fun createDataStore(): DataStore<Preferences> = createDataStore( producePath = { val file = File(System.getProperty("java.io.tmpdir"), dataStoreFileName) file.absolutePath } )