DataStore

DataStore

מדריך למשתמש  Codelab

הפניית API
androidx.datastore

לאחסן נתונים באופן אסינכרוני, עקבי וטרנזקציונלי, וכך להתגבר על חלק מהחסרונות של SharedPreferences

העדכון האחרון	גרסה יציבה	גרסה מועמדת להפצה	גרסת בטא	גרסת אלפא
‫9 בספטמבר 2026	1.2.1	-	-	‎1.3.0-alpha11

הצהרה על יחסי תלות

כדי להוסיף תלות ב-DataStore, צריך להוסיף את מאגר Google Maven לפרויקט. מידע נוסף זמין במאמר בנושא מאגר Maven של Google.

‫DataStore מספק אפשרויות שונות לסריאליזציה, אפשר לבחור באחת מהן. אפשר גם להוסיף תלויות ללא Android לכל אחת מההטמעות.

אתם יכולים להוסיף את יחסי התלות של ההטמעה שאתם צריכים בקובץ build.gradle של האפליקציה או המודול:

‫DataStore להעדפות

מוסיפים את השורות הבאות לחלק של יחסי התלות בקובץ gradle:

Groovy

    dependencies {
        // Preferences DataStore (SharedPreferences like APIs)
        implementation "androidx.datastore:datastore-preferences:1.2.1"

        // Alternatively - without an Android dependency.
        implementation "androidx.datastore:datastore-preferences-core:1.2.1"
    }
    

Kotlin

    dependencies {
        // Preferences DataStore (SharedPreferences like APIs)
        implementation("androidx.datastore:datastore-preferences:1.2.1")

        // Alternatively - without an Android dependency.
        implementation("androidx.datastore:datastore-preferences-core:1.2.1")
    }
    

כדי להוסיף תמיכה אופציונלית ב-RxJava, מוסיפים את יחסי התלות הבאים:

Groovy

    dependencies {
        // optional - RxJava2 support
        implementation "androidx.datastore:datastore-preferences-rxjava2:1.2.1"

        // optional - RxJava3 support
        implementation "androidx.datastore:datastore-preferences-rxjava3:1.2.1"
    }
    

Kotlin

    dependencies {
        // optional - RxJava2 support
        implementation("androidx.datastore:datastore-preferences-rxjava2:1.2.1")

        // optional - RxJava3 support
        implementation("androidx.datastore:datastore-preferences-rxjava3:1.2.1")
    }
    

DataStore

מוסיפים את השורות הבאות לחלק של יחסי התלות בקובץ gradle:

Groovy

    dependencies {
        // Typed DataStore for custom data objects (for example, using Proto or JSON).
        implementation "androidx.datastore:datastore:1.2.1"

        // Alternatively - without an Android dependency.
        implementation "androidx.datastore:datastore-core:1.2.1"
    }
    

Kotlin

    dependencies {
        // Typed DataStore for custom data objects (for example, using Proto or JSON).
        implementation("androidx.datastore:datastore:1.2.1")

        // Alternatively - without an Android dependency.
        implementation("androidx.datastore:datastore-core:1.2.1")
    }
    

לתמיכה ב-RxJava, צריך להוסיף את יחסי התלות האופציונליים הבאים:

Groovy

    dependencies {
        // optional - RxJava2 support
        implementation "androidx.datastore:datastore-rxjava2:1.2.1"

        // optional - RxJava3 support
        implementation "androidx.datastore:datastore-rxjava3:1.2.1"
    }
    

Kotlin

    dependencies {
        // optional - RxJava2 support
        implementation("androidx.datastore:datastore-rxjava2:1.2.1")

        // optional - RxJava3 support
        implementation("androidx.datastore:datastore-rxjava3:1.2.1")
    }
    

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

סריאליזציה של JSON

כדי להשתמש בסריאליזציה של JSON, מוסיפים את מה שמופיע כאן למטה לקובץ Gradle:

Groovy

    plugins {
        id("org.jetbrains.kotlin.plugin.serialization") version "2.2.20"
    }

    dependencies {
        implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.9.0"
    }
    

Kotlin

    plugins {
        id("org.jetbrains.kotlin.plugin.serialization") version "2.2.20"
    }

    dependencies {
        implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.9.0")
    }
    

סריאליזציה של Protobuf

כדי להשתמש בסריאליזציה של Protobuf, מוסיפים את מה שמופיע כאן למטה לקובץ Gradle:

Groovy

    plugins {
        id("com.google.protobuf") version "0.9.5"
    }
    dependencies {
        implementation "com.google.protobuf:protobuf-kotlin-lite:4.32.1"

    }

    protobuf {
        protoc {
            artifact = "com.google.protobuf:protoc:4.32.1"
        }
        generateProtoTasks {
            all().forEach { task ->
                task.builtins {
                    create("java") {
                        option("lite")
                    }
                    create("kotlin")
                }
            }
        }
    }
    

Kotlin

    plugins {
        id("com.google.protobuf") version "0.9.5"
    }
    dependencies {
        implementation("com.google.protobuf:protobuf-kotlin-lite:4.32.1")
    }

    protobuf {
        protoc {
            artifact = "com.google.protobuf:protoc:4.32.1"
        }
        generateProtoTasks {
            all().forEach { task ->
                task.builtins {
                    create("java") {
                        option("lite")
                    }
                    create("kotlin")
                }
            }
        }
    }
    

משוב

המשוב שלכם עוזר לנו לשפר את Jetpack. נשמח לדעת אם גיליתם בעיות חדשות או אם יש לכם רעיונות איך לשפר את הספרייה הזו. כדאי לעיין בבעיות הידועות בספרייה הזו לפני שמדווחים על בעיה. כדי להוסיף הצבעה בדיווח על בעיה קיימת, לוחצים על כפתור הכוכב.

יצירת דיווח על בעיה חדשה

מידע נוסף זמין במאמרי העזרה בנושא Issue Tracker.

גרסה 1.3

גרסה ‎1.3.0-alpha11

