Получение данных с помощью базы данных Firebase Realtime для C++

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

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

Прежде чем вы начнете

Убедитесь, что вы настроили свое приложение и можете получить доступ к базе данных, как описано в руководстве по Get Started .

Получение данных

Данные Firebase извлекаются либо однократным вызовом GetValue() , либо присоединением к ValueListener по ссылке FirebaseDatabase . Слушатель значения вызывается один раз для начального состояния данных и снова при каждом изменении данных.

Получить ссылку на базу данных

Чтобы записать данные в базу данных, вам нужен экземпляр DatabaseReference :

    // Get the root reference location of the database.
    firebase::database::DatabaseReference dbref = database->GetReference();

Прочитать данные один раз

Вы можете использовать метод GetValue() для однократного чтения статического снимка содержимого по заданному пути. Результат задачи будет содержать моментальный снимок, содержащий все данные в этом месте, включая дочерние данные. Если данных нет, возвращаемый снимок имеет значение null .

  firebase::Future<firebase::database::DataSnapshot> result =
    dbRef.GetReference("Leaders").GetValue();

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

  // In the game loop that polls for the result...

  if (result.status() != firebase::kFutureStatusPending) {
    if (result.status() != firebase::kFutureStatusComplete) {
      LogMessage("ERROR: GetValue() returned an invalid result.");
      // Handle the error...
    } else if (result.error() != firebase::database::kErrorNone) {
      LogMessage("ERROR: GetValue() returned error %d: %s", result.error(),
                 result.error_message());
      // Handle the error...
    } else {
      firebase::database::DataSnapshot snapshot = result.result();
      // Do something with the snapshot...
    }
  }

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

Слушайте события

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

Базовый класс ValueListener

Перезвонить Типичное использование
OnValueChanged Чтение и прослушивание изменений всего содержимого пути.

Базовый класс OnChildListener

OnChildAdded Получить списки элементов или прослушивать дополнения к списку элементов. Рекомендуется использовать с OnChildChanged и OnChildRemoved для отслеживания изменений в списках.
OnChildChanged Прислушивайтесь к изменениям элементов в списке. Используйте с OnChildAdded и OnChildRemoved для отслеживания изменений в списках.
OnChildRemoved Прослушивание элементов, удаляемых из списка. Используйте с OnChildAdded и OnChildChanged для отслеживания изменений в списках.
OnChildMoved Прислушивайтесь к изменениям порядка элементов в упорядоченном списке. Обратные вызовы OnChildMoved всегда следуют за обратными вызовами OnChildChanged из-за изменения порядка элемента (на основе вашего текущего метода упорядочения).

Класс ValueListener

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

В следующем примере демонстрируется игра, извлекающая результаты таблицы лидеров из базы данных:

  class LeadersValueListener : public firebase::database::ValueListener {
   public:
    void OnValueChanged(
        const firebase::database::DataSnapshot& snapshot) override {
      // Do something with the data in snapshot...
    }
    void OnCancelled(const firebase::database::Error& error_code,
                     const char* error_message) override {
      LogMessage("ERROR: LeadersValueListener canceled: %d: %s", error_code,
                 error_message);
    }
  };

  // Elsewhere in the code...

  LeadersValueListener* listener = new LeadersValueListener();
  firebase::Future<firebase::database::DataSnapshot> result =
    dbRef.GetReference("Leaders").AddValueListener(listener);

Результат Future&ltDataSnaphot&gt содержит данные в указанном месте базы данных на момент события. Вызов value() моментального снимка возвращает Variant , представляющий данные.

В этом примере метод OnCancelled также переопределяется, чтобы увидеть, отменено ли чтение. Например, чтение может быть отменено, если у клиента нет разрешения на чтение из базы данных Firebase. database::Error укажет, почему произошел сбой.

Класс ChildListener

Дочерние события запускаются в ответ на определенные операции, которые происходят с дочерними элементами узла в результате операции, такой как добавление нового дочернего элемента с помощью метода PushChild() или обновление дочернего элемента с помощью метода UpdateChildren() . Каждый из них вместе может быть полезен для прослушивания изменений в конкретном узле в базе данных. Например, игра может использовать эти методы вместе для отслеживания активности в комментариях игрового сеанса, как показано ниже:

  class SessionCommentsChildListener : public firebase::database::ChildListener {
   public:
    void OnChildAdded(const firebase::database::DataSnapshot& snapshot,
                      const char* previous_sibling) override {
      // Do something with the data in snapshot ...
    }
    void OnChildChanged(const firebase::database::DataSnapshot& snapshot,
                        const char* previous_sibling) override {
      // Do something with the data in snapshot ...
    }
    void OnChildRemoved(
        const firebase::database::DataSnapshot& snapshot) override {
      // Do something with the data in snapshot ...
    }
    void OnChildMoved(const firebase::database::DataSnapshot& snapshot,
                      const char* previous_sibling) override {
      // Do something with the data in snapshot ...
    }
    void OnCancelled(const firebase::database::Error& error_code,
                     const char* error_message) override {
      LogMessage("ERROR: SessionCommentsChildListener canceled: %d: %s",
                 error_code, error_message);
    }
  };

  // elsewhere ....

  SessionCommentsChildListener* listener = new SessionCommentsChildListener();
  firebase::Future<firebase::database::DataSnapshot> result =
    dbRef.GetReference("GameSessionComments").AddChildListener(listener);

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

Обратный вызов OnChildChanged вызывается каждый раз при изменении дочернего узла. Сюда входят любые модификации потомков дочернего узла. Обычно он используется в сочетании с OnChildAdded и OnChildRemoved для ответа на изменения в списке элементов. Моментальный снимок, переданный прослушивателю, содержит обновленные данные для дочернего элемента.

