Utiliser des listes de données

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

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

DatabaseReference ref = FirebaseDatabase.instance.ref();

Remarque : Par défaut, l'accès en lecture et en écriture à votre base de données est limité, de sorte que seuls les utilisateurs authentifiés peuvent lire ou écrire des données. Pour commencer sans configurer Firebase Authentication, vous pouvez configurer vos règles d'accès public. Cela rend votre base de données accessible à tous, même aux personnes qui n'utilisent pas votre application. Veillez donc à restreindre à nouveau l'accès à votre base de données lorsque vous configurez l'authentification.

Lire et écrire des listes

Ajouter à une liste de données

Utilisez la méthode push() pour ajouter des données à une liste dans les applications multi-utilisateurs. La méthode push() génère une clé unique chaque fois qu'un enfant est ajouté à la référence Firebase spécifiée. En utilisant ces clés générées automatiquement pour chaque nouvel élément de la liste, plusieurs clients peuvent ajouter des enfants au même emplacement en même temps sans conflit d'écriture. La clé unique générée par push() est basée sur un code temporel. Les éléments de la liste sont donc automatiquement classés par ordre chronologique.

Vous pouvez utiliser la référence aux nouvelles données renvoyées par la méthode push() pour obtenir la valeur de la clé générée automatiquement de l'enfant ou définir des données pour l'enfant. La propriété .key d'une référence push() contient la clé générée automatiquement.

Vous pouvez utiliser ces clés générées automatiquement pour simplifier l'aplatissement de votre structure de données. Pour en savoir plus, consultez l'exemple de distribution de données.

Par exemple, push() peut être utilisé pour ajouter un nouveau post à une liste de posts dans une application de réseau social :

DatabaseReference postListRef = FirebaseDatabase.instance.ref("posts");
DatabaseReference newPostRef = postListRef.push();
newPostRef.set({
  // ...
});

Écouter les événements enfants

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 push() ou la mise à jour d'un enfant via la méthode update().

Événement	Utilisation standard
onChildAdded	Récupérez des listes d'éléments ou écoutez les ajouts à une liste d'éléments. Cet événement est déclenché 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.
onChildChanged	Écouter les modifications apportées aux éléments d'une liste Cet événement est déclenché chaque fois qu'un nœud enfant est modifié. Cela inclut toutes les modifications apportées aux descendants du nœud enfant. L'instantané transmis à l'écouteur d'événements contient les données mises à jour pour l'enfant.
onChildRemoved	Écouter les éléments supprimés d'une liste Cet événement est déclenché lorsqu'un enfant immédiat est supprimé.L'instantané transmis au bloc de rappel contient les données de l'enfant supprimé.
onChildMoved	Écouter les modifications apportées à l'ordre des éléments dans une liste numérotée. Les événements onChildMoved suivent toujours l'événement onChildChanged qui a entraîné la modification de l'ordre de l'élément (en fonction de votre méthode de tri actuelle).

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, une application de blog social peut utiliser ces méthodes ensemble pour surveiller l'activité dans les commentaires d'un post, comme indiqué ci-dessous :

final commentsRef = FirebaseDatabase.instance.ref("post-comments/$postId");
commentsRef.onChildAdded.listen((event) {
  // A new comment has been added, so add it to the displayed list.
});
commentsRef.onChildChanged.listen((event) {
  // A comment has changed; use the key to determine if we are displaying this
  // comment and if so displayed the changed comment.
});
commentsRef.onChildRemoved.listen((event) {
  // A comment has been removed; use the key to determine if we are displaying
  // this comment and if so remove it.
});

Écouter les événements de valeur

Bien que l'écoute des événements enfants soit la méthode recommandée pour lire des listes de données, il peut être utile d'écouter les événements de valeur sur une référence de liste dans certaines situations.

L'association d'un écouteur value à une liste de données renvoie la liste complète des données sous la forme d'un seul instantané, que vous pouvez ensuite parcourir pour accéder aux enfants individuels.

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. Pour accéder à l'élément, vous devez effectuer une boucle sur le résultat :

myTopPostsQuery.onValue.listen((event) {
  for (final child in event.snapshot.children) {
    // Handle the post.
  }
}, onError: (error) {
  // Error.
});

Ce modèle peut être utile lorsque vous souhaitez récupérer tous les enfants d'une liste en une seule opération, plutôt que d'écouter les événements d'ajout d'enfants supplémentaires.

Trier et filtrer des données

Vous pouvez utiliser la classe 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.