‫9 בספטמבר 2026

‫androidx.datastore:datastore-*:1.3.0-alpha11 מופץ. גרסה ‎1.3.0-alpha11 מכילה את השמירות האלה.

תיקוני באגים

• נתיב הקובץ הבסיסי לא נכלל בהודעות CorruptionException שמוצגות במהלך כשלים בניתוח ההעדפות של DataStore. (Ia9e8f)

גרסה ‎1.3.0-alpha10

‫29 ביולי 2026

‫androidx.datastore:datastore-*:1.3.0-alpha10 מופץ. גרסה ‎1.3.0-alpha10 מכילה את השמירות האלה.

שינויים ב-API

• ‫GeneralSecurityException in AeadSerializer is now wrapped in CorruptionException for better CorruptionHandler integration. (I26e56, ‏ b/514941919)

גרסה ‎1.3.0-alpha09

‫6 במאי 2026

‫androidx.datastore:datastore-*:1.3.0-alpha09 מופץ. גרסה ‎1.3.0-alpha09 מכילה את השמירות האלה.

שינויים ב-API

• הופכים את ReThrowCorruptionHandler לגלוי לכולם. (I137bb, ‏ b/427722902)
• התאמת מחזור החיים של המעקב למעקב המערכת. (Ib391b)

גרסה ‎1.3.0-alpha08

‫22 באפריל 2026

‫androidx.datastore:datastore-*:1.3.0-alpha08 מופץ. גרסה ‎1.3.0-alpha08 מכילה את השמירות האלה.

תכונות חדשות

• הוספנו תמיכה במערכת קבצים פרטית של מקור (OPFS) ב-DataStore לפלטפורמות אינטרנט. ההטמעה הזו מציגה את WebOpfsStorage וכוללת תמיכה ארכיטקטונית בקלט/פלט אסינכרוני של קבצים, בהתראות בכרטיסיות שונות באמצעות BroadcastChannel API, ובנעילה מבוזרת באמצעות Web Locks API המקורי לגישת כתיבה בלעדית. Id7f5807 b/316376114

שינויים ב-API

• הוספנו את ממשקי ה-API ‏WebLocalStorage ו-WebSessionStorage לניהול מפורש של סוגי אחסון בסביבות אינטרנט. I35fa259b b/316376114

גרסה ‎1.3.0-alpha07

‫11 במרץ 2026

‫androidx.datastore:datastore-*:1.3.0-alpha07 מופץ. גרסה ‎1.3.0-alpha07 מכילה את השמירות האלה.

תכונות חדשות

• תמיכה בהצפנה: הוספנו את ארטיפקט androidx.datastore:datastore-tink החדש, שמאפשר להצפין את מאגר הנתונים באמצעות ספריית Tink. במודול הזה מוצג AeadSerializer, שהוא מחלקת wrapper חדשה שמטמיעה את Serializer<T> ומשתמשת בהצפנה מאומתת עם נתונים משויכים (AEAD) של Tink כדי להצפין ולפענח נתונים. אפשר להשתמש ב-AeadSerializer בפלטפורמות היעד JVM ו-Android.
• ‫DataStore Builder API חדש: השקנו את DataStore.Builder<T> כחלופה ניתנת להרחבה ל-DataStoreFactory. עם ה-API החדש הזה, המשתמשים יכולים לספק את הלוגיקה שלהם לגבי שיבוש נתונים באמצעות setCorruptionHandler. בנוסף, ב-API‏ Builder נדרש לאתחל DataStore באמצעות CoroutineContext במקום CoroutineScope. זה שיפור במקביליות מובנית, כי הוא מאפשר למבצעי הקריאה להגדיר את התנהגות הביצוע (כמו Dispatchers ספציפיים) בלי לחייב את DataStore לנהל בצורה לא מתאימה את מחזור החיים של ההיקף של מבצע הקריאה או להיות כפוף לו.

  הערה: מומלץ לכל המשתמשים לעבור מ-DataStoreFactory ל-API החדש של DataStore.Builder. הדרישה לשימוש ב-CoroutineContext במקום ב-CoroutineScope מאפשרת ל-API לאכוף בו-זמניות (concurrency) מובנית יותר. כך מוודאים שפעולות DataStore לא קשורות למחזורי חיים קצרים של ממשקי משתמש (לדוגמה, viewModelScope), ומונעים ביטול מוקדם ואובדן נתונים פוטנציאלי.

  אזהרה: חשוב לוודא של-CoroutineContext שסיפקתם לכלי הפיתוח יש Job, ושהוא מוגבל לאפליקציה. אם ההקשר יבוטל, הפעולות הפנימיות של DataStore יסתיימו לפני הזמן.

שינויים ב-API

• הוספנו את ארטיפקט androidx.datastore:datastore-tink החדש לתמיכה בהצפנה של DataStore. ‫(Ic106d, ‏ b/167697691)

  כדי להצפין נתונים באמצעות Tink, פועלים לפי השלבים הבאים:

  1. יוצרים מפתח באמצעות ממשקי API של Tink:

     val keysetHandle =
         AndroidKeysetManager.Builder()
             .withSharedPref(applicationContext, "keyset", "keyset_prefs")
             .withKeyTemplate(KeyTemplate.createFrom(PredefinedAeadParameters.AES256_GCM))
             .withMasterKeyUri("android-keystore://master_key")
             .build()
             .keysetHandle
     

  2. יוצרים AeadSerializer שעוטף סריאליזציה קיימת:

     val aeadSerializer = AeadSerializer(
         // Use tink APIs to create an Aead object to encrypt/decrypt data.
         aead =
             keysetHandle.getPrimitive(
                 RegistryConfiguration.get(),
                 Aead::class.java,
             ),
         // AeadSerializer can wrap an existing serializer.
         wrappedSerializer = ExistingSerializer,
         // Specify a unique name to prevent a ciphertext swapping attack.
         associatedData = "settings.json".encodeToByteArray(),
     )
     

  3. משתמשים ב-aeadSerializer במקום בסריאליזציה כשיוצרים את מופע מאגר הנתונים:

     val dataStore = dataStore(
         fileName = "settings.json",
         serializer = aeadSerializer,
         scope = scope,
     )
     

