Включение автономных возможностей на Android

Стойкое поведение

При включении сохранения любые данные, которые клиент базы данных Firebase Realtime будет синхронизировать в онлайн-режиме, сохраняются на диске и доступны в автономном режиме, даже когда пользователь или операционная система перезапускают приложение. Это означает, что ваше приложение работает так же, как и в сети, используя локальные данные, хранящиеся в кеше. Обратные вызовы прослушивателя будут продолжать срабатывать для локальных обновлений.

Клиент базы данных Firebase Realtime автоматически сохраняет очередь всех операций записи, которые выполняются, когда ваше приложение находится в автономном режиме. Когда постоянство включено, эта очередь также сохраняется на диске, поэтому все ваши записи доступны, когда пользователь или операционная система перезапускает приложение. Когда приложение восстанавливает подключение, все операции отправляются на сервер базы данных Firebase Realtime.

Если ваше приложение использует Firebase Authentication , клиент Firebase Realtime Database сохраняет токен аутентификации пользователя при перезапуске приложения. Если срок действия токена аутентификации истекает, когда ваше приложение находится в автономном режиме, клиент приостанавливает операции записи до тех пор, пока ваше приложение не выполнит повторную аутентификацию пользователя, в противном случае операции записи могут завершиться ошибкой из-за правил безопасности.

Сохранение данных в актуальном состоянии

База данных Firebase Realtime синхронизирует и сохраняет локальную копию данных для активных слушателей. Кроме того, вы можете синхронизировать определенные местоположения.

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

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

Клиент базы данных Firebase Realtime автоматически загружает данные из этих мест и поддерживает их синхронизацию, даже если ссылка не имеет активных слушателей. Вы можете отключить синхронизацию с помощью следующей строки кода.

scoresRef.keepSynced(false)
OfflineActivity.kt

scoresRef.keepSynced(false);
OfflineActivity.java

По умолчанию кэшируются 10 МБ ранее синхронизированных данных. Этого должно быть достаточно для большинства приложений. Если кеш превышает установленный размер, база данных Firebase Realtime очищает данные, которые использовались последними. Данные, которые синхронизируются, не удаляются из кэша.

Запрос данных в автономном режиме

База данных Firebase Realtime хранит данные, возвращенные из запроса, для использования в автономном режиме. Для запросов, созданных в автономном режиме, база данных Firebase Realtime продолжает работать с ранее загруженными данными. Если запрошенные данные не загружены, база данных Firebase Realtime загружает данные из локального кеша. Когда подключение к сети снова станет доступным, данные загрузятся и будут отражать запрос.

Например, этот код запрашивает последние четыре элемента в базе данных Firebase Realtime с оценками.

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

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

Предположим, что пользователь теряет соединение, уходит в автономный режим и перезапускает приложение. Находясь в автономном режиме, приложение запрашивает последние два элемента из одного и того же местоположения. Этот запрос успешно вернет два последних элемента, поскольку приложение загрузило все четыре элемента в приведенном выше запросе.

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

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

В предыдущем примере клиент базы данных Firebase Realtime создает события «добавлены дочерние элементы» для двух динозавров с наибольшим количеством очков, используя постоянный кэш. Но это не приведет к событию «значение», поскольку приложение никогда не выполняло этот запрос в режиме онлайн.

Если бы приложение запрашивало последние шесть элементов в автономном режиме, оно сразу же получало бы события «дочерний элемент» для четырех кэшированных элементов. Когда устройство снова подключается к сети, клиент базы данных Firebase Realtime Database синхронизируется с сервером и получает последние два события «дочерний элемент» и «значение» для приложения.

Обработка транзакций в автономном режиме

Любые транзакции, которые выполняются, когда приложение находится в автономном режиме, ставятся в очередь. Как только приложение восстанавливает подключение к сети, транзакции отправляются на сервер базы данных реального времени.

Как работает onDisconnect

Когда вы устанавливаете операцию onDisconnect() , операция выполняется на сервере базы данных Firebase Realtime. Сервер проверяет безопасность, чтобы убедиться, что пользователь может выполнить запрошенное событие записи, и сообщает вашему приложению, если оно недействительно. Затем сервер отслеживает соединение. Если в какой-то момент время ожидания соединения истекло или оно было активно закрыто клиентом базы данных реального времени, сервер проверяет безопасность во второй раз (чтобы убедиться, что операция все еще действительна), а затем вызывает событие.

Ваше приложение может использовать обратный вызов операции записи, чтобы убедиться, что onDisconnect был правильно подключен:

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

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

Событие onDisconnect также можно отменить, вызвав .cancel() :

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

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

Временные метки сервера

Серверы базы данных Firebase Realtime предоставляют механизм для вставки временных меток, сгенерированных на сервере, в качестве данных. Эта функция в сочетании с onDisconnect обеспечивает простой способ достоверно отметить время, когда клиент базы данных реального времени отключился:

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

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

Перекос часов

Хотя firebase.database.ServerValue.TIMESTAMP намного точнее и предпочтительнее для большинства операций чтения/записи, иногда может быть полезно оценить сдвиг часов клиента по отношению к серверам базы данных Firebase Realtime. Вы можете прикрепить обратный вызов к местоположению /.info/serverTimeOffset , чтобы получить значение в миллисекундах, которое клиенты базы данных Firebase Realtime добавляют к локальному сообщаемому времени (время эпохи в миллисекундах) для оценки времени сервера. Обратите внимание, что на точность этого смещения может влиять сетевая задержка, поэтому оно полезно в первую очередь для обнаружения больших (> 1 секунды) расхождений во времени.

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

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