Офлайн-функции на платформах Apple

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

Сохранение данных на диске

Приложения Firebase автоматически обрабатывают временные перебои в работе сети. Данные, сохраненные в кеше, доступны в офлайн-режиме. Firebase повторно отправляет все записи, когда подключение к сети восстанавливается.

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

Чтобы включить сохранение данных на диске, достаточно добавить одну строку кода.

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
Database.database().isPersistenceEnabled = true

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
[FIRDatabase database].persistenceEnabled = YES;

Поведение при сохранении

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

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

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

Как поддерживать актуальность данных

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

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
let scoresRef = Database.database().reference(withPath: "scores")
scoresRef.keepSynced(true)

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
FIRDatabaseReference *scoresRef = [[FIRDatabase database] referenceWithPath:@"scores"];
[scoresRef keepSynced:YES];

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

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
scoresRef.keepSynced(false)

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
[scoresRef keepSynced:NO];

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

Как запрашивать данные в офлайн-режиме

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

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

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
let scoresRef = Database.database().reference(withPath: "scores")
scoresRef.queryOrderedByValue().queryLimited(toLast: 4).observe(.childAdded) { snapshot in
  print("The \(snapshot.key) dinosaur's score is \(snapshot.value ?? "null")")
}

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
FIRDatabaseReference *scoresRef = [[FIRDatabase database] referenceWithPath:@"scores"];
[[[scoresRef queryOrderedByValue] queryLimitedToLast:4]
    observeEventType:FIRDataEventTypeChildAdded withBlock:^(FIRDataSnapshot *snapshot) {
      NSLog(@"The %@ dinosaur's score is %@", snapshot.key, snapshot.value);
    }];

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

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
scoresRef.queryOrderedByValue().queryLimited(toLast: 2).observe(.childAdded) { snapshot in
  print("The \(snapshot.key) dinosaur's score is \(snapshot.value ?? "null")")
}

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
[[[scoresRef queryOrderedByValue] queryLimitedToLast:2]
    observeEventType:FIRDataEventTypeChildAdded withBlock:^(FIRDataSnapshot *snapshot) {
      NSLog(@"The %@ dinosaur's score is %@", snapshot.key, snapshot.value);
    }];

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

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

Как обрабатывать транзакции офлайн

Все транзакции, выполненные в офлайн-режиме, добавляются в очередь. Как только приложение снова подключится к сети, транзакции будут отправлены на сервер Realtime Database.

Как управлять статусом присутствия

В приложениях, работающих в реальном времени, часто бывает полезно определять, когда клиенты подключаются и отключаются. Например, вы можете пометить пользователя как "офлайн", когда его клиент отключается.

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

Ниже приведен простой пример записи данных при отключении с помощью примитива onDisconnect:

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
let presenceRef = Database.database().reference(withPath: "disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnectSetValue("I disconnected!")

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
FIRDatabaseReference *presenceRef = [[FIRDatabase database] referenceWithPath:@"disconnectmessage"];
// Write a string when this client loses connection
[presenceRef onDisconnectSetValue:@"I disconnected!"];

Как работает функция onDisconnect

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

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

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
presenceRef.onDisconnectRemoveValue { error, reference in
  if let error = error {
    print("Could not establish onDisconnect event: \(error)")
  }
}

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
[presenceRef onDisconnectRemoveValueWithCompletionBlock:^(NSError *error, FIRDatabaseReference *reference) {
  if (error != nil) {
    NSLog(@"Could not establish onDisconnect event: %@", error);
  }
}];

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

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
presenceRef.onDisconnectSetValue("I disconnected")
// some time later when we change our minds
presenceRef.cancelDisconnectOperations()

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
[presenceRef onDisconnectSetValue:@"I disconnected"];
// some time later when we change our minds
[presenceRef cancelDisconnectOperations];

Как определить состояние подключения

Для многих функций, связанных с присутствием, приложению полезно знать, когда оно находится в сети, а когда нет. Firebase Realtime Database предоставляет специальное местоположение /.info/connected, которое обновляется каждый раз, когда меняется состояние подключения клиента Firebase Realtime Database. Пример:

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
let connectedRef = Database.database().reference(withPath: ".info/connected")
connectedRef.observe(.value, with: { snapshot in
  if snapshot.value as? Bool ?? false {
    print("Connected")
  } else {
    print("Not connected")
  }
})

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
FIRDatabaseReference *connectedRef = [[FIRDatabase database] referenceWithPath:@".info/connected"];
[connectedRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) {
  if([snapshot.value boolValue]) {
    NSLog(@"connected");
  } else {
    NSLog(@"not connected");
  }
}];

