הפעלת יכולות במצב אופליין ב-Android

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

התמדה של דיסקים

אפליקציות Firebase מטפלות באופן אוטומטי בהפרעות זמניות ברשת. הנתונים שנשמרו במטמון זמינים במצב אופליין, ו-Firebase שולח מחדש את כל הפעולות של כתיבת נתונים כשהחיבור לרשת משוחזר.

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

אפשר להפעיל את התכונה 'התמדה של דיסקים' באמצעות שורת קוד אחת בלבד.

Kotlin

Firebase.database.setPersistenceEnabled(true)
OfflineActivity.kt

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);
OfflineActivity.java

התנהגות של התמדה

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

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

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

שמירה על עדכניות הנתונים

‫Firebase Realtime Database מסנכרן ושומר עותק מקומי של הנתונים למאזינים פעילים. בנוסף, אתם יכולים לסנכרן מיקומים ספציפיים.

Kotlin

val scoresRef = Firebase.database.getReference("scores")
scoresRef.keepSynced(true)
OfflineActivity.kt

Java

DatabaseReference scoresRef = FirebaseDatabase.getInstance().getReference("scores");
scoresRef.keepSynced(true);
OfflineActivity.java

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

Kotlin

scoresRef.keepSynced(false)
OfflineActivity.kt

Java

scoresRef.keepSynced(false);
OfflineActivity.java

כברירת מחדל, נשמרים במטמון 10MB של נתונים שסונכרנו בעבר. הערך הזה אמור להספיק לרוב האפליקציות. אם המטמון גדל מעבר לגודל שהוגדר לו, המערכת Firebase Realtime Database מוחקת נתונים שהשימוש בהם היה הכי מזמן. נתונים שנשמרים בסנכרון לא נמחקים מהמטמון.

שליחת שאילתות לנתונים ממקורות אופליין

ה-Firebase Realtime Database מאחסן נתונים שמוחזרים משאילתה לשימוש במצב אופליין. לשאילתות שנבנו במצב אופליין, הפונקציה Firebase Realtime Database ממשיכה לפעול עבור נתונים שנפרסו בעבר. אם הנתונים המבוקשים לא נטענו, המערכת Firebase Realtime Database טוענת את הנתונים מהמטמון המקומי. כשהחיבור לרשת יחזור, הנתונים ייטענו ויוצגו בהתאם לשאילתה.

לדוגמה, הקוד הזה שולח שאילתה לגבי ארבעת הפריטים האחרונים ב-Firebase Realtime Database של ציונים

Kotlin

val scoresRef = Firebase.database.getReference("scores")
scoresRef.orderByValue().limitToLast(4).addChildEventListener(object : ChildEventListener {
    override fun onChildAdded(snapshot: DataSnapshot, previousChild: String?) {
        Log.d(TAG, "The ${snapshot.key} dinosaur's score is ${snapshot.value}")
    }

    // ...
})
OfflineActivity.kt

Java

DatabaseReference scoresRef = FirebaseDatabase.getInstance().getReference("scores");
scoresRef.orderByValue().limitToLast(4).addChildEventListener(new ChildEventListener() {
    @Override
    public void onChildAdded(@NonNull DataSnapshot snapshot, String previousChild) {
        Log.d(TAG, "The " + snapshot.getKey() + " dinosaur's score is " + snapshot.getValue());
    }

    // ...
});
OfflineActivity.java

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

Kotlin

scoresRef.orderByValue().limitToLast(2).addChildEventListener(object : ChildEventListener {
    override fun onChildAdded(snapshot: DataSnapshot, previousChild: String?) {
        Log.d(TAG, "The ${snapshot.key} dinosaur's score is ${snapshot.value}")
    }

    // ...
})
OfflineActivity.kt

Java

scoresRef.orderByValue().limitToLast(2).addChildEventListener(new ChildEventListener() {
    @Override
    public void onChildAdded(@NonNull DataSnapshot snapshot, String previousChild) {
        Log.d(TAG, "The " + snapshot.getKey() + " dinosaur's score is " + snapshot.getValue());
    }

    // ...
});
OfflineActivity.java

בדוגמה הקודמת, הלקוח Firebase Realtime Database מעלה אירועים מסוג child added עבור שני הדינוזאורים עם הניקוד הכי גבוה, באמצעות המטמון שנשמר. אבל לא יופעל אירוע מסוג 'value', כי האפליקציה מעולם לא ביצעה את השאילתה הזו כשהיא הייתה מחוברת לאינטרנט.

אם האפליקציה תבקש את ששת הפריטים האחרונים כשהיא במצב אופליין, היא תקבל מיד את האירועים 'child added' עבור ארבעת הפריטים שנשמרו במטמון. כשמכשיר חוזר למצב אונליין, לקוח Firebase Realtime Database מסתנכרן עם השרת ומקבל את שני האירועים האחרונים מסוג 'child added' ואת האירוע 'value' עבור האפליקציה.

