Récupérer des données avec Firebase Realtime Database pour C++

Ce document présente les principes de base de la récupération de données, ainsi que la manière de trier et de filtrer les données Firebase.

Avant de commencer

Assurez-vous d'avoir configuré votre application et de pouvoir accéder à la base de données, comme indiqué dans le guide Get Started.

Récupération des données…

Les données Firebase sont récupérées soit par un appel unique à GetValue(), soit en les associant à un ValueListener sur une référence FirebaseDatabase. L'écouteur de valeur est appelé une fois pour l'état initial des données, puis chaque fois que les données changent.

Obtenir une DatabaseReference

Pour écrire des données dans la base de données, vous avez besoin d'une instance de DatabaseReference :

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

Lire les données une fois

Vous pouvez utiliser la méthode GetValue() pour lire une seule fois un instantané statique du contenu d'un chemin d'accès donné. Le résultat de la tâche contiendra un instantané contenant toutes les données à cet emplacement, y compris les données enfants. S'il n'y a pas de données, l'instantané renvoyé est null.

  firebase::Future&ltfirebase::database::DataSnapshot&gt result =
    dbRef.GetReference("Leaders").GetValue();

À ce stade, la requête a été effectuée, mais nous devons attendre que l'objet Future soit terminé avant de pouvoir lire la valeur. Étant donné que les jeux s'exécutent généralement en boucle et sont moins axés sur les rappels que les autres applications, vous devez généralement interroger l'état d'avancement.

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

Cela montre une vérification d'erreur de base. Consultez la documentation de référence sur firebase::Future pour en savoir plus sur la vérification des erreurs et sur les moyens de déterminer quand le résultat est prêt.

Écouter les événements

Vous pouvez ajouter des écouteurs pour vous abonner aux modifications des données :

Classe de base ValueListener

Classe de base OnChildListener

Classe ValueListener

Vous pouvez utiliser les rappels OnValueChanged pour vous abonner aux modifications apportées au contenu d'un chemin d'accès donné. Ce rappel est déclenché une fois lorsque l'écouteur est associé, puis chaque fois que les données, y compris les enfants, changent. Le rappel reçoit un instantané contenant toutes les données de cet emplacement, y compris les données enfants. S'il n'y a pas de données, l'instantané renvoyé est null.

L'exemple suivant montre un jeu qui récupère les scores d'un classement dans la base de données :

  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&ltfirebase::database::DataSnapshot&gt result =
    dbRef.GetReference("Leaders").AddValueListener(listener);

Le résultat Future&ltDataSnapshot&gt contient les données à l'emplacement spécifié dans la base de données au moment de l'événement. L'appel de value() sur un instantané renvoie un Variant représentant les données.

Dans cet exemple, la méthode OnCancelled est également remplacée pour vérifier si la lecture est annulée. Par exemple, une lecture peut être annulée si le client n'est pas autorisé à lire un emplacement de base de données Firebase. Le champ database::Error indique la raison de l'échec.

Classe ChildListener

Les événements enfants sont déclenchés en réponse à des opérations spécifiques qui se produisent sur les enfants d'un nœud à partir d'une opération, par exemple l'ajout d'un enfant via la méthode PushChild() ou la mise à jour d'un enfant via la méthode UpdateChildren(). Chacun de ces éléments peut être utile pour écouter les modifications apportées à un nœud spécifique d'une base de données. Par exemple, un jeu peut utiliser ces méthodes ensemble pour surveiller l'activité dans les commentaires d'une session de jeu, comme indiqué ci-dessous :

  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&ltfirebase::database::DataSnapshot&gt result =
    dbRef.GetReference("GameSessionComments").AddChildListener(listener);

Le rappel OnChildAdded est généralement utilisé pour récupérer une liste d'éléments dans une base de données Firebase. Le rappel OnChildAdded est appelé une fois pour chaque enfant existant, puis chaque fois qu'un nouvel enfant est ajouté au chemin d'accès spécifié. L'écouteur reçoit un instantané contenant les données du nouvel enfant.

Le rappel OnChildChanged est appelé chaque fois qu'un nœud enfant est modifié. Cela inclut toutes les modifications apportées aux descendants du nœud enfant. Il est généralement utilisé conjointement avec les appels OnChildAdded et OnChildRemoved pour répondre aux modifications apportées à une liste d'éléments. L'instantané transmis à l'écouteur contient les données mises à jour pour l'enfant.

Le rappel OnChildRemoved est déclenché lorsqu'un enfant immédiat est supprimé. Il est généralement utilisé conjointement avec les rappels OnChildAdded et OnChildChanged. L'instantané transmis au rappel contient les données de l'enfant supprimé.

Le rappel OnChildMoved est déclenché chaque fois que l'appel OnChildChanged est déclenché par une mise à jour qui entraîne la réorganisation de l'enfant. Il est utilisé avec des données ordonnées avec OrderByChild ou OrderByValue.

