Catch up on everything we announced at this year's Firebase Summit. Learn more

Récupération de données avec Firebase Realtime Database pour C++

Ce document couvre les bases de la récupération de données et comment trier et filtrer les données Firebase.

Avant que tu commences

Assurez - vous que la configuration de votre application AVONS et peut accéder à la base de données couvertes dans le Get Started guide.

Récupération des données

Firebase données sont récupérées soit par un appel d'une durée de GetValue() ou de la fixation à un ValueListener sur un FirebaseDatabase référence. L'écouteur de valeur est appelé une fois pour l'état initial des données et à nouveau chaque fois que les données changent.

Obtenir une référence de base de données

Pour les données d'écriture à 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 le GetValue() méthode pour lire un instantané statique du contenu à un chemin donné une fois. 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é retournée est null .

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

Au moment où la demande a été faite, nous devons attendre que le futur se termine 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 effectuerez généralement un sondage pour l'achèvement.

  // 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 erreur de contrôle de base, voir le firebase :: Future référence pour plus d' informations sur la vérification des erreurs et des façons 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 :

ValueListener classe de base

Rappeler Utilisation typique
OnValueChanged Lisez et écoutez les modifications apportées à l'ensemble du contenu d'un chemin.

OnChildListener classe de base

OnChildAdded Récupérez des listes d'éléments ou écoutez les ajouts à une liste d'éléments. Utilisation suggérée avec OnChildChanged et OnChildRemoved pour surveiller les changements aux listes.
OnChildChanged Écoutez les modifications apportées aux éléments d'une liste. Utilisation avec OnChildAdded et OnChildRemoved pour surveiller les changements aux listes.
OnChildRemoved Écoutez les éléments supprimés d'une liste. Utilisation avec OnChildAdded et OnChildChanged aux changements du moniteur aux listes.
OnChildMoved Écoutez les modifications apportées à l'ordre des éléments dans une liste ordonnée. OnChildMoved callbacks suivent toujours les OnChildChanged callbacks en raison de l' évolution ( en fonction de votre commande par méthode actuelle) l'ordre de l'élément.

Classe ValueListener

Vous pouvez utiliser les OnValueChanged callbacks pour vous abonner à modifier le contenu à un chemin donné. Ce rappel est déclenché une fois lorsque l'écouteur est attaché et à chaque fois que les données, y compris les enfants, changent. Le rappel reçoit 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é retournée est null .

L'exemple suivant illustre un jeu récupérant les scores d'un classement à partir de 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<firebase::database::DataSnapshot> result =
    dbRef.GetReference("Leaders").AddValueListener(listener);

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

Dans cet exemple, la OnCancelled méthode est également surchargée pour voir si la lecture est annulée. Par exemple, une lecture peut être annulée si le client n'a pas l'autorisation de lire à partir d'un emplacement de base de données Firebase. La database::Error de database::Error indique pourquoi l'échec.

Classe ChildListener

Les événements d'enfants sont déclenchées en réponse à des opérations spécifiques qui se produisent aux enfants d'un noeud à partir d' une opération, comme un enfant nouveau ajouté par l'intermédiaire du PushChild() méthode ou un enfant d' être mis à jour par l'intermédiaire du UpdateChildren() méthode. Chacun de ces éléments peut être utile pour écouter les modifications apportées à un nœud spécifique dans 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 illustré 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<firebase::database::DataSnapshot> result =
    dbRef.GetReference("GameSessionComments").AddChildListener(listener);

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

Le OnChildChanged rappel 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 OnChildAdded et OnChildRemoved appels 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 OnChildRemoved rappel est déclenchée lorsqu'un enfant est enlevé immédiatement. Il est généralement utilisé conjointement avec les OnChildAdded et OnChildChanged callbacks. L'instantané transmis au rappel contient les données de l'enfant supprimé.

Le OnChildMoved rappel est déclenché chaque fois que le OnChildChanged appel est soulevée par une mise à jour qui provoque réordonnancement de l'enfant. Il est utilisé avec des données qui est commandé avec OrderByChild ou OrderByValue .

Trier et filtrer les données

Vous pouvez utiliser la base de données en temps réel de Query de classe pour récupérer des données triées par clé, en valeur, ou valeur d'un enfant. Vous pouvez également filtrer le résultat trié en fonction d'un nombre spécifique de résultats ou d'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 comment les résultats sont classés :

