Aktivieren von Offline-Funktionen

Firebase-Anwendungen funktionieren auch dann, wenn die App vorübergehend die Netzwerkverbindung verliert. Außerdem bietet Firebase Tools zum lokalen Speichern von Daten, zum Verwalten der Anwesenheit und zum Umgang mit Latenz.

Festplattenspeicherung

Firebase-Apps verarbeiten vorübergehende Netzwerkunterbrechungen automatisch. Im Cache gespeicherte Daten sind offline verfügbar und Firebase sendet alle Schreibvorgänge noch einmal, wenn die Netzwerkverbindung wiederhergestellt ist.

Wenn Sie die Festplattenspeicherung aktivieren, schreibt Ihre App die Daten lokal auf das Gerät. So kann der Status der App auch offline beibehalten werden, selbst wenn der Nutzer oder das Betriebssystem die App neu startet.

Sie können die Festplattenspeicherung mit nur einer Codezeile aktivieren.

FirebaseDatabase.instance.setPersistenceEnabled(true);

Verhalten bei der Speicherung

Wenn Sie die Speicherung 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 offline verfügbar, selbst 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 Aktualisierungen 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 Speicherung 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. Wenn die App wieder eine Verbindung herstellt, 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 dem Neustart der App. Wenn das Authentifizierungstoken abläuft, während Ihre App offline ist, pausiert der Client Schreibvorgänge, bis Ihre App den Nutzer neu authentifiziert. Andernfalls schlagen die Schreibvorgänge aufgrund von Sicherheitsregeln möglicherweise fehl.

Daten auf dem neuesten Stand halten

Die Firebase Realtime Database synchronisiert und speichert eine lokale Kopie der Daten für aktive Listener. Außerdem können Sie bestimmte Speicherorte synchron halten.

final scoresRef = FirebaseDatabase.instance.ref("scores");
scoresRef.keepSynced(true);

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. Sie können die Synchronisierung mit der folgenden Codezeile wieder deaktivieren.

scoresRef.keepSynced(false);

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, löscht die Firebase Realtime Database die Daten, die zuletzt verwendet wurden. Daten, die synchron gehalten werden, werden nicht aus dem Cache gelöscht.

Daten offline abfragen

Die Firebase Realtime Database speichert Daten, die von einer Abfrage zurückgegeben werden, für die Verwendung im Offlinemodus. Bei Abfragen, die im Offlinemodus erstellt wurden, funktioniert die Firebase Realtime Database 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 spiegeln die Abfrage wider.

Mit diesem Code werden beispielsweise die letzten vier Elemente in einer Datenbank mit Ergebnissen abgefragt:

final scoresRef = FirebaseDatabase.instance.ref("scores");
scoresRef.orderByValue().limitToLast(4).onChildAdded.listen((event) {
  debugPrint("The ${event.snapshot.key} dinosaur's score is ${event.snapshot.value}.");
});

Angenommen, der Nutzer verliert die Verbindung, geht offline und startet die App neu. Während er noch offline ist, fragt die App die letzten beiden Elemente vom selben Speicherort ab. Diese Abfrage gibt die letzten beiden Elemente zurück, da die App alle vier Elemente in der obigen Abfrage geladen hat.

scoresRef.orderByValue().limitToLast(2).onChildAdded.listen((event) {
  debugPrint("The ${event.snapshot.key} dinosaur's score is ${event.snapshot.value}.");
});

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

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

Transaktionen offline verarbeiten

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

Die Firebase Realtime Database bietet viele Funktionen für den Umgang mit Offlineszenarien und Netzwerkverbindungen. Der Rest dieser Anleitung gilt für Ihre App, unabhängig davon, ob Sie die Speicherung aktiviert haben.

Anwesenheit verwalten

In Echtzeitanwendungen ist es oft nützlich zu erkennen, wann sich Clients verbinden und trennen. Sie können beispielsweise einen Nutzer als „offline“ markieren, wenn die Verbindung zum Client getrennt wird.

Firebase Database-Clients bieten einfache Primitive, mit denen Sie in die Datenbank schreiben können, wenn die Verbindung eines Clients zu den Firebase Database-Servern getrennt wird. Diese Aktualisierungen erfolgen unabhängig davon, ob die Verbindung zum Client ordnungsgemäß getrennt wird oder nicht. Sie können sich also darauf verlassen, dass Daten bereinigt werden, auch wenn eine Verbindung unterbrochen wird oder ein Client abstürzt. Alle Schreibvorgänge, einschließlich Festlegen, Aktualisieren und Entfernen, können nach dem Trennen der Verbindung ausgeführt werden.

