DataStore (Kotlin Multiplatform)

ספריית DataStore מאחסנת נתונים באופן אסינכרוני, עקבי ועסקאותי, ומאפשרת להתגבר על חלק מהחסרונות של SharedPreferences. בדף הזה נסביר איך יוצרים מאגר נתונים בפרויקטים של Kotlin Multiplatform‏ (KMP). למידע נוסף על DataStore, אפשר לעיין במסמכי העזרה הראשיים של DataStore ובדוגמאות הרשמיות.

הגדרת יחסי תלות

כדי להגדיר את DataStore בפרויקט KMP, מוסיפים את יחסי התלות של הארטיפקטים בקובץ build.gradle.kts של המודול:

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

הגדרת הכיתות של DataStore

אפשר להגדיר את הכיתה DataStore באמצעות DataStoreFactory בתוך המקור המשותף של מודול ה-KMP המשותף. הצבת הכיתות האלה במקורות משותפים מאפשרת לשתף אותן בכל פלטפורמות היעד. אפשר להשתמש בהצהרות actual ו-expect כדי ליצור הטמעות ספציפיות לפלטפורמה.

יצירת המכונה של DataStore

צריך להגדיר איך ליצור מופע של אובייקט DataStore בכל פלטפורמה. זהו החלק היחיד ב-API שצריך להופיע בקבוצות המקור הספציפיות של הפלטפורמה, בגלל ההבדלים בממשקי ה-API של מערכת הקבצים.

נפוץ

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

כדי ליצור את המכונה DataStore ב-Android, צריך להוסיף את Context לנתיב.

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

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

iOS

ב-iOS, אפשר לאחזר את הנתיב מה-NSDocumentDirectory:

// 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 (מחשב)

כדי ליצור את המכונה DataStore ב-JVM (במחשב), מציינים נתיב באמצעות ממשקי API של Java או Kotlin:

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

fun createDataStore(): DataStore<Preferences> = createDataStore(
    producePath = {
      val file = File(System.getProperty("java.io.tmpdir"), dataStoreFileName)
      file.absolutePath
    }
)