• השקנו את DataStore.Builder<T> כחלופה מודרנית וניתנת להרחבה ל-DataStoreFactory. (I3b110, ‏ b/267785821, ‏ b/400507108, ‏ b/368385681, ‏ b/427722902, ‏ b/370838564, ‏ b/167697691)

גרסה ‎1.3.0-alpha06

‫25 בפברואר 2026

‫androidx.datastore:datastore-*:1.3.0-alpha06 מופץ. גרסה ‎1.3.0-alpha06 מכילה את השמירות האלה.

תכונות חדשות

• ‫DataStore תומך עכשיו ב-androidx.tracing בפלטפורמת היעד Android. אפשר ליצור DataStore עם מעקב על ידי העברת מופע androidx.tracing.Tracer לפונקציה DataStoreFactory.createWithTracing(). ‫(I71bc2, ‏ b/427722902)

גרסה ‎1.3.0-alpha05

‫28 בינואר 2026

‫androidx.datastore:datastore-*:1.3.0-alpha05 מופץ. גרסה ‎1.3.0-alpha05 מכילה את השמירות האלה.

תכונות חדשות

• פרופילים של Baseline נוספו למאגר הנתונים. (3916245,b/469127532).
• הטמעת תמיכה ב-WASM/JS ב-DataStore באמצעות localStorage. כך נוצר יתרון מובהק על פני ההטמעה הקיימת של sessionStorage, כי אפשר לקבל התראות על אירועים ולסנכרן אותם בין כרטיסיות. (I67246, ‏ b/441511612)

גרסה ‎1.3.0-alpha04

‫14 בינואר 2026

‫androidx.datastore:datastore-*:1.3.0-alpha04 מופץ. גרסה ‎1.3.0-alpha04 מכילה את השמירות האלה.

שינויים ב-API

• נוספה פונקציית העתקה של כלי שירות שאפשר להשתמש בה כדי לעדכן נתונים של העדפות DataStore. (I70a18, ‏ b/467120382)

תיקוני באגים

• נפתרה בעיה שבה נתונים בינאריים יכלו להיות פגומים במהלך האחסון. כדי לפתור את הבעיה, הטיפול במחרוזות UTF-8 הוחלף בקידוד Base64 לאינטרנט. (Ie3178, b/473790107)

גרסה ‎1.3.0-alpha03

‫17 בדצמבר 2025

‫androidx.datastore:datastore-*:1.3.0-alpha03 מופץ. גרסה ‎1.3.0-alpha03 מכילה את השמירות האלה.

תיקוני באגים

• תוקנה בעיה שגורמת לכשל בשינוי השם של קובץ מאגר נתונים זמני. (I94f89, b/203087070)
• תוקנה בעיה שגרמה להפסקת עדכונים במהלך קריאה/כתיבה בו-זמנית. יכול להיות שיתרחש מרוץ תהליכים בין מאסף חדש ב-DataStore.data לבין קריאה מקבילה ל-updateData, ולכן המאסף לא יקבל את הערך החדש. ‫(I6a427, ‏ b/431787506)

גרסה ‎1.3.0-alpha02

‫3 בדצמבר 2025

‫androidx.datastore:datastore-*:1.3.0-alpha02 מופץ. גרסה ‎1.3.0-alpha02 מכילה את השמירות האלה.

תיקוני באגים

• מוסיפים את היעד js() אל androidx.datastore. (I1f62b, ‏ b/441511612)
• אכיפת סדר FIFO בעדכונים של GuavaDataStore. (I6fd00,b/451491257)

גרסה ‎1.3.0-alpha01

‫19 בנובמבר 2025

‫androidx.datastore:datastore-*:1.3.0-alpha01 מופץ. גרסה ‎1.3.0-alpha01 מכילה את השמירות האלה.

תכונות חדשות

• הוספנו תמיכה ב-KMP Web בגרסה DataStore באמצעות sessionStorage API. התכונה הזו מאפשרת ל-DataStore לשמור נתונים באופן זמני בתוך כרטיסייה אחת בדפדפן. ‫(I60fad, ‏ b/316376114)

גרסה 1.2

גרסה 1.2.1

‫11 במרץ 2026

‫androidx.datastore:datastore-*:1.2.1 מופץ. גרסה 1.2.1 מכילה את השמירות האלה.

ללא שינוי

• בגרסה הזו יש תיקוני באגים קלים בתשתית, והיא לא כוללת שינויים ב-DataStore API או בהתנהגות שלו מגרסה 1.2.0.

גרסה 1.2.0

‫19 בנובמבר 2025

‫androidx.datastore:datastore-*:1.2.0 מופץ. גרסה 1.2.0 מכילה את השמירות האלה.

שינויים משמעותיים מאז גרסה 1.1.0

תמיכה ב-Java/Guava:

• המודול החדש datastore-guava נוסף כדי לחשוף ממשקי API שמתאימים למשתמשי Java ו-Guava ListenableFuture דרך GuavaDataStore.
• הוספנו תמיכה בריבוי תהליכים ב-GuavaDataStore.
• נוספה פונקציית עומס יתר (overload) ל-GuavaDataStore.from שמקבלת Java Executor (במקום CoroutineContext) ומשתמשת ב-androidx.core.util.Function.

תמיכה בהפעלה ישירה:

• יש עכשיו תמיכה בשימוש ב-DataStore במהלך מצב Direct Boot. ממשקי API חדשים כמו createInDeviceProtectedStorage() ב-DataStoreFactory ו-deviceProtectedDataStore() ב-DataStoreDelegate מאפשרים ליצור את מאגר הנתונים באחסון המוגן של המכשיר.

שינויים ב-API ובאחסון:

