Aktivieren von Offlinefunktionen unter Android

Persistenzverhalten

Wenn Sie die Persistenz aktivieren, werden alle Daten, die der Firebase Realtime Database-Client synchronisieren würde, während er online ist, auf der Festplatte gespeichert und sind auch dann offline verfügbar, wenn der Nutzer oder das Betriebssystem die App neu startet. Das bedeutet, dass Ihre App mithilfe der im Cache gespeicherten lokalen Daten wie gewohnt funktioniert. Listener-Callbacks werden für lokale Updates weiterhin 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 dem Laufwerk gespeichert, sodass alle Schreibvorgänge verfügbar sind, wenn der Nutzer oder das Betriebssystem die App neu startet. Sobald die App wieder eine Verbindung herstellen kann, 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 bei App-Neustarts. Wenn das Authentifizierungstoken abläuft, während Ihre App offline ist, hält der Client Schreibvorgänge an, bis Ihre App den Nutzer noch einmal authentifiziert. Andernfalls können die Schreibvorgänge aufgrund von Sicherheitsregeln fehlschlagen.

Daten aktuell 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 hält sie synchron, auch wenn die Referenz keine aktiven Listener hat. 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 seine konfigurierte Größe überschreitet, werden von Firebase Realtime Database die Daten gelöscht, die am längsten nicht verwendet wurden. Synchronisierte Daten werden nicht aus dem Cache gelöscht.

Daten offline abfragen

Im Firebase Realtime Database werden Daten gespeichert, die von einer Abfrage zurückgegeben wurden, um sie offline zu verwenden. Bei Abfragen, die im Offlinemodus erstellt wurden, funktioniert das 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 wieder verfügbar ist, werden die Daten geladen und geben die Abfrage wieder.

Mit diesem Code werden beispielsweise die letzten vier Elemente in einer Firebase Realtime Database der Punktzahlen 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, die Verbindung des Nutzers bricht ab, er wechselt in den Offlinemodus und startet die App neu. Im Offlinemodus sucht die App nach den letzten beiden Elementen am selben Ort. 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 Ereignisse vom Typ „Kind hinzugefügt“ für die beiden Dinosaurier mit der höchsten Punktzahl aus, indem er den persistenten Cache verwendet. Es wird jedoch kein Ereignis vom Typ „value“ ausgelöst, da die App diese Abfrage nie ausgeführt hat, während sie online war.

Wenn die App die letzten sechs Elemente im Offlinemodus anfordert, erhält sie sofort Ereignisse vom Typ „untergeordnetes Element hinzugefügt“ für die vier im Cache gespeicherten Elemente. Wenn das Gerät wieder online ist, synchronisiert sich der Firebase Realtime Database-Client mit dem Server und ruft die letzten beiden Ereignisse „child_added“ und „value“ für die App ab.

Transaktionen offline abwickeln

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.

Funktionsweise von 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 irgendwann ein Zeitlimit erreicht oder vom Realtime Database-Client aktiv geschlossen wird, prüft der Server die Sicherheit noch einmal, 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 richtig 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, mit dem auf dem Server generierte Zeitstempel als Daten eingefügt werden können. Diese Funktion in Kombination mit onDisconnect bietet eine einfache Möglichkeit, die Zeit zu erfassen, zu der eine Verbindung zu einem Realtime Database-Client getrennt wurde:

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

Zeitabweichung

Obwohl firebase.database.ServerValue.TIMESTAMP viel genauer ist und für die meisten Lese-/Schreibvorgänge zu bevorzugen ist, kann es gelegentlich nützlich sein, die Taktverzerrung des Clients in Bezug auf die Server der Firebase Realtime Database zu schätzen. Sie können dem Standort /.info/serverTimeOffset einen Rückruf zuordnen, um den Wert in Millisekunden zu erhalten, den Firebase Realtime Database-Clients zur lokal gemeldeten Zeit (Epochenzeit in Millisekunden) hinzufügen, um die Serverzeit zu schätzen. Die Genauigkeit dieses Offset kann durch die Netzwerklatenz beeinträchtigt werden. Daher ist er hauptsächlich zum Erkennen großer Abweichungen (> 1 Sekunde) bei der Uhrzeit nützlich.

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