Aktivieren von Offlinefunktionen unter Android

Firebase-Anwendungen funktionieren auch dann, wenn die Netzwerkverbindung Ihrer App vorübergehend unterbrochen wird. Außerdem bietet Firebase Tools zum Speichern von Daten lokal, zum Verwalten der Präsenz und zum Umgang mit Latenz.

Laufwerkspeicher

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

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

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

Kotlin+KTX

Firebase.database.setPersistenceEnabled(true)

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);

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

Kotlin+KTX

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

Java

DatabaseReference scoresRef = FirebaseDatabase.getInstance().getReference("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. Mit der folgenden Codezeile können Sie die Synchronisierung wieder deaktivieren.

Kotlin+KTX

scoresRef.keepSynced(false)

Java

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 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 wiederhergestellt ist, werden die Daten geladen und die Abfrage wird berücksichtigt.

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

Kotlin+KTX

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

    // ...
})

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

    // ...
});

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 Standort. Bei dieser Abfrage werden die letzten beiden Elemente zurückgegeben, da die App alle vier Elemente in der obigen Abfrage geladen hat.

Kotlin+KTX

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

    // ...
})

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

    // ...
});

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 „value“-Ereignis 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.

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.

Anwesenheit verwalten

Bei Echtzeitanwendungen ist es oft nützlich zu erkennen, wann Clients eine Verbindung herstellen und trennen. So können Sie beispielsweise einen Nutzer als „offline“ markieren, wenn die Verbindung seines Clients getrennt wird.

Firebase Database-Clients bieten einfache Primitive, mit denen Sie in die Datenbank schreiben können, wenn ein Client die Verbindung zu den Firebase Database-Servern trennt. Diese Aktualisierungen erfolgen unabhängig davon, ob die Clientverbindung sauber getrennt wird oder nicht. Sie können also darauf vertrauen, dass Daten auch dann bereinigt werden, wenn eine Verbindung getrennt wird oder ein Client abstürzt. Alle Schreibvorgänge, einschließlich Festlegen, Aktualisieren und Entfernen, können bei einer Unterbrechung ausgeführt werden.

Hier ein einfaches Beispiel für das Schreiben von Daten nach der Verbindungsunterbrechung mithilfe der onDisconnect-Primitivstruktur:

Kotlin+KTX

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

Java

DatabaseReference presenceRef = FirebaseDatabase.getInstance().getReference("disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnect().setValue("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. 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:

Kotlin+KTX

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

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

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

Kotlin+KTX

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

Java

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

Verbindungsstatus erkennen

Bei vielen Präsenzfunktionen ist es hilfreich, wenn Ihre App weiß, ob sie online oder offline ist. Firebase Realtime Database stellt einen speziellen Speicherort unter /.info/connected bereit, der jedes Mal aktualisiert wird, wenn sich der Verbindungsstatus des Firebase Realtime Database-Clients ändert. Hier ein Beispiel:

Kotlin+KTX

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

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

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

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

Latenz handhaben

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:

Kotlin+KTX

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

Java

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

Zeitabweichung

firebase.database.ServerValue.TIMESTAMP ist zwar viel genauer und für die meisten Lese-/Schreibvorgänge vorzuziehen, gelegentlich kann es jedoch nützlich sein, die Zeitabweichung des Clients im Vergleich zu den Firebase Realtime Database-Servern 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.

Kotlin+KTX

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

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

Beispiel-App für Anwesenheit

Wenn Sie die Verbindungstrennung mit der Überwachung des Verbindungsstatus und Server-Zeitstempeln kombinieren, können Sie ein System zur Nutzerpräsenz erstellen. In diesem System speichert jeder Nutzer Daten an einem Datenbankspeicherort, um anzugeben, ob ein Realtime Database-Client online ist oder nicht. Clients setzen diesen Standort auf „True“, wenn sie online gehen, und einen Zeitstempel, wenn die Verbindung getrennt wird. Dieser Zeitstempel gibt an, wann der betreffende Nutzer zuletzt online war.

Die App sollte die Verbindungsauflösungen 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 ist ein einfaches System zur Nutzerpräsenz:

Kotlin+KTX

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

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