Trier et filtrer des données

Vous pouvez utiliser la classe Realtime Database Query pour récupérer des données triées par clé, par valeur ou par valeur d'un enfant. Vous pouvez également filtrer le résultat trié sur un nombre spécifique de résultats ou sur une plage de clés ou de valeurs.

Trier les données

Pour récupérer des données triées, commencez par spécifier l'une des méthodes de tri pour déterminer l'ordre des résultats :

Vous ne pouvez utiliser qu'une seule méthode de tri à la fois. L'appel d'une méthode de tri plusieurs fois dans la même requête génère une erreur.

L'exemple suivant montre comment vous abonner à un classement ordonné par score.

  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.

Cela définit un firebase::Query qui, lorsqu'il est combiné à un ValueListener, synchronise le client avec le classement dans la base de données, trié par le score de chaque entrée. Pour en savoir plus sur la structuration efficace de vos données, consultez Structurer votre base de données.

L'appel de la méthode OrderByChild() spécifie la clé enfant selon laquelle trier les résultats. Dans ce cas, les résultats sont triés en fonction de la valeur de "score" dans chaque enfant. Pour en savoir plus sur l'ordre des autres types de données, consultez Ordre des données de requête.

Filtrer les données

Pour filtrer les données, vous pouvez combiner n'importe quelle méthode de limite ou de plage avec une méthode de tri lors de la construction d'une requête.

Contrairement aux méthodes de tri, vous pouvez combiner plusieurs fonctions de limite ou de plage. Par exemple, vous pouvez combiner les méthodes StartAt() et EndAt() pour limiter les résultats à une plage de valeurs spécifiée.

Même s'il n'y a qu'une seule correspondance pour la requête, l'instantané reste une liste, mais il ne contient qu'un seul élément.

Limiter le nombre de résultats

Vous pouvez utiliser les méthodes LimitToFirst() et LimitToLast() pour définir un nombre maximal d'enfants à synchroniser pour un rappel donné. Par exemple, si vous utilisez LimitToFirst() pour définir une limite de 100, vous ne recevez initialement que 100 rappels OnChildAdded au maximum. Si vous avez moins de 100 éléments stockés dans votre base de données Firebase, un rappel OnChildAdded se déclenche pour chaque élément.

À mesure que les éléments changent, vous recevez des rappels OnChildAdded pour les éléments qui entrent dans la requête et des rappels OnChildRemoved pour les éléments qui en sortent, de sorte que le nombre total reste à 100.

Par exemple, le code ci-dessous renvoie le meilleur score d'un classement :

  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.

Filtrer par clé ou valeur

Vous pouvez utiliser StartAt(), EndAt() et EqualTo() pour choisir des points de départ, de fin et d'équivalence arbitraires pour les requêtes. Cela peut être utile pour paginer des données ou rechercher des éléments avec des enfants ayant une valeur spécifique.

Comment les données de requête sont-elles triées ?

Cette section explique comment les données sont triées par chacune des méthodes de tri de la classe Query.

OrderByChild

Lorsque vous utilisez OrderByChild(), les données contenant la clé enfant spécifiée sont classées comme suit :

1. Les enfants ayant une valeur null pour la clé enfant spécifiée sont placés en premier.
2. Les enfants dont la valeur est false pour la clé enfant spécifiée viennent ensuite. Si plusieurs enfants ont une valeur de false, ils sont triés par ordre lexicographique par clé.
3. Les enfants dont la valeur est true pour la clé enfant spécifiée viennent ensuite. Si plusieurs enfants ont une valeur de true, ils sont triés par ordre lexicographique par clé.
4. Les enfants ayant une valeur numérique viennent ensuite, triés par ordre croissant. Si plusieurs enfants ont la même valeur numérique pour le nœud enfant spécifié, ils sont triés par clé.
5. Les chaînes viennent après les nombres et sont triées par ordre lexicographique croissant. Si plusieurs enfants ont la même valeur pour le nœud enfant spécifié, ils sont classés par ordre lexicographique par clé.
6. Les objets sont placés en dernier et sont triés par ordre lexicographique croissant par clé.

OrderByKey

Lorsque vous utilisez OrderByKey() pour trier vos données, celles-ci sont renvoyées par ordre croissant de clé.

1. Les enfants dont la clé peut être analysée en tant qu'entier 32 bits sont placés en premier, triés par ordre croissant.
2. Les enfants dont la clé est une chaîne de caractères sont classés ensuite, par ordre alphabétique croissant.

OrderByValue

Lorsque vous utilisez OrderByValue(), les enfants sont classés en fonction de leur valeur. Les critères de tri sont les mêmes que dans OrderByChild(), sauf que la valeur du nœud est utilisée à la place de la valeur d'une clé enfant spécifiée.

Étapes suivantes

• Enregistrer des données