Check out what’s new from Firebase at Google I/O 2022. Learn more

Aktivieren von Offline-Funktionen auf Android

Firebase-Anwendungen funktionieren auch dann, wenn Ihre App vorübergehend ihre Netzwerkverbindung verliert. Darüber hinaus bietet Firebase Tools zum lokalen Speichern von Daten, zum Verwalten der Präsenz und zum Behandeln von Latenzzeiten.

Festplattenpersistenz

Firebase-Apps behandeln vorübergehende Netzwerkunterbrechungen automatisch. Zwischengespeicherte Daten sind offline verfügbar und Firebase sendet alle Schreibvorgänge erneut, wenn die Netzwerkverbindung wiederhergestellt ist.

Wenn Sie die Datenträgerpersistenz aktivieren, schreibt Ihre App die Daten lokal auf das Gerät, sodass Ihre App den Status offline beibehalten kann, selbst wenn der Benutzer oder das Betriebssystem die App neu startet.

Sie können die Datenträgerpersistenz mit nur einer Codezeile aktivieren.

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);

Kotlin+KTX

Firebase.database.setPersistenceEnabled(true)

Persistenzverhalten

Durch Aktivieren der Persistenz bleiben alle Daten, die der Firebase-Echtzeitdatenbank-Client synchronisieren würde, während er online ist, auf der Festplatte bestehen und sind offline verfügbar, selbst wenn der Benutzer 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 Client der Firebase-Echtzeitdatenbank führt automatisch eine Warteschlange aller Schreibvorgänge, die ausgeführt werden, während Ihre App offline ist. Wenn Persistenz aktiviert ist, wird diese Warteschlange auch auf dem Datenträger gespeichert, sodass alle Ihre Schreibvorgänge verfügbar sind, wenn der Benutzer oder das Betriebssystem die App neu startet. Wenn die App die Verbindung wiedererlangt, werden alle Vorgänge an den Firebase Realtime Database-Server gesendet.

Wenn Ihre App die Firebase-Authentifizierung verwendet, speichert der Client der Firebase-Echtzeitdatenbank das Authentifizierungstoken des Benutzers über App-Neustarts hinweg. Wenn das Authentifizierungstoken abläuft, während Ihre App offline ist, pausiert der Client Schreibvorgänge, bis Ihre App den Benutzer erneut authentifiziert, andernfalls könnten 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. Darüber hinaus können Sie bestimmte Standorte synchron halten.

Java

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

Kotlin+KTX

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

Der Client der Firebase-Echtzeitdatenbank lädt die Daten automatisch an diesen Speicherorten herunter und hält sie auch dann synchron, wenn die Referenz keine aktiven Listener hat. Sie können die Synchronisierung mit der folgenden Codezeile wieder deaktivieren.

Java

scoresRef.keepSynced(false);

Kotlin+KTX

scoresRef.keepSynced(false)

Standardmäßig werden 10 MB zuvor synchronisierter Daten zwischengespeichert. Dies sollte für die meisten Anwendungen ausreichen. Wenn der Cache seine konfigurierte Größe überschreitet, löscht die Firebase-Echtzeitdatenbank Daten, die am längsten nicht verwendet wurden. Daten, die synchron gehalten werden, werden nicht aus dem Cache gelöscht.

Daten offline abfragen

Die Firebase-Echtzeitdatenbank speichert Daten, die von einer Abfrage zurückgegeben werden, um sie offline zu verwenden. Bei Abfragen, die offline erstellt wurden, funktioniert die Firebase-Echtzeitdatenbank 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 geben die Abfrage wieder.

Dieser Code fragt beispielsweise nach den letzten vier Elementen in einer Firebase-Echtzeitdatenbank mit Ergebnissen

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

    // ...
});

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

    // ...
})

Angenommen, der Benutzer verliert die Verbindung, geht offline und startet die App neu. Während Sie noch offline sind, fragt die App nach den letzten beiden Elementen vom selben Ort. Diese Abfrage gibt die letzten beiden Elemente erfolgreich zurück, da die App alle vier Elemente in der obigen Abfrage geladen hat.

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

    // ...
});

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

    // ...
})

Im vorherigen Beispiel löst der Client der Firebase-Echtzeitdatenbank „untergeordnet hinzugefügte“ Ereignisse für die zwei Dinosaurier mit der höchsten Punktzahl aus, indem er den permanenten Cache verwendet. Es wird jedoch kein „Wert“-Ereignis ausgelöst, da die App diese Abfrage noch nie ausgeführt hat, während sie online war.

