Aktivieren von Offline-Funktionen auf Android

Persistenzverhalten

Durch Aktivieren der Persistenz bleiben alle Daten, die der Firebase-Echtzeitdatenbank-Client synchronisieren würde, während er online ist, auf der Festplatte bestehen und sind offline verfügbar, selbst wenn der Benutzer oder das Betriebssystem die App neu startet. Das bedeutet, dass Ihre App wie online funktioniert, indem sie die im Cache gespeicherten lokalen Daten verwendet. Listener-Callbacks werden weiterhin für lokale Updates ausgelöst.

Der Client der Firebase-Echtzeitdatenbank führt automatisch eine Warteschlange aller Schreibvorgänge, die ausgeführt werden, während Ihre App offline ist. Wenn Persistenz aktiviert ist, wird diese Warteschlange auch auf dem Datenträger gespeichert, sodass alle Ihre Schreibvorgänge verfügbar sind, wenn der Benutzer oder das Betriebssystem die App neu startet. Wenn die App die Verbindung wiedererlangt, werden alle Vorgänge an den Firebase Realtime Database-Server gesendet.

Wenn Ihre App die Firebase-Authentifizierung verwendet, speichert der Client der Firebase-Echtzeitdatenbank das Authentifizierungstoken des Benutzers über App-Neustarts hinweg. Wenn das Authentifizierungstoken abläuft, während Ihre App offline ist, pausiert der Client Schreibvorgänge, bis Ihre App den Benutzer erneut authentifiziert, andernfalls könnten die Schreibvorgänge aufgrund von Sicherheitsregeln fehlschlagen.

Daten aktuell halten

Die Firebase Realtime Database synchronisiert und speichert eine lokale Kopie der Daten für aktive Listener. Darüber hinaus können Sie bestimmte Standorte synchron halten.

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

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

Der Client der Firebase-Echtzeitdatenbank lädt die Daten automatisch an diesen Speicherorten herunter und hält sie auch dann synchron, wenn die Referenz keine aktiven Listener hat. Sie können die Synchronisierung mit der folgenden Codezeile wieder deaktivieren.

scoresRef.keepSynced(false);
OfflineActivity.java

scoresRef.keepSynced(false)
OfflineActivity.kt

Standardmäßig werden 10 MB zuvor synchronisierter Daten zwischengespeichert. Dies sollte für die meisten Anwendungen ausreichen. Wenn der Cache seine konfigurierte Größe überschreitet, löscht die Firebase-Echtzeitdatenbank Daten, die am längsten nicht verwendet wurden. Daten, die synchron gehalten werden, werden nicht aus dem Cache gelöscht.

Daten offline abfragen

Die Firebase-Echtzeitdatenbank speichert Daten, die von einer Abfrage zurückgegeben werden, um sie offline zu verwenden. Bei Abfragen, die offline erstellt wurden, funktioniert die Firebase-Echtzeitdatenbank weiterhin für zuvor geladene Daten. Wenn die angeforderten Daten nicht geladen wurden, lädt die Firebase Realtime Database Daten aus dem lokalen Cache. Wenn die Netzwerkverbindung wieder verfügbar ist, werden die Daten geladen und geben die Abfrage wieder.

Dieser Code fragt beispielsweise nach den letzten vier Elementen in einer Firebase-Echtzeitdatenbank mit Ergebnissen

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

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

Angenommen, der Benutzer verliert die Verbindung, geht offline und startet die App neu. Während Sie noch offline sind, fragt die App nach den letzten beiden Elementen vom selben Ort. Diese Abfrage gibt die letzten beiden Elemente erfolgreich zurück, da die App alle vier Elemente in der obigen Abfrage geladen hat.

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

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

Im vorherigen Beispiel löst der Client der Firebase-Echtzeitdatenbank „untergeordnet hinzugefügte“ Ereignisse für die zwei Dinosaurier mit der höchsten Punktzahl aus, indem er den permanenten Cache verwendet. Es wird jedoch kein „Wert“-Ereignis ausgelöst, da die App diese Abfrage noch nie ausgeführt hat, während sie online war.

Wenn die App die letzten sechs Elemente anfordern würde, während sie offline ist, würde sie sofort „untergeordnet hinzugefügte“ Ereignisse für die vier zwischengespeicherten Elemente erhalten. Wenn das Gerät wieder online ist, synchronisiert sich der Client der Firebase-Echtzeitdatenbank mit dem Server und ruft die letzten beiden „Child Added“- und „Value“-Ereignisse für die App ab.

Abwicklung von Transaktionen offline

Alle Transaktionen, die durchgeführt werden, während die App offline ist, werden in die Warteschlange gestellt. Sobald die App die Netzwerkverbindung wiedererlangt, werden die Transaktionen an den Realtime Database-Server gesendet.

So funktioniert onDisconnect

Wenn Sie eine onDisconnect() -Operation einrichten, befindet sich die Operation auf dem Firebase Realtime Database-Server. Der Server überprüft die Sicherheit, um sicherzustellen, dass der Benutzer das angeforderte Schreibereignis ausführen kann, und informiert Ihre App, wenn es ungültig ist. Der Server überwacht dann die Verbindung. Wenn die Verbindung zu irgendeinem Zeitpunkt abläuft oder vom Realtime Database-Client aktiv geschlossen wird, überprüft der Server die Sicherheit ein zweites Mal (um sicherzustellen, dass die Operation noch gültig ist) und ruft dann das Ereignis auf.

Ihre App kann den Rückruf für den Schreibvorgang verwenden, um sicherzustellen, dass onDisconnect korrekt angehängt wurde:

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

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

Ein onDisconnect Ereignis kann auch durch Aufrufen von .cancel() abgebrochen werden:

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

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

Server-Zeitstempel

Die Firebase Realtime Database-Server bieten einen Mechanismus zum Einfügen von auf dem Server generierten Zeitstempeln als Daten. Diese Funktion bietet in Kombination mit onDisconnect eine einfache Möglichkeit, zuverlässig den Zeitpunkt zu notieren, zu dem ein Realtime Database-Client die Verbindung getrennt hat:

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

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

Zeitversatz

Während firebase.database.ServerValue.TIMESTAMP viel genauer und für die meisten Lese-/Schreibvorgänge vorzuziehen ist, kann es gelegentlich nützlich sein, die Zeitabweichung des Clients in Bezug auf die Server der Firebase Realtime Database zu schätzen. Sie können einen Rückruf an den Speicherort /.info/serverTimeOffset , um den Wert in Millisekunden abzurufen, den Firebase Realtime Database-Clients zur lokal gemeldeten Zeit (Epochenzeit in Millisekunden) hinzufügen, um die Serverzeit zu schätzen. Beachten Sie, dass die Genauigkeit dieses Offsets durch die Netzwerklatenz beeinträchtigt werden kann und daher in erster Linie nützlich ist, um große Abweichungen (> 1 Sekunde) in der Uhrzeit zu erkennen.

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

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