Włączanie funkcji offline na urządzeniach z Androidem

Aplikacje Firebase działają nawet wtedy, gdy aplikacja tymczasowo utraci połączenie sieciowe. Dodatkowo Firebase udostępnia narzędzia do zachowywania danych lokalnie, zarządzania obecnością i obsługi opóźnień.

Trwałość dysku

Aplikacje Firebase automatycznie obsługują tymczasowe przerwy w działaniu sieci. Dane w pamięci podręcznej są dostępne w trybie offline, a Firebase ponownie wysyła wszystkie zapisy po przywróceniu połączenia z siecią.

Gdy włączysz trwałość dysku, aplikacja zapisuje dane lokalnie na urządzeniu, dzięki czemu aplikacja może utrzymywać stan w trybie offline, nawet jeśli użytkownik lub system operacyjny ponownie uruchomi aplikację.

Trwałość dysku możesz włączyć za pomocą jednego wiersza kodu.

Kotlin+KTX

Firebase.database.setPersistenceEnabled(true)
OfflineActivity.kt

Java

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

Zachowanie trwałości

Jeśli włączysz trwałość, wszystkie dane, które klient Bazy danych czasu rzeczywistego Firebase będą synchronizowane, gdy będą w trybie online, pozostaną na dysku i będą dostępne offline, nawet gdy użytkownik lub system operacyjny ponownie uruchomi aplikację. Oznacza to, że aplikacja będzie działać tak samo jak w trybie online, używając lokalnych danych przechowywanych w pamięci podręcznej. Wywołania zwrotne detektora będą nadal uruchamiane w przypadku aktualizacji lokalnych.

Klient Bazy danych czasu rzeczywistego Firebase automatycznie przechowuje kolejkę wszystkich operacji zapisu wykonywanych, gdy aplikacja jest offline. Gdy trwałość jest włączona, kolejka jest również zachowywana na dysku, dzięki czemu wszystkie zapisy są dostępne po ponownym uruchomieniu aplikacji przez użytkownika lub system operacyjny. Gdy aplikacja odzyska połączenie, wszystkie operacje są wysyłane na serwer Bazy danych czasu rzeczywistego Firebase.

Jeśli Twoja aplikacja korzysta z uwierzytelniania Firebase, klient Bazy danych czasu rzeczywistego Firebase będzie utrzymywać token uwierzytelniania użytkownika po każdym ponownym uruchomieniu aplikacji. Jeśli token uwierzytelniania wygaśnie, gdy aplikacja będzie w trybie offline, klient wstrzyma operacje zapisu do czasu ponownego uwierzytelnienia użytkownika w aplikacji. W przeciwnym razie operacje zapisu mogą się nie powieść ze względu na reguły zabezpieczeń.

Dbanie o aktualność danych

Baza danych czasu rzeczywistego Firebase synchronizuje i przechowuje lokalną kopię danych dla aktywnych detektorów. Dodatkowo możesz synchronizować określone lokalizacje.

Kotlin+KTX

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

Java

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

Klient Bazy danych czasu rzeczywistego Firebase automatycznie pobiera dane z tych lokalizacji i synchronizuje je, nawet jeśli plik referencyjny nie ma aktywnych detektorów. Synchronizację możesz wyłączyć z powrotem, korzystając z następującego wiersza kodu.

Kotlin+KTX

scoresRef.keepSynced(false)
OfflineActivity.kt

Java

scoresRef.keepSynced(false);
OfflineActivity.java

Domyślnie w pamięci podręcznej przechowywane jest 10 MB wcześniej zsynchronizowanych danych. To powinno wystarczyć w większości aplikacji. Jeśli pamięć podręczna przekroczy skonfigurowany rozmiar, Baza danych czasu rzeczywistego Firebase trwale usunie dane, które były ostatnio używane. Zsynchronizowane dane nie są trwale usuwane z pamięci podręcznej.

Wysyłanie zapytań o dane offline