• נוסף PreferencesFileSerializer שמטמיע את androidx.datastore.core.Serializer לשימוש עם FileStorage.
• הגדרת בנאי ברירת המחדל של ReplaceFileCorruptionHandler לשימוש נפוץ בקוד.

תיקוני באגים:

• תוקנה הבעיה שקשורה ל-java.lang.UnsatisfiedLinkError כשמשתמשים ב-DataStore באפליקציה שעברה אופטימיזציה באמצעות R8 אבל לא נעשה בה שימוש בקובץ ProGuard רגיל.
• נפתרה בעיה שבה פעולות של GuavaDataStore יכלו לפעול באופן שגוי ב-thread שקורא (למשל, ה-thread הראשי) במקום ב-IO dispatcher שצוין.
• נפתרה בעיה ב-FileNotFoundException ב-OkioStorage בהפעלה על ידי הוספת ניסיון שני לקריאת נתונים במקרה של תנאי מירוץ.

גרסה ‎1.2.0-rc01

‫5 בנובמבר 2025

‫androidx.datastore:datastore-*:1.2.0-rc01 מופץ. גרסה ‎1.2.0-rc01 מכילה את השמירות האלה.

גרסה ‎1.2.0-beta01

‫22 באוקטובר 2025

‫androidx.datastore:datastore-*:1.2.0-beta01 מופץ. גרסה ‎1.2.0-beta01 מכילה את השמירות האלה.

שינויים ב-API

• הופכים את CorruptionHandler לגלוי לכולם. (I9ac35, b/452406457)
• שימוש בחשבון androidx.core.util.Function ב-GuavaDataStore. (I71eae, ‏ b/448563999)
• מוסיפים עומס יתר ל-GuavaDataStore.from שמקבל Executor במקום CoroutineContext. (I989fa, ‏ b/448563183)

תיקוני באגים

• תיקון java.lang.UnsatisfiedLinkError כשמשתמשים ב-DataStore באפליקציה שעברה אופטימיזציה באמצעות R8, אבל לא משתמשים ב-getDefaultProguardFile('android-proguard-optimize.txt'). (I27d0d, b/434696293)
• נפתרה בעיה שבה פעולות של GuavaDataStore יכלו לפעול באופן שגוי ב-thread שקורא (למשל, ה-thread הראשי) במקום ב-dispatcher של קלט/פלט שצוין. (Ic91ea,b/441801112)

גרסה ‎1.2.0-alpha02

‫7 במאי 2025

‫androidx.datastore:datastore-*:1.2.0-alpha02 מופץ. גרסה ‎1.2.0-alpha02 מכילה את השמירות האלה.

שינויים ב-API

• הוספנו תמיכה בריבוי תהליכים ב-GuavaDataStore. (e0d608a).
• נוספה שיטת עזר ליצירת GuavaDataStore מ-DataStore. (9af26f4)
• כדי להשתמש בפרויקטים שפורסמו עם Kotlin 2.0, צריך KGP בגרסה 2.0.0 ומעלה. (Idb6b5)
• מחליפים את העומס העודף הקיים datastore בשיטת נציג כדי לאתחל DataStore לשימוש במהלך אתחול ישיר. (If71b9)

גרסה ‎1.2.0-alpha01

‫26 במרץ 2025

‫androidx.datastore:datastore-*:1.2.0-alpha01 מופץ. גרסה ‎1.2.0-alpha01 מכילה את השמירות האלה.

תכונות חדשות

• נוסף מודול datastore-guava כדי לחשוף ממשקי API שמתאימים למשתמשי Java ו-Guava ListenableFuture דרך GuavaDataStore. (Iadd5e0)
• יש עכשיו תמיכה בשימוש ב-DataStore במהלך מצב DirectBoot. כדי ליצור מאגר נתונים לשימוש במצב Direct Boot, צריך ליצור אותו באחסון Device Protected. אפשר לעשות זאת באמצעות ממשקי ה-API החדשים של DataStore: ‏ createInDeviceProtectedStorage() ב-DataStoreFactory ו-deviceProtectedDataStore() ב-DataStoreDelegate. (Ib90e56)

שינויים ב-API

• נוסף PreferencesFileSerializer שמטמיע את הממשק androidx.datastore.core.Serializer לשימוש עם FileStorage. (I4c71f3)

תיקוני באגים

• נפתרה בעיה מספר FileNotFoundException ב-OkioStorage בהפעלה על ידי הוספת ניסיון שני לקריאת נתונים במקרה של תנאי מירוץ. (I43b3fb, ‏ b/337870543)
• הגדרת בנאי ברירת המחדל עבור ReplaceFileCorruptionHandler לשימוש נפוץ בקוד. (I795b05, b/358138957)

גרסה 1.1

גרסה 1.1.7

‫20 במאי 2025

‫androidx.datastore:datastore-*:1.1.7 מופץ. גרסה 1.1.7 מכילה את השמירות האלה.

תיקוני באגים

• תוקנה בעיה של כללי Proguard חסרים בארטיפקט Android של datastore-preferences-core. (3f3f6e, b/413078297)

גרסה 1.1.6

‫7 במאי 2025

‫androidx.datastore:datastore-*:1.1.6 מופץ. גרסה 1.1.6 מכילה את השמירות האלה.

תיקוני באגים

• נפתרה בעיה שגרמה לשבירה של מטא-נתונים של Gradle בגרסה 1.1.5. הבעיה הזו נגרמה באג ב-DSL של הפלאגין החדש AGP KMP, שמונע הכללה אוטומטית של מטא-נתונים לכל פלטפורמות היעד. הבאג גורם לכך שחלק מהשיטות של DataStore Android לא מוצגות יותר בגרסאות של לקוחות. התיקון כולל שימוש ב-DSL הישן יותר android ב-build.gradle במקום ב-androidLibrary. (7801abf)

גרסה 1.1.5

‫23 באפריל 2025

‫androidx.datastore:datastore-*:1.1.5 מופץ. גרסה 1.1.5 מכילה את השמירות האלה.

