Utilizza gli elenchi di dati su Android

Questo documento descrive come lavorare con gli elenchi di dati in Firebase. Per scoprire le basi della lettura e della scrittura dei dati Firebase, consulta Lettura e scrittura di dati su Android.

Nota :per impostazione predefinita, l'accesso in lettura e scrittura al database è limitato, pertanto solo gli utenti autenticati possono leggere o scrivere dati. Per iniziare senza configurare Authentication, puoi configurare le regole per l'accesso pubblico. In questo modo il tuo database sarà aperto a chiunque, anche a chi non utilizza la tua app, quindi assicurati di limitare nuovamente l'accesso al database quando configuri l'autenticazione.

Recuperare un DatabaseReference

Per leggere e scrivere dati dal database, hai bisogno di un'istanza di DatabaseReference:

Kotlin

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

Java

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

Leggere e scrivere elenchi

Aggiungere a un elenco di dati

Utilizza il metodo push() per aggiungere dati a un elenco in applicazioni multiutente. Il metodo push() genera una chiave univoca ogni volta che viene aggiunto un nuovo elemento secondario al riferimento Firebase specificato. Utilizzando queste chiavi generate automaticamente per ogni nuovo elemento dell'elenco, più client possono aggiungere figli alla stessa posizione contemporaneamente senza conflitti di scrittura. La chiave univoca generata da push() si basa su un timestamp, quindi gli elementi dell'elenco vengono ordinati automaticamente in ordine cronologico.

Puoi utilizzare il riferimento ai nuovi dati restituiti dal metodo push() per ottenere il valore della chiave generata automaticamente dell'elemento secondario o impostare i dati per l'elemento secondario. La chiamata getKey() su un riferimento push() restituisce il valore della chiave generata automaticamente.

Puoi utilizzare queste chiavi generate automaticamente per semplificare l'appiattimento della struttura dei dati. Per saperne di più, consulta l'esempio di fan-out dei dati.

Ascolta gli eventi secondari

Quando lavori con gli elenchi, la tua applicazione deve rilevare gli eventi secondari anziché gli eventi di valore utilizzati per i singoli oggetti.

Gli eventi secondari vengono attivati in risposta a operazioni specifiche che interessano i figli di un nodo da un'operazione come l'aggiunta di un nuovo figlio tramite il metodo push() o l'aggiornamento di un figlio tramite il metodo updateChildren(). Ciascuno di questi elementi può essere utile per ascoltare le modifiche apportate a un nodo specifico in un database.

Per ascoltare gli eventi secondari su DatabaseReference, allega un ChildEventListener:

modulo	Callback evento	Utilizzo tipico
ChildEventListener	onChildAdded()	Recuperare elenchi di elementi o ascoltare le aggiunte a un elenco di elementi. Questo callback viene attivato una volta per ogni elemento secondario esistente e poi di nuovo ogni volta che viene aggiunto un nuovo elemento secondario al percorso specificato. L'DataSnapshot passato al listener contiene i dati del nuovo bambino.
	onChildChanged()	Ascolta le modifiche apportate agli elementi di un elenco. Questo evento viene attivato ogni volta che viene modificato un nodo secondario, incluse le modifiche ai discendenti del nodo secondario. L'DataSnapshot passato al listener di eventi contiene i dati aggiornati del bambino.
	onChildRemoved()	Ascolta gli elementi rimossi da un elenco. Il DataSnapshot passato al callback dell'evento contiene i dati del publisher secondario rimosso.
	onChildMoved()	Ascolta le modifiche all'ordine degli elementi in un elenco ordinato. Questo evento viene attivato ogni volta che il callback onChildChanged() viene attivato da un aggiornamento che causa il riordino del bambino. Viene utilizzato con i dati ordinati con orderByChild o orderByValue.

Ad esempio, un'app di blogging sociale potrebbe utilizzare questi metodi insieme per monitorare l'attività nei commenti di un post, come mostrato di seguito:

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)
QueryActivity.kt

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);
QueryActivity.java

Ascolta gli eventi di valore

Sebbene l'utilizzo di un ChildEventListener sia il modo consigliato per leggere gli elenchi di dati, in alcune situazioni è utile allegare un ValueEventListener a un riferimento di elenco.

