DataStore für KMP einrichten

Die DataStore-Bibliothek speichert Daten asynchron, konsistent und transaktional und überwindet 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ären Dokumentation für DataStore.

Abhängigkeiten einrichten

Wenn Sie DataStore in Ihrem KMP-Projekt einrichten möchten, fügen Sie die Abhängigkeiten für die Artefakte in der Datei build.gradle.kts für Ihr Modul hinzu:

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")
}

DataStore-Klassen definieren

Sie können die Klasse DataStore 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 freigegeben werden. Sie können actual- und expect-Deklarationen verwenden, um plattformspezifische Implementierungen zu erstellen.

DataStore-Instanz erstellen

Sie müssen festlegen, wie das DataStore-Objekt auf den einzelnen Plattformen instanziiert werden soll. Dies ist der einzige Teil der API, der aufgrund der Unterschiede bei den Dateisystem-APIs in den plattformspezifischen Source-Sets enthalten sein muss.

Allgemein

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

Zum Erstellen der DataStore-Instanz unter Android benötigen Sie einen Context und den Pfad.

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

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

iOS

Unter iOS können Sie den Pfad aus dem NSDocumentDirectory abrufen:

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

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

Wenn Sie die DataStore-Instanz im Web erstellen möchten, können Sie WebLocalStorage oder WebSessionStorage verwenden:

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

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

JVM (Desktop)

Wenn Sie die DataStore-Instanz auf 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(
    storage = FileStorage(
        serializer = PreferencesFileSerializer,
        produceFile = { File(System.getProperty("java.io.tmpdir"), dataStoreFileName) }
    )
)