Récupérer des données

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

Avant de commencer

Avant de pouvoir utiliser Realtime Database, vous devez:

  • Enregistrez votre projet Unity et configurez-le pour utiliser Firebase.

    • Si votre projet Unity utilise déjà Firebase, il est déjà enregistré et configuré pour Firebase.

    • Si vous ne disposez pas d'un projet Unity, vous pouvez télécharger un exemple d'application.

  • Ajoutez le SDK Unity Firebase (plus précisément, FirebaseDatabase.unitypackage) à votre projet Unity.

Notez que l'ajout de Firebase à votre projet Unity implique des tâches à la fois dans la console Firebase et dans votre projet Unity ouvert (par exemple, vous téléchargez des fichiers de configuration Firebase à partir de la console, puis les déplacez dans votre projet Unity).

Récupérer des données

Les données Firebase sont récupérées par un appel unique à GetValueAsync() ou par l'attachement à un événement sur une référence FirebaseDatabase. L'écouteur d'événements est appelé une fois pour l'état initial des données, puis chaque fois que les données changent.

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

Pour lire les données de la base de données, vous avez besoin d'une instance de DatabaseReference:

using Firebase;
using Firebase.Database;
using Firebase.Extensions.TaskExtension; // for ContinueWithOnMainThread

public class MyScript: MonoBehaviour {
  void Start() {
    // Get the root reference location of the database.
    DatabaseReference reference = FirebaseDatabase.DefaultInstance.RootReference;
  }
}

Lire les données une fois

Vous pouvez utiliser la méthode GetValueAsync pour lire un instantané statique du contenu à un chemin donné une seule fois. Le résultat de la tâche contiendra un instantané contenant toutes les données à cet emplacement, y compris les données enfants. Si aucune donnée n'est disponible, l'instantané renvoyé est null.

    FirebaseDatabase.DefaultInstance
      .GetReference("Leaders")
      .GetValueAsync().ContinueWithOnMainThread(task => {
        if (task.IsFaulted) {
          // Handle the error...
        }
        else if (task.IsCompleted) {
          DataSnapshot snapshot = task.Result;
          // Do something with snapshot...
        }
      });

Écouter des événements

Vous pouvez ajouter des écouteurs d'événements pour vous abonner aux modifications apportées aux données:

Événement Utilisation type
ValueChanged Lire et écouter les modifications apportées à l'ensemble du contenu d'un chemin.
ChildAdded Récupérez des listes d'éléments ou écoutez les ajouts à une liste d'éléments. Utilisation recommandée avec ChildChanged et ChildRemoved pour surveiller les modifications apportées aux listes.
ChildChanged Écouter les modifications apportées aux éléments d'une liste À utiliser avec ChildAdded et ChildRemoved pour surveiller les modifications apportées aux listes.
ChildRemoved Écoutez les éléments supprimés d'une liste. À utiliser avec ChildAdded et ChildChanged pour surveiller les modifications apportées aux listes.
ChildMoved Écoutez les modifications apportées à l'ordre des éléments dans une liste ordonnée. Les événements ChildMoved suivent toujours l'événement ChildChanged ayant entraîné la modification de l'ordre de l'élément (en fonction de votre méthode de tri actuelle).

Événement ValueChanged

Vous pouvez utiliser l'événement ValueChanged pour vous abonner aux modifications des contenus à un chemin donné. Cet événement est déclenché une fois lorsque l'écouteur est associé, puis chaque fois que les données, y compris les enfants, changent. Le rappel d'événement reçoit un instantané contenant toutes les données à cet emplacement, y compris les données enfants. Si aucune donnée n'est disponible, l'instantané renvoyé est null.

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

      FirebaseDatabase.DefaultInstance
        .GetReference("Leaders")
        .ValueChanged += HandleValueChanged;
    }

    void HandleValueChanged(object sender, ValueChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

ValueChangedEventArgs contient un DataSnapshot qui 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 une Dictionary<string, object> représentant les données. Si aucune donnée n'existe à l'emplacement, l'appel de Value renvoie null.

Dans cet exemple, args.DatabaseError est également examiné pour voir si la lecture est annulée. Par exemple, une lecture peut être annulée si le client n'est pas autorisé à lire à partir d'un emplacement de base de données Firebase. DatabaseError indique pourquoi l'échec s'est produit.

Vous pouvez ensuite vous désabonner de l'événement à l'aide de n'importe quel DatabaseReference ayant le même chemin d'accès. Les instances DatabaseReference sont éphémères et peuvent être considérées comme un moyen d'accéder à n'importe quel chemin d'accès et requête.

      FirebaseDatabase.DefaultInstance
        .GetReference("Leaders")
        .ValueChanged -= HandleValueChanged; // unsubscribe from ValueChanged.
    }

Événements enfants