Обратный вызов OnChildRemoved запускается при удалении непосредственного дочернего элемента. Обычно он используется в сочетании с обратными вызовами OnChildAdded и OnChildChanged . Моментальный снимок, переданный обратному вызову, содержит данные для удаленного дочернего элемента.

Обратный вызов OnChildMoved инициируется всякий раз, когда вызов OnChildChanged вызывается обновлением, вызывающим изменение порядка дочерних элементов. Он используется с данными, упорядоченными с помощью OrderByChild или OrderByValue .

Сортировка и фильтрация данных

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

Сортировать данные

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

Метод Применение
OrderByChild() Упорядочить результаты по значению указанного дочернего ключа.
OrderByKey() Упорядочить результаты по дочерним ключам.
OrderByValue() Упорядочить результаты по дочерним значениям.

Вы можете использовать только один метод заказа за раз. Многократный вызов метода упорядочивания в одном и том же запросе приводит к ошибке.

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

  firebase::database::Query query =
    dbRef.GetReference("Leaders").OrderByChild("score");

  // To get the resulting DataSnapshot either use query.GetValue() and poll the
  // future, or use query.AddValueListener() and register to handle the
  // OnValueChanged callback.

Это определяет firebase::Query , который в сочетании с ValueListener синхронизирует клиент с таблицей лидеров в базе данных, упорядоченной по количеству очков каждой записи. Подробнее об эффективном структурировании данных можно прочитать в статье «Структурируйте базу данных ».

Вызов метода OrderByChild() указывает дочерний ключ, по которому упорядочиваются результаты. В этом случае результаты сортируются по значению "score" в каждом дочернем элементе. Дополнительные сведения о том, как упорядочиваются другие типы данных, см. в разделе Упорядочивание данных запроса .

Фильтрация данных

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

Метод Применение
LimitToFirst() Устанавливает максимальное количество элементов, возвращаемых с начала упорядоченного списка результатов.
LimitToLast() Устанавливает максимальное количество элементов, возвращаемых с конца упорядоченного списка результатов.
StartAt() Возвращает элементы, большие или равные указанному ключу или значению, в зависимости от выбранного метода упорядочения.
EndAt() Возвращает элементы, меньшие или равные указанному ключу или значению, в зависимости от выбранного метода упорядочения.
EqualTo() Возвращает элементы, равные указанному ключу или значению, в зависимости от выбранного метода упорядочения.

В отличие от методов упорядочения, вы можете комбинировать несколько функций ограничения или диапазона. Например, вы можете комбинировать StartAt() и EndAt() , чтобы ограничить результаты указанным диапазоном значений.

Даже если для запроса имеется только одно совпадение, снимок все равно представляет собой список; он просто содержит один элемент.

Ограничьте количество результатов

Вы можете использовать LimitToFirst() и LimitToLast() , чтобы установить максимальное количество дочерних элементов, которые будут синхронизированы для данного обратного вызова. Например, если вы используете LimitToFirst() для установки предела в 100, вы изначально получаете только до 100 обратных вызовов OnChildAdded . Если в вашей базе данных Firebase хранится менее 100 элементов, для каждого элемента срабатывает обратный вызов OnChildAdded .

По мере изменения элементов вы получаете обратные вызовы OnChildAdded для элементов, которые входят в запрос, и обратные вызовы OnChildRemoved для элементов, которые выпадают из него, так что общее число остается равным 100.

Например, приведенный ниже код возвращает высший балл из таблицы лидеров:

  firebase::database::Query query =
    dbRef.GetReference("Leaders").OrderByChild("score").LimitToLast(1);

  // To get the resulting DataSnapshot either use query.GetValue() and poll the
  // future, or use query.AddValueListener() and register to handle the
  // OnValueChanged callback.

Фильтровать по ключу или значению

Вы можете использовать StartAt() , EndAt() и EqualTo() для выбора произвольной начальной, конечной точки и точки эквивалентности для запросов. Это может быть полезно для разбиения данных на страницы или поиска элементов с дочерними элементами, имеющими определенное значение.

Как упорядочиваются данные запроса

В этом разделе объясняется, как данные сортируются каждым из методов упорядочивания в классе Query .

OrderByChild

При использовании OrderByChild() данные, содержащие указанный дочерний ключ, упорядочиваются следующим образом:

  1. Дети с null значением для указанного дочернего ключа идут первыми.
  2. Далее идут дочерние элементы со значением false для указанного дочернего ключа. Если несколько дочерних элементов имеют значение false , они лексикографически сортируются по ключу.
  3. Далее идут дочерние элементы со значением true для указанного дочернего ключа. Если несколько дочерних элементов имеют значение true , они лексикографически сортируются по ключу.
  4. Далее идут дети с числовым значением, отсортированные в порядке возрастания. Если несколько дочерних элементов имеют одинаковое числовое значение для указанного дочернего узла, они сортируются по ключу.
  5. Строки идут после чисел и сортируются лексикографически в порядке возрастания. Если несколько потомков имеют одинаковое значение для указанного дочернего узла, они лексикографически упорядочиваются по ключу.
  6. Объекты идут последними и лексикографически сортируются по ключу в порядке возрастания.

OrderByKey

При использовании OrderByKey() для сортировки данных данные возвращаются в порядке возрастания по ключу.

  1. Дети с ключом, который может быть проанализирован как 32-битное целое число, идут первыми, отсортированные в порядке возрастания.
  2. Далее идут дочерние элементы со строковым значением в качестве ключа, отсортированные лексикографически в порядке возрастания.

OrderByValue

При использовании OrderByValue() дочерние элементы упорядочиваются по их значению. Критерии упорядочивания такие же, как в OrderByChild() , за исключением того, что значение узла используется вместо значения указанного дочернего ключа.

Следующие шаги