Hier ein einfaches Beispiel für das Schreiben von Daten nach dem Trennen der Verbindung mit dem onDisconnect-Primitiv:

final presenceRef = FirebaseDatabase.instance.ref("disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnect().set("I disconnected!");

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. Anschließend überwacht der Server die Verbindung. Wenn die Verbindung irgendwann das Zeitlimit überschreitet oder aktiv vom Realtime Database-Client 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.

try {
    await presenceRef.onDisconnect().remove();
} catch (error) {
    debugPrint("Could not establish onDisconnect event: $error");
}

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

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

Verbindungsstatus erkennen

Für viele anwesenheitsbezogene Funktionen ist es nützlich, wenn Ihre App weiß, wann sie online oder offline ist. Die Firebase Realtime Database bietet einen speziellen Speicherort unter /.info/connected, der jedes Mal aktualisiert wird, wenn sich der Verbindungsstatus des Firebase Realtime Database-Clients ändert. Hier ein Beispiel:

final connectedRef = FirebaseDatabase.instance.ref(".info/connected");
connectedRef.onValue.listen((event) {
  final connected = event.snapshot.value as bool? ?? false;
  if (connected) {
    debugPrint("Connected.");
  } else {
    debugPrint("Not connected.");
  }
});

/.info/connected ist ein boolescher Wert, der nicht zwischen Realtime Database-Clients synchronisiert wird, da er vom Status des Clients abhängt. Wenn ein Client /.info/connected als „false“ liest, ist das also keine Garantie dafür, dass ein anderer Client ebenfalls „false“ liest.

Umgang mit Latenz

Server-Zeitstempel

Die Firebase Realtime Database-Server bieten einen Mechanismus zum Einfügen von Zeitstempeln, die auf dem Server generiert wurden, als Daten. In Kombination mit onDisconnect können Sie mit dieser Funktion auf einfache Weise zuverlässig die Zeit erfassen, zu der die Verbindung zu einem Realtime Database-Client getrennt wurde:

final userLastOnlineRef =
    FirebaseDatabase.instance.ref("users/joe/lastOnline");
userLastOnlineRef.onDisconnect().set(ServerValue.timestamp);

Uhrzeitabweichung

ServerValue.timestamp ist zwar viel genauer und für die meisten Lese-/Schreibvorgänge vorzuziehen, aber gelegentlich kann es nützlich sein, die Uhrzeitabweichung des Clients in Bezug auf die Server der 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 zur 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. Es ist daher hauptsächlich nützlich, um große (> 1 Sekunde) Abweichungen in der Uhrzeit zu erkennen.

final offsetRef = FirebaseDatabase.instance.ref(".info/serverTimeOffset");
offsetRef.onValue.listen((event) {
  final offset = event.snapshot.value as num? ?? 0.0;
  final estimatedServerTimeMs =
      DateTime.now().millisecondsSinceEpoch + offset;
});

Beispiel-App für die Anwesenheit

Durch die Kombination von Vorgängen zum Trennen der Verbindung mit der Überwachung des Verbindungsstatus und Server-Zeitstempeln können Sie ein System für die Anwesenheit von Nutzern erstellen. In diesem System speichert jeder Nutzer Daten an einem Datenbankspeicherort, um anzugeben, ob ein Realtime Database-Client online ist oder nicht. Clients legen diesen Speicherort auf „true“ fest, wenn sie online gehen, und auf einen Zeitstempel, wenn sie die Verbindung trennen. Dieser Zeitstempel gibt an, wann der jeweilige Nutzer zuletzt online war.

Ihre App sollte die Vorgänge zum Trennen der Verbindung in die Warteschlange stellen, bevor ein Nutzer als online markiert wird, um Race-Bedingungen zu vermeiden, falls die Netzwerkverbindung des Clients unterbrochen wird, bevor beide Befehle an den Server gesendet werden können.

// 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 myConnectionsRef =
    FirebaseDatabase.instance.ref("users/joe/connections");

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

final connectedRef = FirebaseDatabase.instance.ref(".info/connected");
connectedRef.onValue.listen((event) {
  final connected = event.snapshot.value as bool? ?? false;
  if (connected) {
    final con = myConnectionsRef.push();

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

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

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