טיפול בעסקאות אופליין

כל העסקאות שמבוצעות כשהאפליקציה במצב אופליין מתווספות לתור. אחרי שהאפליקציה מתחברת מחדש לרשת, העסקאות נשלחות לשרת Realtime Database.

ניהול הנוכחות

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

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

זוהי דוגמה פשוטה לכתיבת נתונים לאחר ניתוק באמצעות הפרימיטיב onDisconnect:

Kotlin

val presenceRef = Firebase.database.getReference("disconnectmessage")
// Write a string when this client loses connection
presenceRef.onDisconnect().setValue("I disconnected!")
OfflineActivity.kt

Java

DatabaseReference presenceRef = FirebaseDatabase.getInstance().getReference("disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnect().setValue("I disconnected!");
OfflineActivity.java

איך פועלת הפונקציה onDisconnect

כשמגדירים פעולת onDisconnect(), הפעולה מתבצעת בשרת Firebase Realtime Database. השרת בודק את האבטחה כדי לוודא שהמשתמש יכול לבצע את אירוע הכתיבה המבוקש, ומודיע לאפליקציה אם הבקשה לא תקינה. השרת עוקב אחרי החיבור. אם החיבור נכשל בגלל פסק זמן או אם הוא נסגר באופן פעיל על ידי לקוח Realtime Database, השרת בודק את האבטחה בפעם השנייה (כדי לוודא שהפעולה עדיין תקפה) ואז מפעיל את האירוע.

האפליקציה יכולה להשתמש בקריאה החוזרת בפעולת הכתיבה כדי לוודא ש-onDisconnect צורף בצורה נכונה:

Kotlin

presenceRef.onDisconnect().removeValue { error, reference ->
    error?.let {
        Log.d(TAG, "could not establish onDisconnect event: ${error.message}")
    }
}
OfflineActivity.kt

Java

presenceRef.onDisconnect().removeValue(new DatabaseReference.CompletionListener() {
    @Override
    public void onComplete(DatabaseError error, @NonNull DatabaseReference reference) {
        if (error != null) {
            Log.d(TAG, "could not establish onDisconnect event:" + error.getMessage());
        }
    }
});
OfflineActivity.java

אפשר גם לבטל onDisconnectאירוע.cancel() באמצעות קריאה ל-.cancel():

Kotlin

val onDisconnectRef = presenceRef.onDisconnect()
onDisconnectRef.setValue("I disconnected")
// ...
// some time later when we change our minds
// ...
onDisconnectRef.cancel()
OfflineActivity.kt

Java

OnDisconnect onDisconnectRef = presenceRef.onDisconnect();
onDisconnectRef.setValue("I disconnected");
// ...
// some time later when we change our minds
// ...
onDisconnectRef.cancel();
OfflineActivity.java

זיהוי מצב החיבור

במקרים רבים, כדי להשתמש בתכונות שקשורות לנוכחות, האפליקציה צריכה לדעת אם היא במצב אונליין או אופליין. ‫Firebase Realtime Database מספק מיקום מיוחד ב-/.info/connected שמתעדכן בכל פעם שמשתנה מצב החיבור של לקוח Firebase Realtime Database. לדוגמה:

Kotlin

val connectedRef = Firebase.database.getReference(".info/connected")
connectedRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(snapshot: DataSnapshot) {
        val connected = snapshot.getValue(Boolean::class.java) ?: false
        if (connected) {
            Log.d(TAG, "connected")
        } else {
            Log.d(TAG, "not connected")
        }
    }

    override fun onCancelled(error: DatabaseError) {
        Log.w(TAG, "Listener was cancelled")
    }
})
OfflineActivity.kt

Java

DatabaseReference connectedRef = FirebaseDatabase.getInstance().getReference(".info/connected");
connectedRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot snapshot) {
        boolean connected = snapshot.getValue(Boolean.class);
        if (connected) {
            Log.d(TAG, "connected");
        } else {
            Log.d(TAG, "not connected");
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        Log.w(TAG, "Listener was cancelled");
    }
});
OfflineActivity.java

‫/.info/connected הוא ערך בוליאני שלא מסונכרן בין לקוחות Realtime Database כי הערך תלוי במצב הלקוח. במילים אחרות, אם לקוח אחד קורא את /.info/connected כ-false, אין זה אומר שלקוח אחר יקרא גם הוא false.

ב-Android, ‏ Firebase מנהל באופן אוטומטי את מצב החיבור כדי להפחית את השימוש ברוחב הפס ובסוללה. אם ללקוח אין מאזינים פעילים, אין פעולות כתיבה או onDisconnect בהמתנה, והוא לא מנותק באופן מפורש באמצעות השיטה goOffline,‏ Firebase סוגר את החיבור אחרי 60 שניות של חוסר פעילות.

זמן האחזור של הטיפול

