Aktivieren von Offlinefunktionen unter Android

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 Präsenz und zum Umgang mit Latenz.

Festplattenspeicherung

Firebase-Apps verarbeiten vorübergehende Netzwerkunterbrechungen automatisch. Cache-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.

Kotlin

Firebase.database.setPersistenceEnabled(true)
OfflineActivity.kt

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);
OfflineActivity.java

Verhalten bei der Speicherung

Wenn Sie die Speicherung 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 so funktioniert wie online, 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 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 Schreibvorgänge, bis Ihre App den Nutzer neu authentifiziert. Andernfalls können 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. Außerdem können Sie bestimmte Standorte in sync halten.

Kotlin

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

Java

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

Der Firebase Realtime Database Client lädt die Daten an diesen Standorten 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.

Kotlin

scoresRef.keepSynced(false)
OfflineActivity.kt

Java

scoresRef.keepSynced(false);
OfflineActivity.java

Standardmäßig werden 10 MB zuvor synchronisierter Daten im Cache gespeichert. Das sollte ausreichen für die meisten Anwendungen. Wenn der Cache die konfigurierte Größe überschreitet, die Firebase Realtime Database löscht 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, zur 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, die Daten werden geladen und spiegeln die Abfrage wider.

Mit diesem Code werden beispielsweise die letzten vier Elemente in einer Firebase Realtime Database mit Ergebnissen abgefragt.

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

    // ...
})
OfflineActivity.kt

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

    // ...
});
OfflineActivity.java

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 Standort ab. Diese Abfrage gibt die letzten beiden Elemente zurück da die App alle vier Elemente in der obigen Abfrage geladen hat.

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

    // ...
})
OfflineActivity.kt

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

    // ...
});
OfflineActivity.java

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

Wenn die App im Offlinemodus die letzten sechs Elemente anfordert, werden sofort Ereignisse vom Typ „child added“ 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 Ereignisse vom Typ „child added“ und das Ereignis vom Typ „value“ 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.

Transaktionen werden nicht nach dem Neustart der App beibehalten

Auch wenn die Speicherung aktiviert ist, werden Transaktionen nicht nach dem Neustart der App beibehalten. Sie können sich also nicht darauf verlassen, dass Transaktionen, die offline ausgeführt wurden in Ihrer Firebase Realtime Database gespeichert werden. Um die bestmögliche Nutzererfahrung zu bieten, sollte Ihre App anzeigen, dass eine Transaktion noch nicht in Ihrer Firebase Realtime Database gespeichert wurde. Alternativ können Sie dafür sorgen, dass Ihre App sie manuell speichert und nach dem Neustart der App noch einmal ausführt.

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

Präsenz verwalten

In Echtzeitanwendungen ist es oft nützlich zu erkennen, wenn sich Clients verbinden und trennen. Sie können beispielsweise einen Nutzer als „offline“ markieren, wenn die Verbindung des Clients 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 Updates erfolgen unabhängig davon, ob die Verbindung des Clients ordnungsgemäß getrennt wird, 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:

Kotlin

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

Java

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

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 ein 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.

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

Kotlin

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

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

Ein onDisconnect-Ereignis kann auch mit .cancel() abgebrochen werden:

Kotlin

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

Java

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

Verbindungsstatus erkennen

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

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")
    }
})
OfflineActivity.kt

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

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

Unter Android verwaltet Firebase den Verbindungsstatus automatisch, um die Bandbreite und den Akkuverbrauch zu reduzieren. Wenn ein Client keine aktiven Listener, keine ausstehenden Schreibvorgänge oder onDisconnect Vorgänge hat und nicht explizit mit der goOffline Methode getrennt wurde, schließt Firebase die Verbindung nach 60 Sekunden Inaktivität.

Umgang mit Latenz

Server-Zeitstempel

Die Firebase Realtime Database Server bieten einen Mechanismus zum Einfügen Zeitstempel, die auf dem Server generiert wurden, als Daten. In Kombination mit onDisconnect, können Sie so auf einfache Weise zuverlässig den Zeitpunkt notieren, zu dem die Verbindung eines Realtime Database Clients getrennt wurde:

Kotlin

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

Java

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

Uhrzeitabweichung

`firebase.database.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 firebase.database.ServerValue.TIMESTAMP zu schätzen.Firebase Realtime Database Sie können einen Callback an den Standort /.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 dieser Abweichung kann durch die Netzwerklatenz beeinträchtigt werden. Sie ist daher hauptsächlich nützlich, um große (> 1 Sekunde) Abweichungen in der Uhrzeit zu erkennen.

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")
    }
})
OfflineActivity.kt

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

Beispiel-App für die Präsenz

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 Nutzerpräsenz erstellen. In diesem System speichert jeder Nutzer Daten an einem Datenbankstandort, um anzugeben, ob ein Realtime Database Client online ist. Clients legen diesen Standort 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.

Hier ein einfaches System für die Nutzerpräsenz:

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")
    }
})
OfflineActivity.kt

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