Aktivieren von Offlinefunktionen unter Android

Persistenzverhalten

Wenn Sie die Persistenz aktivieren, werden alle Daten, die der Firebase Realtime Database-Client synchronisieren würde, wenn er online ist, auf der Festplatte gespeichert und sind offline verfügbar, auch wenn der Nutzer 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 Firebase Realtime Database-Client führt automatisch eine Warteschlange aller Schreibvorgänge, die ausgeführt werden, während Ihre App offline ist. Wenn die Persistenz aktiviert ist, wird diese Warteschlange auch auf der Festplatte gespeichert, sodass alle Schreibvorgänge verfügbar sind, wenn der Nutzer oder das Betriebssystem die App neu startet. Sobald die App wieder eine Verbindung hat, werden alle Vorgänge an den Firebase Realtime Database-Server gesendet.

Wenn Ihre App Firebase Authentication verwendet, speichert der Firebase Realtime Database-Client das Authentifizierungstoken des Nutzers auch nach Neustarts der App. Wenn das Authentifizierungstoken abläuft, während Ihre App offline ist, werden Schreibvorgänge vom Client pausiert, bis Ihre App den Nutzer neu authentifiziert. Andernfalls können die Schreibvorgänge aufgrund von Sicherheitsregeln fehlschlagen.

Daten auf dem neuesten Stand halten

Der Firebase Realtime Database synchronisiert und speichert eine lokale Kopie der Daten für aktive Zuhörer. Außerdem können Sie bestimmte Standorte synchronisieren.

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

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

Der Firebase Realtime Database-Client lädt die Daten an diesen Speicherorten automatisch herunter und synchronisiert sie, auch wenn für die Referenz keine aktiven Listener vorhanden sind. Mit der folgenden Codezeile können Sie die Synchronisierung wieder deaktivieren.

scoresRef.keepSynced(false)
OfflineActivity.kt

scoresRef.keepSynced(false);
OfflineActivity.java

Standardmäßig werden 10 MB zuvor synchronisierter Daten im Cache gespeichert. Das sollte für die meisten Anwendungen ausreichen. Wenn der Cache die konfigurierte Größe überschreitet, werden in Firebase Realtime Database die Daten gelöscht, die am längsten nicht verwendet wurden. Daten, die synchronisiert werden, werden nicht aus dem Cache gelöscht.

Daten offline abfragen

Im Firebase Realtime Database werden Daten gespeichert, die von einer Abfrage zurückgegeben werden und für die Offlinenutzung vorgesehen sind. Bei Abfragen, die offline erstellt wurden, funktioniert Firebase Realtime Database weiterhin für zuvor geladene Daten. Wenn die angeforderten Daten nicht geladen wurden, lädt Firebase Realtime Database Daten aus dem lokalen Cache. Sobald die Netzwerkverbindung wiederhergestellt ist, werden die Daten geladen und die Abfrage wird berücksichtigt.

Mit diesem Code werden beispielsweise die letzten vier Elemente in einem Firebase Realtime Database von Ergebnissen abgefragt:

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

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

Angenommen, der Nutzer verliert die Verbindung, geht offline und startet die App neu. Während er noch offline ist, fragt die App nach den letzten beiden Elementen vom selben Standort. Bei dieser Abfrage werden die letzten beiden Elemente zurückgegeben, da die App alle vier Elemente in der obigen Abfrage geladen hat.

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

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

Im vorherigen Beispiel löst der Firebase Realtime Database-Client mithilfe des persistenten Cache „child added“-Ereignisse für die beiden Dinosaurier mit der höchsten Punktzahl aus. Es wird jedoch kein „value“-Ereignis ausgelöst, da die App diese Abfrage noch nie im Onlinemodus ausgeführt hat.

Wenn die App die letzten sechs Elemente im Offlinemodus anfordert, erhält sie sofort „child added“-Ereignisse für die vier im Cache gespeicherten Elemente. Wenn das Gerät wieder online ist, wird der Firebase Realtime Database-Client mit dem Server synchronisiert und ruft die letzten beiden Ereignisse „child added“ und das Ereignis „value“ für die App ab.

Offlinetransaktionen verarbeiten

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

So funktioniert „onDisconnect“

Wenn Sie einen onDisconnect()-Vorgang einrichten, wird er auf dem Firebase Realtime Database-Server ausgeführt. Der Server prüft die Sicherheit, um sicherzustellen, dass der Nutzer 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 einem beliebigen Zeitpunkt das Zeitlimit überschreitet oder vom Realtime Database-Client aktiv geschlossen wird, prüft der Server die Sicherheit ein zweites Mal (um sicherzustellen, dass der Vorgang noch gültig ist) und ruft dann das Ereignis auf.

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

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

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

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

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

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

Server-Zeitstempel

Die Firebase Realtime Database-Server bieten einen Mechanismus zum Einfügen von Zeitstempeln, die auf dem Server generiert werden, als Daten. Diese Funktion bietet in Kombination mit onDisconnect eine einfache Möglichkeit, die Zeit zu erfassen, zu der ein Realtime Database-Client die Verbindung getrennt hat:

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

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

Clock Skew

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

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

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