תיקוני באגים

• כדי לצמצם את הבעיות שקשורות ל-CorruptionException ב-PreferencesDataStore, האחסון שמוגדר כברירת מחדל שונה מ-OkioStorage ל-FileStorage. השינוי הזה בוצע באמצעות הוספה של PreferencesFileSerializer. b/346197747

גרסה 1.1.4

‫26 במרץ 2025

‫androidx.datastore:datastore-*:1.1.4 מופץ. גרסה 1.1.4 מכילה את השמירות האלה.

תיקוני באגים

• כדי לשפר את האמינות, כדאי להחליף את האחסון שמוגדר כברירת מחדל מ-OkioStorage ל-FileStorage כדי לצמצם את CorruptionException. (I71181, ‏ b/346197747)

גרסה 1.1.3

‫26 בפברואר 2025

‫androidx.datastore:datastore-*:1.1.3 מופץ. גרסה 1.1.3 מכילה את השמירות האלה.

תיקוני באגים

• נפתרה בעיה ב-FileNotFoundException ב-OkioStorage שקרתה בהפעלת האפליקציה. אם ניסיון הקריאה הראשוני של הקובץ לא מצליח, יתבצע ניסיון שני למקרה שהתרחש מצב מירוץ בגלל שהקובץ נוצר על ידי תהליך אחר במהלך הקריאה הראשונית. (I43b3f, ‏ b/337870543)

גרסה 1.1.2

‫15 בינואר 2025

‫androidx.datastore:datastore-*:1.1.2 מופץ. גרסה 1.1.2 מכילה את השמירות האלה.

תיקוני באגים

• שיפור של פי 8 בזמן האחזור של קריאה חמה (DataStore.data.first()). (22b8a40)
• אפשר ליצור את ReplaceFileCorruptionHandler מקוד משותף של KMP. (7632e839)

גרסה 1.1.1

‫1 במאי 2024

‫androidx.datastore:datastore-*:1.1.1 מופץ. גרסה 1.1.1 מכילה את השמירות האלה.

תיקוני באגים

• בוצעה הפחתה של אזעקת שווא ב-Linux לגבי השגיאה 'יקרה חסימת משאבים' במקרה קיצוני שבו כמה מופעים של DataStore מנסים לכתוב מתוך תהליכים שונים על ידי ביטול נעילת הקובץ.

גרסה 1.1.0

‫17 באפריל 2024

‫androidx.datastore:datastore-*:1.1.0 מופץ. גרסה 1.1.0 מכילה את השמירות האלה.

שינויים משמעותיים מאז גרסה 1.0.0

למידע נוסף, כדאי לעיין בהערות המוצר מגרסאות אלפא ובטא של 1.1.0. הנה כמה מהעדכונים העיקריים בגרסה 1.1.0:

• ‫DataStore תומך עכשיו בכמה תהליכים שפועלים בו-זמנית על אותו קובץ, עם תמיכה בפיקוח על התהליכים.
• ממשק האחסון החדש מאפשר לכם להתאים אישית את האופן שבו מודלים של נתונים מאוחסנים או עוברים סריאליזציה.
• מעכשיו אפשר להשתמש ב-DataStore בפרויקטים של Kotlin Multiplatform.

גרסה ‎1.1.0-rc01

‫3 באפריל 2024

‫androidx.datastore:datastore-*:1.1.0-rc01 מופץ. גרסה ‎1.1.0-rc01 מכילה את השמירות האלה.

תיקוני באגים

• תוקן מצב של ירידה בביצועים שבו קריאות של updateData לא עברו אופטימיזציה בכתיבה לדיסק אם הנתונים החדשים זהים לנתונים הישנים (d64cfb5)
• תוקנה בעיית מרוץ תהליכים שבה יכול להיות ש-MultiProcess DataStore לא יקבל ביטולים במהלך האתחול. ‪((b/326141553),(094c2dd))

גרסה ‎1.1.0-beta02

6 במרץ 2024

‫androidx.datastore:datastore-*:1.1.0-beta02 מופץ. גרסה ‎1.1.0-beta02 מכילה את השמירות האלה.

תיקוני באגים

• התכונה 'שיפור הביצועים' ב-DataStore אוספת רק התראות על עדכונים כשהיא מזהה אותם. (b/267792241)
  • שימו לב שהשינוי הזה עשוי להפעיל UncompletedCoroutinesError בבדיקות שלכם אם אתם משתמשים בספריית הבדיקות של Coroutines. כדי להימנע מהבעיה הזו, חשוב לוודא שמעבירים את TestScope.backgroundScope כשמפעילים את DataStore בבדיקות.
• ​תוקנה הבעיה שגרמה לקיפאון של קריאות מקוננות של updateData באותו מופע. (b/241760537)
• הפסקנו את ההצגה של DataStoreIOExceptions אם המחיקה של SharedPreferences נכשלת במהלך ההעברה. (b/195553816)
• תוקנה הבעיה שגרמה לכך ששינוי שם הקובץ נכשל במהלך updateData בסביבות JVM שאינן Android. (b/203087070)
• תוקנה הבעיה שבה CorruptionException לא מטופל אחרי האתחול של DataStore. (b/289582516)

גרסה ‎1.1.0-beta01

‫10 בינואר 2024

הגרסה androidx.datastore:datastore-*:1.1.0-beta01 הושקה ללא שינויים מאז 1.1.0-alpha07. גרסה ‎1.1.0-beta01 מכילה את השמירות האלה.

גרסה ‎1.1.0-alpha07

‫29 בנובמבר 2023

‫androidx.datastore:datastore-*:1.1.0-alpha07 מופץ. גרסה ‎1.1.0-alpha07 מכילה את השמירות האלה.

שינויים ב-API

• השיטות MultiProcessDataStoreFactory כבר לא ניסיוניות.ההערה @ExperimentalMultiProcessDataStore הוסרה לחלוטין. (Ieee54, ‏ I8e607)