חותמות זמן של השרת

השרתים של Firebase Realtime Database מספקים מנגנון להוספת חותמות זמן שנוצרות בשרת כנתונים. התכונה הזו, בשילוב עם onDisconnect, מאפשרת לתעד בקלות ובאופן מהימן את השעה שבה לקוח Realtime Database התנתק:

Kotlin

val userLastOnlineRef = Firebase.database.getReference("users/joe/lastOnline")
userLastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP)
OfflineActivity.kt

Java

DatabaseReference userLastOnlineRef = FirebaseDatabase.getInstance().getReference("users/joe/lastOnline");
userLastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP);
OfflineActivity.java

הטיה בשעון

‫firebase.database.ServerValue.TIMESTAMP מדויק הרבה יותר, ועדיף לרוב פעולות הקריאה והכתיבה, אבל לפעמים כדאי להשתמש בו כדי להעריך את הטיית השעון של הלקוח ביחס לשרתים של Firebase Realtime Database. אפשר לצרף קריאה חוזרת למיקום /.info/serverTimeOffset כדי לקבל את הערך, באלפיות שנייה, שבו לקוחות Firebase Realtime Database מוסיפים לזמן המקומי המדווח (זמן עידן באלפיות שנייה) כדי להעריך את זמן השרת. חשוב לציין שזמן האחזור ברשת יכול להשפיע על הדיוק של ההפרש הזה, ולכן הוא שימושי בעיקר כדי לגלות פערים גדולים (> שנייה אחת) בשעון.

Kotlin

val offsetRef = Firebase.database.getReference(".info/serverTimeOffset")
offsetRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(snapshot: DataSnapshot) {
        val offset = snapshot.getValue(Double::class.java) ?: 0.0
        val estimatedServerTimeMs = System.currentTimeMillis() + offset
    }

    override fun onCancelled(error: DatabaseError) {
        Log.w(TAG, "Listener was cancelled")
    }
})
OfflineActivity.kt

Java

DatabaseReference offsetRef = FirebaseDatabase.getInstance().getReference(".info/serverTimeOffset");
offsetRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot snapshot) {
        double offset = snapshot.getValue(Double.class);
        double estimatedServerTimeMs = System.currentTimeMillis() + offset;
    }

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        Log.w(TAG, "Listener was cancelled");
    }
});
OfflineActivity.java

אפליקציה לדוגמה לזיהוי נוכחות

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

שימו לב: האפליקציה צריכה להוסיף את פעולות הניתוק לתור לפני שמשתמש מסומן כאונליין, כדי למנוע מצבי מירוץ במקרה שחיבור הרשת של הלקוח מתנתק לפני ששתי הפקודות נשלחות לשרת.

זוהי מערכת פשוטה של נוכחות משתמש:

Kotlin

// Since I can connect from multiple devices, we store each connection instance separately
// any time that connectionsRef's value is null (i.e. has no children) I am offline
val database = Firebase.database
val myConnectionsRef = database.getReference("users/joe/connections")

// Stores the timestamp of my last disconnect (the last time I was seen online)
val lastOnlineRef = database.getReference("/users/joe/lastOnline")

val connectedRef = database.getReference(".info/connected")
connectedRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(snapshot: DataSnapshot) {
        val connected = snapshot.getValue<Boolean>() ?: false
        if (connected) {
            val con = myConnectionsRef.push()

            // When this device disconnects, remove it
            con.onDisconnect().removeValue()

            // When I disconnect, update the last time I was seen online
            lastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP)

            // Add this device to my connections list
            // this value could contain info about the device or a timestamp too
            con.setValue(java.lang.Boolean.TRUE)
        }
    }

    override fun onCancelled(error: DatabaseError) {
        Log.w(TAG, "Listener was cancelled at .info/connected")
    }
})
OfflineActivity.kt

Java

// Since I can connect from multiple devices, we store each connection instance separately
// any time that connectionsRef's value is null (i.e. has no children) I am offline
final FirebaseDatabase database = FirebaseDatabase.getInstance();
final DatabaseReference myConnectionsRef = database.getReference("users/joe/connections");

// Stores the timestamp of my last disconnect (the last time I was seen online)
final DatabaseReference lastOnlineRef = database.getReference("/users/joe/lastOnline");

final DatabaseReference connectedRef = database.getReference(".info/connected");
connectedRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot snapshot) {
        boolean connected = snapshot.getValue(Boolean.class);
        if (connected) {
            DatabaseReference con = myConnectionsRef.push();

            // When this device disconnects, remove it
            con.onDisconnect().removeValue();

            // When I disconnect, update the last time I was seen online
            lastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP);

            // Add this device to my connections list
            // this value could contain info about the device or a timestamp too
            con.setValue(Boolean.TRUE);
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        Log.w(TAG, "Listener was cancelled at .info/connected");
    }
});
OfflineActivity.java