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

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

דיסק אחסון מתמיד (persistent disk)

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

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

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

Kotlin

Firebase.database.setPersistenceEnabled(true)

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);

התנהגות מתמידה

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

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

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

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

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

Kotlin

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

Java

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

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

Kotlin

scoresRef.keepSynced(false)

Java

scoresRef.keepSynced(false);

כברירת מחדל, נתונים בנפח של 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}")
    }

    // ...
})

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());
    }

    // ...
});

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

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

    // ...
})

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());
    }

    // ...
});

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

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

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

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

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

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

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

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

Kotlin

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

Java

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

איך onDisconnect פועל

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

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

Kotlin

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

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());
        }
    }
});

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

Kotlin

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

Java

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

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

בהרבה תכונות שקשורות לנוכחות, כדאי שהאפליקציה תדע מתי היא אונליין או אופליין. 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")
    }
})

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

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

Java

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

הפרש זמנים בין שעונים

‫firebase.database.ServerValue.TIMESTAMP הרבה יותר מדויק, ועדיף לרוב פעולות הקריאה/כתיבה, אבל לפעמים כדאי להעריך את סטיית השעון של הלקוח ביחס לשרתים של Firebase Realtime Database. אפשר לצרף קריאה חוזרת (callback) למיקום /.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")
    }
})

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

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

כשמשלבים פעולות ניתוק עם מעקב אחרי מצב החיבור וחותמות זמן של השרת, אפשר ליצור מערכת נוכחות של משתמשים. במערכת הזו, כל משתמש מאחסן נתונים במיקום במסד הנתונים כדי לציין אם לקוח 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")
    }
})

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