תיקוני באגים

• השקת ההסרה של הערות @ExperimentalMultiProcessDataStore בגרסה 1.1.0-alpha07. (I8e607)

גרסה ‎1.1.0-alpha06

1 בנובמבר 2023

‫androidx.datastore:datastore-*:1.1.0-alpha06 מופץ. גרסה ‎1.1.0-alpha06 מכילה את השמירות האלה.

שינויים ב-API

• ה-factory method‏ createSingleProcessCoordinator מקבלת עכשיו נתיב קובץ (String, ‏ java.io.File ו-okio.Path) כדי להיות עקבית עם createMultiProcessCoordinator. (I211c8, b/305755935)

גרסה ‎1.1.0-alpha05

‫6 בספטמבר 2023

‫androidx.datastore:datastore-*:1.1.0-alpha05 מופץ. גרסה ‎1.1.0-alpha05 מכילה את השמירות האלה.

שינויים ב-API

• ‫Datastore FileStorage זמין עכשיו לציבור, כך שלקוחות יכולים לספק פרמטרים בהתאמה אישית. (Icb985)
• השתנה ה-constructor של OkioStorage כך שיקבל InterProcessCoordinator כדי שאפשר יהיה להשתמש בו ב-Android עם MultiProcessCoordinator. (Iecea3)

תיקוני באגים

• פתרון בעיות שקשורות לMultiProcessCoordinator אי אפשר לעקוב אחרי כמה קבצים באותה תיקייה.
• תוקנה בעיה שבה לא הייתה אפשרות לזהות קבצים כפולים אם נתיבי הקבצים לא היו מנורמלים.
• תיקון ערכים שגויים שמוחזרים מ-RxDataStore#isDisposed.
• תיקון הגדרת ProGuard חסרה עבור ארטיפקט datstore-preferences-core.

גרסה ‎1.1.0-alpha04

‫5 באפריל 2023

‫androidx.datastore:datastore-*:1.1.0-alpha04 מופץ. גרסה ‎1.1.0-alpha04 מכילה את השמירות האלה.

תיקוני באגים

• לשפר את ההטמעה הפנימית כדי למנוע מצב של מרוץ תהליכים שבו יכול להיות שזרימת הנתונים של DataStore תפלוט ערך ישן יותר אחרי עדכון.

גרסה ‎1.1.0-alpha03

‫24 במרץ 2023

‫androidx.datastore:datastore-*:1.1.0-alpha03 מופץ.

תיקוני באגים

• הוסרו אילוצי תלות מפריטי Maven כדי לעקוף בעיה ב-build ביעדי Kotlin Native ‏ (b/274786186, ‏ KT-57531).

גרסה ‎1.1.0-alpha02

‫22 במרץ 2023

‫androidx.datastore:datastore-*:1.1.0-alpha02 מופץ. גרסה ‎1.1.0-alpha02 מכילה את השמירות האלה.

הערה

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

תכונות חדשות

• מעכשיו אפשר להשתמש ב-DataStore בפרויקטים של KMM. שימו לב: יעדים שאינם Android של DataStore עדיין נמצאים בשלב הניסוי, אבל החלטנו למזג גרסאות כדי להקל על מפתחים לנסות אותם.
• תכונות של ריבוי תהליכים הועברו מ-androidx.datastore.multiprocess ל-androidx.datastore.core.
• מוסיפים שיטת יצירה חדשה ב-androidx.datastore.core.MultiProcessDataStoreFactory כדי ליצור מופעים של DataStore עם אובייקטים של Storage לפעולות על קבצים.
• הוספנו ממשק חדש InterProcessCoordinator שעוזר לכמה מופעים של DataStore לתקשר בין תהליכים. הערה: הטמעה של InterProcessCoordinator עם ריבוי תהליכים זמינה רק ב-Android.

שינויים ב-API

• הוספת InterProcessCoordinator אל StorageConnection בממשק datastore-core ‏ (I555bb)
• שינוי ממשקי API ב-datastore-core MultiProcessDataStoreFactory כדי להשתמש באחסון. (Iac02f)
• העברה של ממשקי API ציבוריים מ-datastore-multiprocess אל datastore-core ‏ (I76d7c)
• ‫Exposed PreferencesSerializer מ-datastore-preferences-core ‏ (I4b788)
• הוספת הערה @JvmDefaultWithCompatibility ‏ (I8f206)

גרסה ‎1.1.0-alpha01

9 בנובמבר 2022

‫androidx.datastore:datastore-*:1.1.0-alpha01 מופץ. גרסה ‎1.1.0-alpha01 מכילה את השמירות האלה.

תכונות חדשות

• תמיכה בתרחישי שימוש מרובי-תהליכים שבהם מובטחת עקביות הנתונים בין DataStore מופעים בתהליכים. מוסיפים MultiProcessDataStoreFactory#create כדי ליצור מקרים של DataStore.
• ממשק אחסון חדש שמאפשר להחליף את מנגנון האחסון הבסיסי של Datastore. יש יישומים ל-java.io ול-okio. למפעלים של DataStore יש שיטות חדשות שמקבלות את אובייקט האחסון הזה.

שינויים ב-API

• שינוי ממשקי API ב-datastore-core MultiProcessDataStoreFactory כדי להשתמש באחסון. (Iac02f)
• העברה של ממשקי API ציבוריים מ-datastore-multiprocess אל datastore-core ‏ (I76d7c)
• ‫Exposed PreferencesSerializer מ-datastore-preferences-core ‏ (I4b788)

גרסה 1.0.0

גרסה 1.0.0

4 באוגוסט 2021

‫androidx.datastore:datastore-*:1.0.0 מופץ. גרסה 1.0.0 מכילה את השמירות האלה.

התכונות העיקריות בגרסה 1.0.0

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

גרסה ‎1.0.0-rc02

21 ביולי 2021

‫androidx.datastore:datastore-*:1.0.0-rc02 מופץ. גרסה ‎1.0.0-rc02 מכילה את השמירות האלה.

