Questo documento copre le nozioni di base sul recupero dei dati e su come ordinare e filtrare i dati Firebase.
Prima di iniziare
Assicurati di aver configurato la tua app e di poter accedere al database come spiegato nella guida Get Started .
Recupero dati
I dati Firebase vengono recuperati tramite una chiamata una tantum a GetValue() o collegandosi a un ValueListener su un riferimento FirebaseDatabase . Il listener di valori viene chiamato una volta per lo stato iniziale dei dati e di nuovo ogni volta che i dati cambiano.
Ottieni un riferimento al database
Per scrivere dati nel database, è necessaria un'istanza di DatabaseReference :
// Get the root reference location of the database.
firebase::database::DatabaseReference dbref = database->GetReference();
Leggere i dati una volta
È possibile utilizzare il metodo GetValue() per leggere una volta uno snapshot statico dei contenuti in un determinato percorso. Il risultato dell'attività conterrà uno snapshot contenente tutti i dati in quella posizione, inclusi i dati secondari. Se non sono presenti dati, lo snapshot restituito è null .
firebase::Future<firebase::database::DataSnapshot> result =
dbRef.GetReference("Leaders").GetValue();
A questo punto la richiesta è stata effettuata ma dobbiamo attendere il completamento del Future prima di poter leggere il valore. Poiché i giochi in genere vengono eseguiti in loop e sono meno guidati da callback rispetto ad altre applicazioni, in genere verrà eseguito il polling per il completamento.
// 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...
}
}
Questo mostra alcuni controlli di base degli errori, consulta il riferimento firebase::Future per ulteriori informazioni sul controllo degli errori e sui modi per determinare quando il risultato è pronto.
Ascolta gli eventi
Puoi aggiungere ascoltatori per iscriversi alle modifiche ai dati:
Classe base ValueListener
| Richiamare | Utilizzo tipico |
|---|---|
OnValueChanged | Leggere e ascoltare le modifiche all'intero contenuto di un percorso. |
Classe base OnChildListener
OnChildAdded | Recupera elenchi di elementi o ascolta eventuali aggiunte a un elenco di elementi. Utilizzo consigliato con OnChildChanged e OnChildRemoved per monitorare le modifiche agli elenchi. |
OnChildChanged | Ascolta le modifiche agli elementi in un elenco. Utilizzare con OnChildAdded e OnChildRemoved per monitorare le modifiche agli elenchi. |
OnChildRemoved | Ascolta gli elementi che vengono rimossi da un elenco. Utilizzare con OnChildAdded e OnChildChanged per monitorare le modifiche agli elenchi. |
OnChildMoved | Ascolta le modifiche all'ordine degli elementi in un elenco ordinato. I callback OnChildMoved seguono sempre i callback OnChildChanged a causa della modifica dell'ordine dell'articolo (in base al metodo corrente per ordine). |
Classe ValueListener
È possibile utilizzare i callback OnValueChanged per sottoscrivere le modifiche ai contenuti in un determinato percorso. Questa richiamata viene attivata una volta quando l'ascoltatore è collegato e di nuovo ogni volta che i dati, inclusi i figli, cambiano. Alla richiamata viene passata uno snapshot contenente tutti i dati in quella posizione, inclusi i dati figlio. Se non sono presenti dati, lo snapshot restituito è null .
L'esempio seguente mostra un gioco che recupera i punteggi di una classifica dal database:
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);
Il risultato Future<DataSnapshot> contiene i dati nella posizione specificata nel database al momento dell'evento. La chiamata value() su uno snapshot restituisce una Variant che rappresenta i dati.
In questo esempio viene eseguito anche l'override del metodo OnCancelled per verificare se la lettura viene annullata. Ad esempio, una lettura può essere annullata se il client non dispone dell'autorizzazione per leggere da una posizione del database Firebase. Il database::Error indicherà il motivo per cui si è verificato l'errore.
Classe ChildListener
Gli eventi figlio vengono attivati in risposta a operazioni specifiche che si verificano sui figli di un nodo da un'operazione come un nuovo figlio aggiunto tramite il metodo PushChild() o un figlio aggiornato tramite il metodo UpdateChildren() . Ognuno di questi insieme può essere utile per ascoltare le modifiche a un nodo specifico in un database. Ad esempio, un gioco potrebbe utilizzare questi metodi insieme per monitorare l'attività nei commenti di una sessione di gioco, come mostrato di seguito:
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);
Il callback OnChildAdded viene in genere utilizzato per recuperare un elenco di elementi in un database Firebase. Il callback OnChildAdded viene chiamato una volta per ogni figlio esistente e poi di nuovo ogni volta che un nuovo figlio viene aggiunto al percorso specificato. All'ascoltatore viene passata un'istantanea contenente i dati del nuovo figlio.
Il callback OnChildChanged viene chiamato ogni volta che un nodo figlio viene modificato. Ciò include qualsiasi modifica ai discendenti del nodo figlio. Viene in genere utilizzato insieme alle chiamate OnChildAdded e OnChildRemoved per rispondere alle modifiche a un elenco di elementi. Lo snapshot passato al listener contiene i dati aggiornati per il bambino.
La richiamata OnChildRemoved viene attivata quando viene rimosso un figlio immediato. Viene in genere utilizzato insieme ai callback OnChildAdded e OnChildChanged . Lo snapshot passato al callback contiene i dati per il figlio rimosso.
La richiamata OnChildMoved viene attivata ogni volta che la chiamata OnChildChanged viene generata da un aggiornamento che provoca il riordino dell'elemento figlio. Viene utilizzato con i dati ordinati con OrderByChild o OrderByValue .
Ordinamento e filtraggio dei dati
È possibile utilizzare la classe Realtime Database Query per recuperare i dati ordinati per chiave, valore o valore di un figlio. Puoi anche filtrare il risultato ordinato in base a un numero specifico di risultati o a un intervallo di chiavi o valori.
Ordina i dati
Per recuperare i dati ordinati, inizia specificando uno dei metodi order-by per determinare come vengono ordinati i risultati:
| Metodo | Utilizzo |
|---|---|
OrderByChild() | Ordina i risultati in base al valore di una chiave figlio specificata. | OrderByKey() | Ordina i risultati per chiavi figlio. |
OrderByValue() | Ordina i risultati in base ai valori secondari. |
Puoi utilizzare un solo metodo di ordine alla volta. La chiamata di un metodo order-by più volte nella stessa query genera un errore.
L'esempio seguente dimostra come iscriversi a una classifica dei punteggi ordinata per punteggio.
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.
Ciò definisce una firebase::Query che, se combinata con un ValueListener, sincronizza il client con la classifica nel database, ordinata in base al punteggio di ciascuna voce. Puoi leggere ulteriori informazioni su come strutturare i tuoi dati in modo efficiente in Struttura il tuo database .
La chiamata al metodo OrderByChild() specifica la chiave figlio in base alla quale ordinare i risultati. In questo caso, i risultati vengono ordinati in base al valore del "score" in ciascun figlio. Per ulteriori informazioni su come vengono ordinati gli altri tipi di dati, vedere Come vengono ordinati i dati delle query .
Filtraggio dei dati
Per filtrare i dati, è possibile combinare qualsiasi metodo di limite o intervallo con un metodo di ordinamento durante la costruzione 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 elementi maggiori o uguali alla chiave o al valore specificato a seconda del metodo di ordine scelto. |
EndAt() | Restituisce elementi inferiori o uguali alla chiave o al valore specificato a seconda del metodo di ordine scelto. |
EqualTo() | Restituisce elementi uguali alla chiave o al valore specificato a seconda del metodo di ordine scelto. |
A differenza dei metodi ordinati, è possibile 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 è pur sempre un elenco; contiene solo un singolo elemento.
Limita il numero di risultati
È possibile 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 archiviati nel tuo database Firebase, viene attivato un callback OnChildAdded per ciascun elemento.
Man mano che gli elementi cambiano, ricevi callback OnChildAdded per gli elementi che inseriscono la query e callback OnChildRemoved per gli elementi che ne escono, in modo che il numero totale rimanga su 100.
Ad esempio, il codice seguente restituisce il punteggio più alto da una classifica:
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.
Filtra per chiave o valore
È possibile utilizzare StartAt() , EndAt() e EqualTo() per scegliere punti di inizio, fine ed equivalenza arbitrari per le query. Ciò può essere utile per impaginare i dati o trovare elementi con elementi secondari che hanno un valore specifico.
Come vengono ordinati i dati della query
Questa sezione spiega come i dati vengono ordinati in base a ciascuno dei metodi order-by nella classe Query .
OrderByChild
Quando si utilizza OrderByChild() , i dati che contengono la chiave figlio specificata vengono ordinati come segue:
- I bambini con un valore
nullper la chiave figlio specificata vengono prima. - I figli con un valore
falseper la chiave figlio specificata vengono dopo. Se più figli hanno un valorefalse, vengono ordinati lessicograficamente per chiave. - I figli con un valore
trueper la chiave figlio specificata vengono dopo. Se più figli hanno un valoretrue, vengono ordinati lessicograficamente per chiave. - Seguono i bambini con un valore numerico, ordinati in ordine crescente. Se più figli hanno lo stesso valore numerico per il nodo figlio specificato, vengono ordinati per chiave.
- 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 lessicograficamente per chiave.
- Gli oggetti vengono per ultimi e sono ordinati lessicograficamente per chiave in ordine crescente.
OrderByKey
Quando si utilizza OrderByKey() per ordinare i dati, i dati vengono restituiti in ordine crescente per chiave.
- I figli con una chiave che può essere analizzata come intero a 32 bit vengono prima, ordinati in ordine crescente.
- Seguono i bambini con un valore stringa come chiave, ordinati lessicograficamente in ordine 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 per il fatto che viene utilizzato il valore del nodo anziché il valore di una chiave figlio specificata.