Remarque : Le filtrage et le tri peuvent être coûteux, en particulier lorsqu'ils sont effectués sur le client. Si votre application utilise des requêtes, définissez la règle .indexOn pour indexer ces clés sur le serveur et améliorer les performances des requêtes, comme décrit dans Indexer vos données.

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()	Classez les résultats en fonction de la valeur d'une clé enfant spécifiée ou d'un chemin d'accès enfant imbriqué.
orderByKey()	Classe les résultats par clés enfants.
orderByValue()	Classe les résultats par valeurs enfants.

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 récupérer la liste des posts les plus populaires d'un utilisateur, triés par nombre d'étoiles :

final myUserId = FirebaseAuth.instance.currentUser?.uid;
final topUserPostsRef = FirebaseDatabase.instance
    .ref("user-posts/$myUserId")
    .orderByChild("starCount");

Cela définit une requête qui, lorsqu'elle est combinée à un écouteur enfant, synchronise le client avec les posts de l'utilisateur à partir du chemin d'accès dans la base de données en fonction de son ID utilisateur, triés par le nombre d'étoiles que chaque post a reçues. Cette technique consistant à utiliser des ID comme clés d'index est appelée "fan-out de données". Pour en savoir plus, 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 posts sont triés en fonction de la valeur de leur enfant "starCount" respectif. Les requêtes peuvent également être triées par enfants imbriqués, si vos données se présentent comme suit :

"posts": {
  "ts-functions": {
    "metrics": {
      "views" : 1200000,
      "likes" : 251000,
      "shares": 1200,
    },
    "title" : "Why you should use TypeScript for writing Cloud Functions",
    "author": "Doug",
  },
  "android-arch-3": {
    "metrics": {
      "views" : 900000,
      "likes" : 117000,
      "shares": 144,
    },
    "title" : "Using Android Architecture Components with Firebase Realtime Database (Part 3)",
    "author": "Doug",
  }
},

Dans ce cas, nous pouvons trier les éléments de notre liste par valeurs imbriquées sous la clé metrics en spécifiant le chemin relatif à l'enfant imbriqué dans notre appel orderByChild().

final mostViewedPosts =
    FirebaseDatabase.instance.ref('posts').orderByChild('metrics/views');

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.

Remarque : Vous ne devez pas utiliser de caractères Unicode spéciaux dans vos clés, tels que \u{0000}. Pour en savoir plus, consultez le problème Flutter.

Méthode	Utilisation
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, selon la méthode de tri choisie.
startAfter()	Renvoie les éléments supérieurs à la clé ou à la valeur spécifiée, selon la méthode de tri choisie.
endAt()	Renvoie les éléments inférieurs ou égaux à la clé ou à la valeur spécifiée, selon la méthode de tri choisie.
endBefore()	Renvoie les éléments inférieurs à 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, selon 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.

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 événement donné. Par exemple, si vous utilisez limitToFirst() pour définir une limite de 100, vous ne recevez initialement que 100 événements onChildAdded au maximum. Si votre base de données Firebase contient moins de 100 éléments, un événement onChildAdded se déclenche pour chaque élément.

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

L'exemple suivant montre comment l'exemple d'application de blog définit une requête pour récupérer la liste des 100 articles les plus récents de tous les utilisateurs :

final recentPostsRef = FirebaseDatabase.instance.ref('posts').limitToLast(100);

Cet exemple ne définit qu'une requête. Pour synchroniser les données, il doit disposer d'un écouteur associé.

Filtrer par clé ou valeur

Vous pouvez utiliser startAt(), startAfter(), endAt(), endBefore() 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 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 la valeur false, ils sont triés par ordre lexicographique de 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 en fonction de leur 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 viennent ensuite, triés par ordre lexicographique croissant.

orderByValue

Lorsque vous utilisez orderByValue(), les enfants sont classés par 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.

Dissocier les écouteurs

Les rappels sont supprimés en appelant la méthode off() sur votre référence de base de données Firebase.

Vous pouvez supprimer un seul écouteur en le transmettant en tant que paramètre à off(). L'appel de off() sur l'emplacement sans argument supprime tous les écouteurs à cet emplacement.

L'appel de off() sur un écouteur parent ne supprime pas automatiquement les écouteurs enregistrés sur ses nœuds enfants. off() doit également être appelé sur tous les écouteurs enfants pour supprimer le rappel.

Étapes suivantes

• Découvrez comment structurer les données.
• Stocker des données hors connexion