תיקוני באגים

• הבהרה: הפונקציה SharedPreferencesMigration לא מופעלת אם אין מפתחות. (Icfa32, ‏ b/192824325)
• תוקן באג שבו הפונקציה SharedPreferencesMigration שנבנתה באמצעות MIGRATE_ALL_KEYS הייתה יוצרת חריגה אם המפתח המבוקש עדיין לא קיים. (Ie318a, b/192824325)

גרסה ‎1.0.0-rc01

‫30 ביוני 2021

‫androidx.datastore:datastore-*:1.0.0-rc01 מופץ. גרסה ‎1.0.0-rc01 מכילה את השמירות האלה.

תיקוני באגים

• תוקן באג שבו קובץ ‎ .java נוסף בטעות לקובץ ה-JAR הסופי (I65d96, ‏ b/188985637)

גרסה ‎1.0.0-beta02

‫16 ביוני 2021

‫androidx.datastore:datastore-*:1.0.0-beta02 מופץ. גרסה ‎1.0.0-beta02 מכילה את השמירות האלה.

תיקוני באגים

• תיקון ClassVerificationFailure (b/187450483)

גרסה ‎1.0.0-beta01

21 באפריל 2021

‫androidx.datastore:datastore-*:1.0.0-beta01 מופץ. גרסה ‎1.0.0-beta01 מכילה את השמירות האלה.

שינויים ב-API

• הסרת עומסי JVM לשיטות kotlin בלבד (I2adc7)

תיקוני באגים

• תוקן באג שבו נציגי Datastore יכלו לגרום לדליפת הקשרים (Ie96fc, b/184415662)

גרסה ‎1.0.0-alpha08

10 במרץ 2021

‫androidx.datastore:datastore-*:1.0.0-alpha08 מופץ. גרסה ‎1.0.0-alpha08 מכילה את השמירות האלה.

שינויים ב-API

• עכשיו אפשר להוסיף העברה שתלויה בהקשר לנציג הנכס dataStore ו-preferencesDataStore. (I4ef69, b/173726702)
• נוספו פונקציות עזר לקבלת שם הקובץ אם כבר לא משתמשים בנציג datastore או ב-context.createDataStore (I60f9a)
• הפונקציות Serializer writeTo ו-readFrom מושעות עכשיו. אם הטמעתם Serializer, תצטרכו לעדכן את הפונקציות שלכם לפונקציות השהיה. (I1e58e)
• נוספו נציגי נכסים למשתמשי RxDataStore. (Ied768, ‏ b/173726702)

תיקוני באגים

• החלת הגבלות על שימוש ציבורי בממשקי API ניסיוניים (I6aa29, ‏ b/174531520)

גרסה ‎1.0.0-alpha07

24 בפברואר 2021

‫androidx.datastore:datastore-*:1.0.0-alpha07 מופץ. גרסה ‎1.0.0-alpha07 מכילה את השמירות האלה.

שינויים ב-API

• הפונקציה של התוסף Context.createDataStore הוסרה והוחלפה בנציג המאפיין globalDataStore. קוראים ל-globalDataStore פעם אחת ברמה העליונה בקובץ Kotlin. לדוגמה:

  val Context.myDataStore by dataStore(...)
  

  ממקמים את הקוד הזה ברמה העליונה של קובץ Kotlin כדי שתהיה רק מופע אחד שלו. ‫(I57215, ‏ b/173726702)

• הפונקציות של RxDataStore נמצאות עכשיו במחלקה RxDataStore במקום בפונקציות הרחבה ב-DataStore. (Idccdb, ‏ b/177691248)

• אם אתם רוצים להעביר את EncryptedSharedPreferences (או את direct boot SharedPreferences) אל DataStore, עכשיו אתם יכולים לעשות זאת באמצעות הבונה החדש SharedPreferencesMigration, שמאפשר לכם להוסיף את SharedPreferences. ‫(I8e04e, b/177278510)

תיקוני באגים

• מעכשיו, אם יש כמה DataStore פעילים לאותו קובץ, תופעל חריגה ב-DataStore. אם לא ניהלתם את DataStore כ-Singleton או לא וידאתם שאין שני מקרים של DataStore שפעילים בו-זמנית עבור קובץ, יכול להיות שיוצגו לכם עכשיו חריגים כשקוראים או כותבים ב-DataStore. כדי לפתור את הבעיות האלה, צריך לנהל את DataStore כ-Singleton. (Ib43f4, ‏ b/177691248)
• תוקן אופן הפעולה של הביטול כשמבטלים את היקף המתקשר. (I2c7b3)

גרסה ‎1.0.0-alpha06

‫13 בינואר 2021

‫androidx.datastore:datastore-*:1.0.0-alpha06 מופץ. גרסה ‎1.0.0-alpha06 מכילה את השמירות האלה.

תכונות חדשות

• נוספו עטיפות RxJava ל-DataStore. ‫datastore-rxjava2/3 artifacts מכילים את העטיפות של ממשקי הליבה של DataStore ‏ (RxDataStore, ‏RxDataStoreBuilder ו-RxDataMigration). ‫datastore-preferences-rxjava2/3 artifacts מכילים כלי ליצירת Preferences DataStore.

שינויים ב-API

• הסתרת הממשק CorruptionHandler. לא הייתה סיבה שהיא תהיה גלויה לכולם כי מפעל DataStore מקבל רק ReplaceFileCorruptionHandler. ‫(I0b3b3, b/176032264)
• השיטה preferencesKey<T>(name: String): Key<T> הוסרה והוחלפה בשיטות שספציפיות לכל סוג נתמך. לדוגמה, preferencesKey<Int>("int") הוא עכשיו intPreferencesKey("int") (Ibcfac, b/170311106)

תיקוני באגים

• תוקן מסמך בנושא DataStoreFactory, שבו לא צוין שקובץ מאגר הנתונים נוצר בספריית המשנה datastore/. (Ica222)