Se colleghi un ValueEventListener a un elenco di dati, l'intero elenco di dati viene restituito come un singolo DataSnapshot, che puoi quindi scorrere per accedere ai singoli elementi secondari.

Anche quando esiste una sola corrispondenza per la query, lo snapshot è comunque un elenco, ma contiene un solo elemento. Per accedere all'elemento, devi scorrere il risultato:

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())
        // ...
    }
})
QueryActivity.kt

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());
        // ...
    }
});
QueryActivity.java

Questo pattern può essere utile quando vuoi recuperare tutti gli elementi secondari di un elenco in una singola operazione, anziché ascoltare altri eventi onChildAdded.

Stacca i listener

I callback vengono rimossi chiamando il metodo removeEventListener() sul riferimento al database Firebase.

Se un listener è stato aggiunto più volte a una posizione dei dati, viene chiamato più volte per ogni evento e devi scollegarlo lo stesso numero di volte per rimuoverlo completamente.

La chiamata di removeEventListener() su un listener genitore non rimuove automaticamente i listener registrati nei relativi nodi secondari; removeEventListener() deve essere chiamato anche su tutti i listener secondari per rimuovere il callback.

Ordinare e filtrare i dati

Puoi utilizzare la classe Realtime Database Query per recuperare i dati ordinati per chiave, per valore o per valore di un elemento secondario. Puoi anche filtrare il risultato ordinato in base a un numero specifico di risultati o a un intervallo di chiavi o valori.

Nota :il filtraggio e l'ordinamento possono essere costosi, soprattutto se eseguiti sul client. Se la tua app utilizza query, definisci la regola .indexOn per indicizzare queste chiavi sul server e migliorare le prestazioni delle query come descritto in Indicizzazione dei dati.

Ordinare i dati

Per recuperare i dati ordinati, inizia specificando uno dei metodi di ordinamento per determinare l'ordine dei risultati:

Metodo	Utilizzo
orderByChild()	Ordina i risultati in base al valore di una chiave secondaria specificata o di un percorso secondario nidificato.
orderByKey()	Ordina i risultati in base alle chiavi secondarie.
orderByValue()	Ordina i risultati in base ai valori secondari.

Puoi utilizzare un solo metodo di ordinamento alla volta. La chiamata di un metodo order-by più volte nella stessa query genera un errore.

Il seguente esempio mostra come recuperare un elenco dei post più popolari di un utente ordinati in base al numero di stelle:

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
    // ...
})
QueryActivity.kt

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
    // ...
});
QueryActivity.java

Definisce una query che, combinata con un listener secondario, sincronizza il client con i post dell'utente dal percorso nel database in base al suo ID utente, ordinati in base al numero di stelle ricevute da ogni post. Questa tecnica di utilizzo degli ID come chiavi di indice è chiamata distribuzione dei dati. Puoi saperne di più in Strutturare il database.

La chiamata al metodo orderByChild() specifica la chiave secondaria in base alla quale ordinare i risultati. In questo caso, i post vengono ordinati in base al valore del rispettivo elemento secondario "starCount". Le query possono essere ordinate anche in base ai figli nidificati, nel caso in cui i dati siano strutturati in questo modo:

"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",
  }
},

In questo esempio, possiamo ordinare gli elementi dell'elenco in base ai valori nidificati nella chiave metrics specificando il percorso relativo all'elemento secondario nidificato nella chiamata 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
    // ...
})
QueryActivity.kt

Java

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

Per saperne di più sull'ordinamento di altri tipi di dati, vedi Come vengono ordinati i dati delle query.

Filtrare i dati

Per filtrare i dati, puoi combinare uno qualsiasi dei metodi di limite o intervallo con un metodo di ordinamento durante la creazione di una query.

Metodo	Utilizzo
limitToFirst()	Imposta il numero massimo di elementi da restituire dall'inizio dell'elenco ordinato di risultati.
limitToLast()	Imposta il numero massimo di elementi da restituire dalla fine dell'elenco ordinato di risultati.
startAt()	Restituisce gli elementi maggiori o uguali alla chiave o al valore specificato a seconda del metodo di ordinamento scelto.
startAfter()	Restituisce gli elementi maggiori della chiave o del valore specificato a seconda del metodo di ordinamento scelto.
endAt()	Restituisce gli elementi minori o uguali alla chiave o al valore specificato a seconda del metodo di ordinamento scelto.
endBefore()	Restituisce gli elementi inferiori alla chiave o al valore specificato a seconda del metodo di ordinamento scelto.
equalTo()	Restituisce gli elementi uguali alla chiave o al valore specificato a seconda del metodo di ordinamento scelto.

