Aktivieren von Offlinefunktionen unter Android

Firebase-Anwendungen funktionieren auch dann, wenn die Netzwerkverbindung Ihrer App vorübergehend unterbrochen wird. Darüber hinaus bietet Firebase Tools für die lokale Speicherung von Daten, die Verwaltung der Präsenz und die Handhabung von Latenz.

Nichtflüchtiger Speicher

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 Laufwerkspersistenz aktivieren, schreibt Ihre App die Daten lokal auf das Gerät. So kann die App den Status auch dann beibehalten, wenn sie offline ist, selbst wenn der Nutzer oder das Betriebssystem die App neu startet.

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

Kotlin

Firebase.database.setPersistenceEnabled(true)

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);

Persistenzverhalten

Wenn Sie die Persistenz aktivieren, werden alle Daten, die der Firebase Realtime Database-Client im Onlinemodus synchronisieren würde, auf dem Laufwerk gespeichert und sind offline verfügbar, auch wenn der Nutzer oder das Betriebssystem die App neu startet. Das bedeutet, dass Ihre App wie im Onlinemodus funktioniert, 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 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 hat, 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 über App-Neustarts hinweg. Wenn das Authentifizierungstoken abläuft, während Ihre App offline ist, pausiert der Client Schreibvorgänge, bis Ihre App den Nutzer neu 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 Listener. Außerdem können Sie bestimmte Standorte synchronisieren.

Kotlin

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

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 die konfigurierte Größe überschreitet, löscht der Firebase Realtime Database die Daten, die am längsten nicht verwendet wurden. Daten, die synchronisiert werden, werden nicht aus dem Cache gelöscht.

Daten offline abfragen

Firebase Realtime Database speichert Daten, die von einer Abfrage zurückgegeben werden, für die Offlinenutzung. Bei Abfragen, die im Offlinemodus erstellt werden, funktioniert die Firebase Realtime Database weiterhin für zuvor geladene Daten. Wenn die angeforderten Daten nicht geladen wurden, lädt der Firebase Realtime Database Daten aus dem lokalen Cache. Sobald die Netzwerkverbindung wieder verfügbar ist, werden die Daten geladen und die Abfrage wird ausgeführt.

Mit diesem Code werden beispielsweise die letzten vier Elemente in einer Firebase Realtime Database von Punktzahlen 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}")
    }

    // ...
})

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

    // ...
})

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 mithilfe des persistenten Cache „child added“-Ereignisse für die beiden Dinosaurier mit der höchsten Punktzahl aus. Es wird jedoch kein „value“-Ereignis ausgelöst, da die App diese Abfrage noch nie im Onlinemodus ausgeführt hat.

Wenn die App im Offlinemodus die letzten sechs Elemente anfordert, erhält sie sofort „child added“-Ereignisse 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 erhält die letzten beiden „child_added“- und „value“-Ereignisse für die App.

Offline-Transaktionen 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

In Echtzeitanwendungen ist es oft nützlich, zu erkennen, wenn Clients eine Verbindung herstellen und trennen. Beispielsweise können Sie einen Nutzer als „offline“ markieren, wenn die Verbindung zu seinem Client getrennt wird.

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

Hier ist ein einfaches Beispiel für das Schreiben von Daten bei einer Verbindungsunterbrechung mit dem Primitiv onDisconnect:

Kotlin

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 der Vorgang 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 zu einem beliebigen Zeitpunkt unterbrochen oder vom Realtime Database-Client aktiv 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 zu prüfen, ob die onDisconnect korrekt angehängt wurde:

Kotlin

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() abgebrochen werden:

Kotlin

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 wird erkannt

Für viele präsenzbezogene Funktionen ist es nützlich, wenn deine 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

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 der Wert vom Status des Clients abhängt. Mit anderen Worten: Wenn ein Client /.info/connected als „false“ liest, ist dies 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 Schreib- oder onDisconnect-Vorgänge hat und nicht explizit durch die Methode goOffline getrennt wird, schließt Firebase die Verbindung nach 60 Sekunden Inaktivität.

Latenz verarbeiten

Serverzeitstempel

Die Firebase Realtime Database-Server bieten einen Mechanismus zum Einfügen von Zeitstempeln, die auf dem Server als Daten generiert werden. Diese Funktion bietet in Kombination mit onDisconnect eine einfache Möglichkeit, den Zeitpunkt, zu dem die Verbindung eines Realtime Database-Clients getrennt wurde, zuverlässig zu erfassen:

Kotlin

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

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 Zeitabweichung des Clients in Bezug auf die Server von 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 der 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. Er ist daher vor allem nützlich, um große Abweichungen (> 1 Sekunde) bei 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")
    }
})

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 die Anwesenheitserkennung

Wenn Sie Trennungsvorgänge mit der Überwachung des Verbindungsstatus und Serverzeitstempeln kombinieren, 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 oder nicht. Clients setzen diesen Standort auf „true“, wenn sie online gehen, und auf einen Zeitstempel, wenn sie die Verbindung trennen. Dieser Zeitstempel gibt an, wann der Nutzer zuletzt online war.

Beachten Sie, dass Ihre App die Trennungsvorgänge in die Warteschlange stellen sollte, bevor ein Nutzer als online markiert wird. So vermeiden Sie Race-Bedingungen, falls die Netzwerkverbindung des Clients unterbrochen wird, bevor beide Befehle an den Server gesendet werden können.

Hier ist ein einfaches System zur Anwesenheitserkennung:

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

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