גרסה ‎1.0.0-alpha05

‫2 בדצמבר 2020

‫androidx.datastore:datastore-*:1.0.0-alpha05 מופץ. גרסה ‎1.0.0-alpha05 מכילה את השמירות האלה.

תיקוני באגים

• הוספת תיעוד טוב יותר וחריגים לגבי כתיבות בו-זמניות ממאגרי נתונים. (Ia98a2, ‏ b/173522155, ‏ b/173726702)
• מעכשיו אפשר (אבל לא חובה) לסגור את OutputStream שמועבר אל Serializer.writeTo(). (I5c9bf, ‏ b/173037611)

גרסה ‎1.0.0-alpha04

17 בנובמבר, 2020

‫androidx.datastore:datastore-*:1.0.0-alpha04 מופץ. גרסה ‎1.0.0-alpha04 מכילה את השמירות האלה.

תיקוני באגים

• תוקנה בעיה באריזה שגרמה לקריסה הבאה ב-Preference Datastore 1.0.0-alpha03: java.lang.NoClassDefFoundError: Failed resolution of: Landroidx/datastore/preferences
  • הדיווח המקורי על הקריסה: b/173036843
  • (I4712d, ‏ b/173036843)

גרסה ‎1.0.0-alpha03

11 בנובמבר 2020

‫androidx.datastore:datastore-*:1.0.0-alpha03 מופץ. גרסה ‎1.0.0-alpha03 מכילה את השמירות האלה.

חשוב לשים לב: במקום זאת, צריך להשתמש בגרסה 1.0.0-alpha04. נמצאה בעיה קריטית ב-1.0.0-alpha03 שגורמת לקריסה של Preference Datastore עם java.lang.NoClassDefFoundError. (b/173036843)

תכונות חדשות

• העדפות תומכות עכשיו בערכים מסוג double (שימושי אם נדרשת רמת דיוק גבוהה יותר מזו של ערכים מסוג float) (I5be8f, ‏ b/169471808)

שינויים ב-API

• נוצרה תלות ב-Kotlin טהור עבור Datastore כדי לאפשר קומפילציה מהירה יותר. ‫androidx.datastore:datastore-core מכיל את ממשקי ה-API הבסיסיים של Kotlin בלבד, ו-androidx.datastore:datastore מכיל את ממשקי ה-API שתלויים ב-Android (כולל SharedPreferencesMigration ובונה Context.createDataStore). (I42d75,‏ b/168512698)
• פיצול היעדים של מאגר נתוני ההעדפות כדי להאיץ את הקומפילציה של Kotlin (Ia3c19)

• עכשיו צריך להוסיף למחלקות הסריאליזציה מאפיין חדש של ערך ברירת המחדל שישמש אם אין נתונים בדיסק. כך קל יותר להטמיע סריאליזציה בהתאמה אישית, כדי שהמשתמשים לא יצטרכו לטפל במקרים מיוחדים של זרמי קלט ריקים (אי אפשר לנתח זרמי קלט ריקים באמצעות JSON).

  • בנוסף, נוספה בדיקה כדי לוודא שזרם הפלט שסופק ל-writeTo() לא סגור, ואם הוא סגור, מוצגים חריגים (I16e29)

• הגדרת ה-constructor של SharedPreferencesView כפנימי. הוא היה ציבורי במקור כדי לאפשר בדיקה. במקום זאת, הבדיקות צריכות ליצור SharedPreferencesMigration ולבדוק את הפעולה שלו. (I93891)

תיקוני באגים

• הפרמטר produceFile ב-DataStoreFactory וב-PreferenceDataStoreFactory הוא עכשיו הפרמטר האחרון ברשימה, כך שאפשר להשתמש בתחביר של lambda מסוג kotlin trailing. ‫(Ibe7f1, ‏ b/169425442)
• בהתאם לדרישות החדשות והמפורשות של ה-API ל-Kotlin‏ (I5ae1e)

בעיות מוכרות

• ‫Preference Datastore קורס עם java.lang.NoClassDefFoundError. (b/173036843)

גרסה ‎1.0.0-alpha02

‫14 באוקטובר 2020

‫androidx.datastore:datastore-core:1.0.0-alpha02 וגם androidx.datastore:datastore-preferences:1.0.0-alpha02 מופצים. גרסה ‎1.0.0-alpha02 מכילה את השמירות האלה.

תיקוני באגים

• נוסף אמצעי הגנה מפני מוטציה ב-datastore-core. שינוי שגורם לבעיות בשימוש ב-Datastore אצל אנשים שמשתמשים ב-Datastore עם סוגים שאינם פרוטו/העדפות (I6aa84)
• הוספנו שיטה toString ל-Preferences.kt כדי להקל על ניפוי הבאגים של המצב הנוכחי (I96006)
• הוספנו חריג כדי להגן מפני שימוש לרעה ב-DataStore.Preferences (I1134d)
• תוקן באג שגרם לקריסת האפליקציה בהפעלה (I69237, ‏ b/168580258)

גרסה ‎1.0.0-alpha01

‫2 בספטמבר 2020

‫androidx.datastore:datastore-core:1.0.0-alpha01 וגם androidx.datastore:datastore-preferences:1.0.0-alpha01 מופצים. גרסה 1.0.0-alpha01 מכילה את השמירות האלה.

תכונות חדשות

‫Jetpack DataStore הוא פתרון חדש ומשופר לאחסון נתונים, שמיועד להחליף את SharedPreferences. המאגר מבוסס על שגרות המשך ו-Flow של Kotlin, ומספק שתי הטמעות שונות:

• ‫Proto DataStore, שמאפשר לכם לאחסן אובייקטים מוקלדים (מגובה על ידי מאגרי אחסון לפרוטוקולים)
• ‫Preferences DataStore, שמאחסן צמדי מפתח-ערך

הנתונים נשמרים באופן אסינכרוני, עקבי וטרנזקציונלי, כך שרוב החסרונות של SharedPreferences לא רלוונטיים.