Wenn die App die letzten sechs Elemente anfordern würde, während sie offline ist, würde sie sofort „untergeordnet hinzugefügte“ Ereignisse für die vier zwischengespeicherten Elemente erhalten. Wenn das Gerät wieder online ist, synchronisiert sich der Client der Firebase-Echtzeitdatenbank mit dem Server und ruft die letzten beiden „Child Added“- und „Value“-Ereignisse für die App ab.

Abwicklung von Transaktionen offline

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

Präsenz verwalten

In Echtzeitanwendungen ist es oft nützlich zu erkennen, wann Clients sich verbinden und trennen. Sie möchten beispielsweise einen Benutzer als „offline“ markieren, wenn sein Client die Verbindung trennt.

Firebase-Datenbankclients stellen einfache Primitive bereit, mit denen Sie in die Datenbank schreiben können, wenn ein Client die Verbindung zu den Firebase-Datenbankservern trennt. Diese Aktualisierungen erfolgen unabhängig davon, ob der Client die Verbindung sauber trennt oder nicht, sodass Sie sich darauf verlassen können, dass sie Daten bereinigen, selbst wenn eine Verbindung unterbrochen wird oder ein Client abstürzt. Alle Schreiboperationen, einschließlich Setzen, Aktualisieren und Entfernen, können bei einer Trennung durchgeführt werden.

Hier ist ein einfaches Beispiel für das Schreiben von Daten beim Trennen der Verbindung mithilfe der onDisconnect Primitive:

Java

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

Kotlin+KTX

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

So funktioniert onDisconnect

Wenn Sie eine onDisconnect() -Operation einrichten, befindet sich die Operation auf dem Firebase Realtime Database-Server. Der Server überprüft die Sicherheit, um sicherzustellen, dass der Benutzer 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 irgendeinem Zeitpunkt abläuft oder vom Realtime Database-Client aktiv geschlossen wird, überprüft der Server die Sicherheit ein zweites Mal (um sicherzustellen, dass die Operation noch gültig ist) und ruft dann das Ereignis auf.

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

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

Kotlin+KTX

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

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

Java

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

Kotlin+KTX

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

Verbindungsstatus erkennen

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

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

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

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

Unter Android verwaltet Firebase automatisch den Verbindungsstatus, 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 durch die goOffline Methode getrennt wird, 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 von auf dem Server generierten Zeitstempeln als Daten. Diese Funktion bietet in Kombination mit onDisconnect eine einfache Möglichkeit, zuverlässig den Zeitpunkt zu notieren, zu dem ein Realtime Database-Client die Verbindung getrennt hat:

Java

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

Kotlin+KTX

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

Zeitversatz

Während firebase.database.ServerValue.TIMESTAMP viel genauer und für die meisten Lese-/Schreibvorgänge vorzuziehen ist, kann es gelegentlich nützlich sein, die Zeitabweichung des Clients in Bezug auf die Server der Firebase Realtime Database zu schätzen. Sie können einen Rückruf an den Speicherort /.info/serverTimeOffset , 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. Beachten Sie, dass die Genauigkeit dieses Offsets durch die Netzwerklatenz beeinträchtigt werden kann und daher in erster Linie nützlich ist, um große Abweichungen (> 1 Sekunde) in der Uhrzeit zu erkennen.

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

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

Beispiel einer Präsenz-App

Durch die Kombination von Trennungsvorgängen mit der Überwachung des Verbindungsstatus und Serverzeitstempeln können Sie ein Benutzerpräsenzsystem aufbauen. In diesem System speichert jeder Benutzer Daten an einer Datenbankstelle, um anzuzeigen, ob ein Client der Echtzeitdatenbank online ist oder nicht. Clients setzen diesen Ort auf „true“, wenn sie online gehen, und einen Zeitstempel, wenn sie die Verbindung trennen. Dieser Zeitstempel gibt an, wann der angegebene Benutzer das letzte Mal online war.

Beachten Sie, dass Ihre App die Trennungsvorgänge in eine Warteschlange stellen sollte, bevor ein Benutzer als online markiert wird, um Racebedingungen zu vermeiden, falls die Netzwerkverbindung des Clients unterbrochen wird, bevor beide Befehle an den Server gesendet werden können.

Hier ist ein einfaches Benutzerpräsenzsystem:

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(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(DatabaseError error) {
        Log.w(TAG, "Listener was cancelled at .info/connected");
    }
});

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