/.info/connected – это логическое значение, которое не синхронизируется между клиентами Realtime Database, поскольку зависит от состояния клиента. Другими словами, если один клиент считает значение /.info/connected ложным, это не гарантирует, что другой клиент также считает его ложным.

Задержка при обработке

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

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

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
let userLastOnlineRef = Database.database().reference(withPath: "users/morgan/lastOnline")
userLastOnlineRef.onDisconnectSetValue(ServerValue.timestamp())

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
FIRDatabaseReference *userLastOnlineRef = [[FIRDatabase database] referenceWithPath:@"users/morgan/lastOnline"];
[userLastOnlineRef onDisconnectSetValue:[FIRServerValue timestamp]];

Несоответствие тактовых импульсов

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

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
let offsetRef = Database.database().reference(withPath: ".info/serverTimeOffset")
offsetRef.observe(.value, with: { snapshot in
  if let offset = snapshot.value as? TimeInterval {
    print("Estimated server time in milliseconds: \(Date().timeIntervalSince1970 * 1000 + offset)")
  }
})

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
FIRDatabaseReference *offsetRef = [[FIRDatabase database] referenceWithPath:@".info/serverTimeOffset"];
[offsetRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) {
  NSTimeInterval offset = [(NSNumber *)snapshot.value doubleValue];
  NSTimeInterval estimatedServerTimeMs = [[NSDate date] timeIntervalSince1970] * 1000.0 + offset;
  NSLog(@"Estimated server time: %0.3f", estimatedServerTimeMs);
}];

Пример приложения для определения присутствия

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

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

Вот пример простой системы обнаружения присутствия пользователя:

Swift

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
// 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
let myConnectionsRef = Database.database().reference(withPath: "users/morgan/connections")

// stores the timestamp of my last disconnect (the last time I was seen online)
let lastOnlineRef = Database.database().reference(withPath: "users/morgan/lastOnline")

let connectedRef = Database.database().reference(withPath: ".info/connected")

connectedRef.observe(.value, with: { snapshot in
  // only handle connection established (or I've reconnected after a loss of connection)
  guard snapshot.value as? Bool ?? false else { return }

  // add this device to my connections list
  let con = myConnectionsRef.childByAutoId()

  // when this device disconnects, remove it.
  con.onDisconnectRemoveValue()

  // The onDisconnect() call is before the call to set() itself. This is to avoid a race condition
  // where you set the user's presence to true and the client disconnects before the
  // onDisconnect() operation takes effect, leaving a ghost user.

  // this value could contain info about the device or a timestamp instead of just true
  con.setValue(true)

  // when I disconnect, update the last time I was seen online
  lastOnlineRef.onDisconnectSetValue(ServerValue.timestamp())
})

Objective-C

Примечание. Этот продукт Firebase недоступен для целевого приложения App Clip. 
// 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
FIRDatabaseReference *myConnectionsRef = [[FIRDatabase database] referenceWithPath:@"users/morgan/connections"];

// stores the timestamp of my last disconnect (the last time I was seen online)
FIRDatabaseReference *lastOnlineRef = [[FIRDatabase database] referenceWithPath:@"users/morgan/lastOnline"];

FIRDatabaseReference *connectedRef = [[FIRDatabase database] referenceWithPath:@".info/connected"];
[connectedRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) {
  if([snapshot.value boolValue]) {
    // connection established (or I've reconnected after a loss of connection)

    // add this device to my connections list
    FIRDatabaseReference *con = [myConnectionsRef childByAutoId];

    // when this device disconnects, remove it
    [con onDisconnectRemoveValue];

    // The onDisconnect() call is before the call to set() itself. This is to avoid a race condition
    // where you set the user's presence to true and the client disconnects before the
    // onDisconnect() operation takes effect, leaving a ghost user.

    // this value could contain info about the device or a timestamp instead of just true
    [con setValue:@YES];


    // when I disconnect, update the last time I was seen online
    [lastOnlineRef onDisconnectSetValue:[FIRServerValue timestamp]];
  }
}];