Méthode Usage
OrderByChild() Triez les résultats par la valeur d'une clé enfant spécifiée.
OrderByKey() Triez les résultats par clés enfants.
OrderByValue() Triez les résultats par valeurs enfants.

Vous ne pouvez utiliser qu'un seul ordre par la méthode à 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 de score classé 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.

Ceci définit un firebase::Query que lorsqu'il est combiné avec un ValueListener synchronise le client avec le leaderboard dans la base de données, commandé par le score de chaque entrée. Vous pouvez en savoir plus sur la structuration de vos données de manière efficace dans la structure de votre base de données .

L'appel à la OrderByChild() méthode spécifie la clé de l' enfant à l' ordre par les résultats. Dans ce cas, les résultats sont triés par la valeur du "score" valeur de chaque enfant. Pour plus d' informations sur d' autres types de données sont ordonnées, voir comment la requête des données est ordonnée .

Filtrage des données

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

Méthode Usage
LimitToFirst() Définit le nombre maximal d'éléments à renvoyer à partir du début de la liste ordonnée des résultats.
LimitToLast() Définit le nombre maximal d'éléments à renvoyer à partir de la fin de la liste ordonnée des résultats.
StartAt() Renvoie les éléments supérieurs ou égaux à la clé ou à la valeur spécifiée en fonction de la méthode de tri choisie.
EndAt() Renvoie les éléments inférieurs ou égaux à la clé ou à la valeur spécifiée en fonction de la méthode de tri choisie.
EqualTo() Renvoie des éléments égaux à la clé ou à la valeur spécifiée en fonction de la méthode de tri choisie.

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

Même lorsqu'il n'y a qu'une seule correspondance pour la requête, l'instantané est toujours une liste ; il ne contient qu'un seul élément.

Limiter le nombre de résultats

Vous pouvez utiliser le LimitToFirst() et LimitToLast() méthodes pour définir un nombre maximum d'enfants pour être synchronisés un rappel donné. Par exemple, si vous utilisez LimitToFirst() pour définir une limite de 100, vous recevez d' abord que jusqu'à 100 OnChildAdded callbacks. Si vous avez moins de 100 éléments stockés dans la base de données Firebase, un OnChildAdded feux de rappel pour chaque élément.

Comme éléments changent, vous recevez OnChildAdded callbacks pour les éléments qui entrent dans la requête et OnChildRemoved callbacks pour les articles qui abandonnent pour que le nombre total de séjours à 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() choisir départ arbitraire, la fin et les points d'équivalence pour les requêtes. Cela peut être utile pour paginer des données ou rechercher des éléments avec des enfants qui ont une valeur spécifique.

Comment les données de requête sont ordonnées

Cette section explique comment les données sont triées par chacun de l'ordre par des méthodes dans la Query classe.

OrderByChild

Lors de l' utilisation OrderByChild() , les données qui contient la clé de l' enfant spécifié est ordonné comme suit:

  1. Les enfants ayant une null valeur de la clé de l' enfant spécifié viennent en premier.
  2. Les enfants ayant une valeur de false pour la clé de l' enfant spécifié viennent ensuite. Si plusieurs enfants ont une valeur de false , ils sont triés lexicographique par clé.
  3. Les enfants ayant une valeur de true pour la clé de l' enfant spécifié viennent ensuite. Si plusieurs enfants ont une valeur de true , ils sont classés par ordre lexicographique clé.
  4. Les enfants avec 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 lexicographiquement par ordre croissant. Si plusieurs enfants ont la même valeur pour le nœud enfant spécifié, ils sont classés lexicographiquement par clé.
  6. Les objets arrivent en dernier et sont triés lexicographiquement par clé dans l'ordre croissant.

OrderByKey

Lors de l' utilisation OrderByKey() pour trier vos données, les données sont renvoyées en ordre croissant par clé.

  1. Les enfants avec une clé qui peut être analysée comme un entier de 32 bits viennent en premier, triés par ordre croissant.
  2. Les enfants avec une valeur de chaîne comme clé viennent ensuite, triés lexicographiquement par ordre croissant.

OrderByValue

Lorsque vous utilisez OrderByValue() , les enfants sont classés par leur valeur. Les critères de classement sont les mêmes que dans OrderByChild() , à l' exception de la valeur du nœud est utilisé au lieu de la valeur d'une clé enfant spécifié.

Prochaines étapes