Baza danych czasu rzeczywistego Firebase przechowuje dane zwrócone z zapytania do użytku w trybie offline. W przypadku zapytań utworzonych w trybie offline Baza danych czasu rzeczywistego Firebase działa z danymi wczytywanymi wcześniej. Jeśli żądane dane nie zostały wczytane, Baza danych czasu rzeczywistego Firebase wczytuje dane z lokalnej pamięci podręcznej. Gdy połączenie sieciowe będzie ponownie dostępne, dane wczytają się i będą odzwierciedlały zapytanie.

Na przykład ten kod wysyła zapytania dotyczące ostatnich 4 elementów w Bazie danych czasu rzeczywistego Firebase z wynikami

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

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

Załóżmy, że użytkownik traci połączenie, przechodzi w tryb offline i ponownie uruchamia aplikację. Gdy nadal jesteś offline, aplikacja wysyła zapytanie o ostatnie 2 elementy z tego samego miejsca. To zapytanie zwróci ostatnie 2 elementy, ponieważ aplikacja wczytała wszystkie 4 elementy z powyższego zapytania.

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

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

W poprzednim przykładzie klient Bazy danych czasu rzeczywistego Firebase generuje zdarzenia „dodane przez dziecko” w przypadku najwyżej punktowanych 2 dinozaurów, używając zapisanej pamięci podręcznej. Nie spowoduje to jednak wywołania zdarzenia „value”, ponieważ aplikacja nigdy nie wykonała tego zapytania w trybie online.

Jeśli aplikacja poprosi o ostatnie 6 elementów w trybie offline, otrzyma od razu zdarzenia „dodane przez wydawcę” dla tych 4 elementów w pamięci podręcznej. Gdy urządzenie znów będzie online, klient Bazy danych czasu rzeczywistego Firebase zsynchronizuje się z serwerem i pobierze 2 ostatnie zdarzenia „dodano element podrzędny” i „wartość” aplikacji.

Obsługa transakcji offline

Wszystkie transakcje wykonane, gdy aplikacja jest offline, są umieszczane w kolejce. Gdy aplikacja odzyska połączenie sieciowe, transakcje są wysyłane do serwera Bazy danych czasu rzeczywistego.

Transakcje nie są zachowywane po ponownym uruchomieniu aplikacji

Nawet jeśli włączona jest trwałość, transakcje nie są zachowywane po ponownym uruchomieniu aplikacji. Dlatego nie możesz polegać na transakcjach wykonywanych offline w Bazie danych czasu rzeczywistego Firebase. Ze względu na wygodę użytkowników aplikacja powinna wyświetlać informację, że transakcja nie została jeszcze zapisana w Bazie danych czasu rzeczywistego Firebase, lub sprawdzić, czy aplikacja zapamiętuje je ręcznie i wykonuje je ponownie po ponownym uruchomieniu.

Baza danych czasu rzeczywistego Firebase ma wiele funkcji do obsługi scenariuszy offline i połączeń sieciowych. Pozostała część tego przewodnika dotyczy Twojej aplikacji niezależnie od tego, czy masz włączoną trwałość.

Zarządzanie obecnością

W aplikacjach działających w czasie rzeczywistym często przydaje się możliwość wykrywania, kiedy klienty łączą się i rozłączają. Możesz na przykład oznaczyć użytkownika jako użytkownika offline, gdy jego klient się rozłączy.

Klienty bazy danych Firebase udostępniają proste elementy podstawowe, których można używać do zapisywania w bazie danych, gdy klient odłączy się od serwerów bazy danych Firebase. Aktualizacje te są przeprowadzane niezależnie od tego, czy klient się rozłącza, czy też nie. Dzięki temu możesz mieć pewność, że dane zostaną wyczyszczone nawet w przypadku utraty połączenia lub awarii klienta. Wszystkie operacje zapisu, w tym ustawianie, aktualizowanie i usuwanie, mogą być wykonywane po odłączeniu.

Oto prosty przykład zapisywania danych po odłączeniu za pomocą elementu podstawowego onDisconnect:

Kotlin+KTX

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

Jak onOdłącz działa?

