Utiliser des listes de données sur Android

Ce document explique comment utiliser des listes de données dans Firebase. Pour apprendre les bases de la lecture et de l'écriture de données Firebase, consultez Lire et écrire des données sur Android.

Obtenir une DatabaseReference

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

Kotlin

private lateinit var database: DatabaseReference
// ...
database = Firebase.database.reference

Java

private DatabaseReference mDatabase;
// ...
mDatabase = FirebaseDatabase.getInstance().getReference();

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. L'appel de getKey() sur une référence push() renvoie la valeur de 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.

Écouter les événements enfants

Lorsque vous travaillez avec des listes, votre application doit écouter les événements enfants plutôt que les événements de valeur utilisés pour les objets uniques.

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 un nouvel enfant ajouté via la méthode push() ou un enfant mis à jour 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.

Pour écouter les événements enfants sur DatabaseReference, associez un ChildEventListener :

Écouteur Rappel d'événement Utilisation standard
ChildEventListener onChildAdded() Récupérer des listes d'éléments ou écouter les ajouts à une liste d'éléments. Ce rappel est déclenché une fois pour chaque enfant existant, puis à chaque fois qu'un nouvel enfant est ajouté au chemin spécifié. Le DataSnapshot transmis à l'écouteur contient 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é, y compris les modifications apportées aux descendants du nœud enfant. Le DataSnapshot 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 Le DataSnapshot transmis au rappel d'événement 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. Cet événement est déclenché chaque fois que le rappel onChildChanged() est déclenché par une mise à jour qui entraîne la réorganisation de l'enfant. Elle est utilisée avec des données ordonnées avec orderByChild ou orderByValue.

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 :

Kotlin 

val childEventListener = object : ChildEventListener {
    override fun onChildAdded(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildAdded:" + dataSnapshot.key!!)

        // A new comment has been added, add it to the displayed list
        val comment = dataSnapshot.getValue<Comment>()

        // ...
    }

    override fun onChildChanged(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildChanged: ${dataSnapshot.key}")

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so displayed the changed comment.
        val newComment = dataSnapshot.getValue<Comment>()
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onChildRemoved(dataSnapshot: DataSnapshot) {
        Log.d(TAG, "onChildRemoved:" + dataSnapshot.key!!)

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so remove it.
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onChildMoved(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildMoved:" + dataSnapshot.key!!)

        // A comment has changed position, use the key to determine if we are
        // displaying this comment and if so move it.
        val movedComment = dataSnapshot.getValue<Comment>()
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onCancelled(databaseError: DatabaseError) {
        Log.w(TAG, "postComments:onCancelled", databaseError.toException())
        Toast.makeText(
            context,
            "Failed to load comments.",
            Toast.LENGTH_SHORT,
        ).show()
    }
}
databaseReference.addChildEventListener(childEventListener)

Java 

ChildEventListener childEventListener = new ChildEventListener() {
    @Override
    public void onChildAdded(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildAdded:" + dataSnapshot.getKey());

        // A new comment has been added, add it to the displayed list
        Comment comment = dataSnapshot.getValue(Comment.class);

        // ...
    }

    @Override
    public void onChildChanged(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildChanged:" + dataSnapshot.getKey());

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so displayed the changed comment.
        Comment newComment = dataSnapshot.getValue(Comment.class);
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onChildRemoved(DataSnapshot dataSnapshot) {
        Log.d(TAG, "onChildRemoved:" + dataSnapshot.getKey());

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so remove it.
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onChildMoved(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildMoved:" + dataSnapshot.getKey());

        // A comment has changed position, use the key to determine if we are
        // displaying this comment and if so move it.
        Comment movedComment = dataSnapshot.getValue(Comment.class);
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onCancelled(DatabaseError databaseError) {
        Log.w(TAG, "postComments:onCancelled", databaseError.toException());
        Toast.makeText(mContext, "Failed to load comments.",
                Toast.LENGTH_SHORT).show();
    }
};
databaseReference.addChildEventListener(childEventListener);

Écouter les événements de valeur

Bien que l'utilisation d'un ChildEventListener soit la méthode recommandée pour lire des listes de données, il peut être utile d'associer un ValueEventListener à une référence de liste dans certains cas.

L'association d'un ValueEventListener à une liste de données renvoie l'intégralité de la liste de données sous la forme d'un seul DataSnapshot, 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 :

Kotlin 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        for (postSnapshot in dataSnapshot.children) {
            // TODO: handle the post
        }
    }

    override fun onCancelled(databaseError: DatabaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException())
        // ...
    }
})

Java 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
        for (DataSnapshot postSnapshot: dataSnapshot.getChildren()) {
            // TODO: handle the post
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError databaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException());
        // ...
    }
});

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 d'autres événements onChildAdded.

Dissocier les écouteurs

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

Si un écouteur a été ajouté plusieurs fois à un emplacement de données, il est appelé plusieurs fois pour chaque événement. Vous devez le dissocier autant de fois pour le supprimer complètement.

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

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 :

Méthode Utilisation
orderByChild() Triez 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 meilleurs posts d'un utilisateur, triés par nombre d'étoiles :

Kotlin 

// My top posts by number of stars
val myUserId = uid
val myTopPostsQuery = databaseReference.child("user-posts").child(myUserId)
    .orderByChild("starCount")

myTopPostsQuery.addChildEventListener(object : ChildEventListener {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
})

Java 

// My top posts by number of stars
String myUserId = getUid();
Query myTopPostsQuery = databaseReference.child("user-posts").child(myUserId)
        .orderByChild("starCount");
myTopPostsQuery.addChildEventListener(new ChildEventListener() {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
});

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 reçues par chaque post. 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 cet exemple, nous pouvons classer 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().

Kotlin 

// Most viewed posts
val myMostViewedPostsQuery = databaseReference.child("posts")
    .orderByChild("metrics/views")
myMostViewedPostsQuery.addChildEventListener(object : ChildEventListener {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
})

Java 

// Most viewed posts
Query myMostViewedPostsQuery = databaseReference.child("posts")
        .orderByChild("metrics/views");
myMostViewedPostsQuery.addChildEventListener(new ChildEventListener() {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
});

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.

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, selon 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.

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 :

Kotlin 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        for (postSnapshot in dataSnapshot.children) {
            // TODO: handle the post
        }
    }

    override fun onCancelled(databaseError: DatabaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException())
        // ...
    }
})

Java 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
        for (DataSnapshot postSnapshot: dataSnapshot.getChildren()) {
            // TODO: handle the post
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError databaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException());
        // ...
    }
});

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.

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 :

Kotlin 

// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys.
databaseReference.child("posts").limitToFirst(100)

Java 

// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys
Query recentPostsQuery = databaseReference.child("posts")
        .limitToFirst(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-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