A differenza dei metodi di ordinamento, puoi combinare più funzioni di limite o intervallo. Ad esempio, puoi combinare i metodi startAt() e endAt() per limitare i risultati a un intervallo di valori specificato.

Anche quando esiste una sola corrispondenza per la query, lo snapshot è comunque un elenco, ma contiene un solo elemento. Per accedere all'elemento, devi scorrere il risultato:

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())
        // ...
    }
})
QueryActivity.kt

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());
        // ...
    }
});
QueryActivity.java

Limitare il numero di risultati

Puoi utilizzare i metodi limitToFirst() e limitToLast() per impostare un numero massimo di figli da sincronizzare per un determinato callback. Ad esempio, se utilizzi limitToFirst() per impostare un limite di 100, inizialmente riceverai solo fino a 100 callback onChildAdded(). Se hai meno di 100 elementi memorizzati nel database Firebase, viene attivata una richiamata onChildAdded() per ogni elemento.

Man mano che gli elementi cambiano, ricevi onChildAdded() callback per gli elementi che entrano nella query e onChildRemoved() callback per gli elementi che escono dalla query, in modo che il numero totale rimanga a 100.

Il seguente esempio mostra come l'app di blogging di esempio definisce una query per recuperare un elenco dei 100 post più recenti di tutti gli utenti:

Kotlin

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

Java

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

Questo esempio definisce solo una query. Per sincronizzare effettivamente i dati, deve avere un listener allegato.

Filtrare per chiave o valore

Puoi utilizzare startAt(), startAfter(), endAt(), endBefore() e equalTo() per scegliere punti di partenza, di arrivo e di equivalenza arbitrari per le query. Può essere utile per paginare i dati o trovare elementi secondari che hanno un valore specifico.

Come vengono ordinati i dati delle query

Questa sezione spiega come vengono ordinati i dati in base a ciascuno dei metodi di ordinamento nella classe Query.

orderByChild

Quando utilizzi orderByChild(), i dati che contengono la chiave secondaria specificata vengono ordinati nel seguente modo:

1. I bambini con un valore null per la chiave figlio specificata vengono visualizzati per primi.
2. I figli con un valore di false per la chiave secondaria specificata vengono visualizzati successivamente. Se più elementi secondari hanno un valore di false, vengono ordinati lessicograficamente per chiave.
3. I figli con un valore di true per la chiave secondaria specificata vengono visualizzati successivamente. Se più elementi secondari hanno un valore di true, vengono ordinati in ordine lessicografico in base alla chiave.
4. Seguono i bambini con un valore numerico, ordinati in ordine crescente. Se più elementi secondari hanno lo stesso valore numerico per il nodo secondario specificato, vengono ordinati per chiave.
5. Le stringhe vengono dopo i numeri e sono ordinate lessicograficamente in ordine crescente. Se più figli hanno lo stesso valore per il nodo figlio specificato, vengono ordinati in ordine lessicografico per chiave.
6. Gli oggetti vengono visualizzati per ultimi e sono ordinati lessicograficamente per chiave in ordine crescente.

orderByKey

Quando utilizzi orderByKey() per ordinare i dati, questi vengono restituiti in ordine crescente per chiave.

1. I bambini con una chiave che può essere analizzata come un numero intero a 32 bit vengono visualizzati per primi, in ordine crescente.
2. Seguono i figli con un valore stringa come chiave, ordinati in ordine lessicografico crescente.

orderByValue

Quando si utilizza orderByValue(), i bambini vengono ordinati in base al loro valore. I criteri di ordinamento sono gli stessi di orderByChild(), tranne che viene utilizzato il valore del nodo anziché il valore di una chiave secondaria specificata.

Passaggi successivi

• Scopri come strutturare i dati
• Memorizzare i dati offline