Gdy utworzysz operację onDisconnect(), będzie ona działać na serwerze Bazy danych czasu rzeczywistego Firebase. Serwer sprawdza zabezpieczenia, by upewnić się, że użytkownik może wykonać żądane zdarzenie zapisu, i informuje aplikację, jeśli to zdarzenie jest nieprawidłowe. Serwer będzie monitorować połączenie. Jeśli w którymkolwiek momencie połączenie zostanie przekroczone lub zostanie aktywnie zamknięte przez klienta Bazy danych czasu rzeczywistego, serwer jeszcze raz sprawdzi zabezpieczenia (aby upewnić się, że operacja jest nadal prawidłowa), a następnie wywoła zdarzenie.

Aplikacja może używać wywołania zwrotnego podczas zapisu, aby sprawdzić, czy onDisconnect został prawidłowo podłączony:

Kotlin+KTX

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

Wydarzenie onDisconnect można też anulować, dzwoniąc pod numer .cancel():

Kotlin+KTX

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

Wykrywam stan połączenia

W przypadku wielu funkcji związanych z obecnością aplikacja może wiedzieć, czy jest online czy offline. Baza danych czasu rzeczywistego Firebase udostępnia specjalną lokalizację pod adresem /.info/connected, która jest aktualizowana za każdym razem, gdy zmienia się stan połączenia klienta Bazy danych czasu rzeczywistego Firebase. Oto przykład:

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")
    }
})
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 to wartość logiczna, która nie jest synchronizowana między klientami Bazy danych czasu rzeczywistego, ponieważ zależy od stanu klienta. Inaczej mówiąc, jeśli jeden klient odczyta /.info/connected jako fałsz, nie ma gwarancji, że inny klient również odczyta ten parametr.

Firebase na Androidzie automatycznie zarządza stanem połączenia, aby zmniejszać przepustowość i wykorzystanie baterii. Jeśli klient nie ma aktywnych detektorów, nie ma oczekujących operacji zapisu ani operacji onDisconnect ani nie został wyraźnie rozłączony przez metodę goOffline, Firebase zamyka połączenie po 60 sekundach braku aktywności.

Czas oczekiwania na obsługę

Sygnatury czasowe serwera

Serwery Bazy danych czasu rzeczywistego Firebase udostępniają mechanizm wstawiania sygnatur czasowych wygenerowanych na serwerze jako dane. Ta funkcja w połączeniu z funkcją onDisconnect pozwala w łatwy sposób zanotować moment, w którym klient Bazy danych czasu rzeczywistego rozłączył się:

Kotlin+KTX

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

Zniekształcenie zegara

Chociaż metoda firebase.database.ServerValue.TIMESTAMP jest znacznie dokładniejsza i zalecana w przypadku większości operacji odczytu i zapisu, czasami może się przydać do oszacowania zniekształcenia zegara klienta w odniesieniu do serwerów Bazy danych czasu rzeczywistego Firebase. Możesz dołączyć wywołanie zwrotne do lokalizacji /.info/serverTimeOffset, aby uzyskać (w milisekundach) wartość, którą klienty Bazy danych czasu rzeczywistego Firebase dodają do lokalnego czasu zgłaszanego (w milisekundach) w celu oszacowania czasu serwera. Pamiętaj, że opóźnienie sieciowe może mieć wpływ na dokładność przesunięcia, dlatego jest ono przydatne głównie przy wykrywaniu dużych (powyżej 1 sekundy) rozbieżności w czasie zegara.

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

Przykładowa aplikacja Obecność

Łącząc operacje rozłączania z monitorowaniem stanu połączenia i sygnaturami czasowymi serwera, możesz utworzyć system wykrywania obecności użytkowników. W tym systemie każdy użytkownik przechowuje dane w lokalizacji bazy danych, aby wskazać, czy klient Bazy danych czasu rzeczywistego jest online. Klienty ustawiają tę lokalizację na Prawda, gdy są online, oraz sygnaturę czasową po rozłączeniu. Ta sygnatura czasowa wskazuje, kiedy dany użytkownik ostatnio był online.

Pamiętaj, że aplikacja powinna kolejkować operacje odłączania, zanim użytkownik zostanie oznaczony jako online. Pozwoli to uniknąć wyścigów w przypadku utraty połączenia sieciowego klienta przed wysłaniem obu poleceń na serwer.

Oto prosty system wykrywania obecności użytkowników:

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