Les événements enfants sont déclenchés en réponse à des opérations spécifiques qui affectent les enfants d'un nœud à partir d'une opération, comme l'ajout d'un enfant via la méthode Push() ou la mise à jour d'un enfant via la méthode UpdateChildrenAsync(). 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:

      var ref = FirebaseDatabase.DefaultInstance
      .GetReference("GameSessionComments");

      ref.ChildAdded += HandleChildAdded;
      ref.ChildChanged += HandleChildChanged;
      ref.ChildRemoved += HandleChildRemoved;
      ref.ChildMoved += HandleChildMoved;
    }

    void HandleChildAdded(object sender, ChildChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

    void HandleChildChanged(object sender, ChildChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

    void HandleChildRemoved(object sender, ChildChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

    void HandleChildMoved(object sender, ChildChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

L'événement ChildAdded est généralement utilisé pour récupérer une liste d'éléments dans une base de données Firebase. L'événement ChildAdded est déclenché une fois pour chaque enfant existant, puis à nouveau 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.

L'événement ChildChanged est déclenché chaque fois qu'un nœud enfant est modifié. Cela inclut toute modification apportée aux descendants du nœud enfant. Il est généralement utilisé avec les événements ChildAdded et ChildRemoved pour répondre aux modifications apportées à une liste d'éléments. L'instantané transmis à l'écouteur d'événements contient les données mises à jour pour l'enfant.

L'événement ChildRemoved est déclenché lorsqu'un enfant immédiat est supprimé. Il est généralement utilisé avec les rappels ChildAdded et ChildChanged. L'instantané transmis au rappel d'événement contient les données de l'enfant supprimé.

L'événement ChildMoved est déclenché chaque fois que l'événement ChildChanged est généré par une mise à jour qui entraîne le réordonnancement de l'enfant. Il est utilisé avec des données triées avec OrderByChild ou OrderByValue.

Trier et filtrer des données

Vous pouvez utiliser la classe Query Realtime Database pour récupérer des données triées par clé, par valeur ou par valeur d'un enfant. Vous pouvez également filtrer les résultats triés en fonction d'un nombre spécifique de résultats, 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 l'ordre des résultats:

Méthode Utilisation
OrderByChild() Triez les résultats en fonction de 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'une méthode de tri à la fois. Appeler une méthode de tri plusieurs fois dans la même requête génère une erreur.

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

      FirebaseDatabase.DefaultInstance
        .GetReference("Leaders").OrderByChild("score")
        .ValueChanged += HandleValueChanged;
    }

    void HandleValueChanged(object sender, ValueChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

Cela définit une requête qui, combinée à un écouteur d'événement valuechanged, synchronise le client avec le classement dans la base de données, classé par score de chaque entrée. Pour en savoir plus sur la structuration efficace de vos données, consultez la section Structurer votre base de données.

L'appel de la méthode OrderByChild() spécifie la clé enfant à utiliser pour 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 la section Ordre des données de requête.

Filtrer les 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 création d'une requête.

Méthode Utilisation
LimitToFirst() Définit le nombre maximal d'éléments à renvoyer à partir du début de la liste de résultats triée.
LimitToLast() Définit le nombre maximal d'éléments à renvoyer à partir de la fin de la liste de résultats triée.
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 les é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 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. 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 ChildAdded. Si vous avez moins de 100 éléments stockés dans votre base de données Firebase, un rappel ChildAdded se déclenche pour chaque élément.

À mesure que les éléments changent, vous recevez des rappels ChildAdded pour les éléments qui entrent dans la requête et des rappels ChildRemoved 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:

      FirebaseDatabase.DefaultInstance
        .GetReference("Leaders").OrderByChild("score").LimitToLast(1)
        .ValueChanged += HandleValueChanged;
    }

    void HandleValueChanged(object sender, ValueChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

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.

Ordre des données de requête

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 triées comme suit:

  1. Les enfants dont la valeur de la clé enfant spécifiée est null sont affiché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 lexicographiquement 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 clé de façon lexicographique.
  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 par ordre lexicographique croissant. Si plusieurs enfants ont la même valeur pour le nœud enfant spécifié, ils sont triés par clé de manière lexicographique.
  6. Les objets sont placés en dernier et sont triés par ordre croissant, de manière lexicographique, par clé.

OrderByKey

Lorsque vous utilisez OrderByKey() pour trier vos données, elles sont renvoyées dans l'ordre croissant par clé.

  1. Les enfants dont la clé peut être analysée en tant qu'entier 32 bits sont affichés en premier, triés par ordre croissant.
  2. Les enfants dont la clé est une valeur de chaîne viennent ensuite, triés par ordre lexicographique croissant.

OrderByValue

Lorsque vous utilisez OrderByValue(), les enfants sont trié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.