Recupero dei dati con Firebase Realtime Database per C++

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Questo documento illustra le nozioni di base sul recupero dei dati e su come ordinare e filtrare i dati di 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 valore listener 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();

Leggi i dati una volta

È possibile utilizzare il metodo GetValue() per leggere un'istantanea statica del contenuto in un determinato percorso una volta. Il risultato dell'attività conterrà uno snapshot contenente tutti i dati in quella posizione, inclusi i dati figlio. Se non sono presenti dati, lo snapshot restituito è null .

  firebase::Future<firebase::database::DataSnapshot> result =
    dbRef.GetReference("Leaders").GetValue();

A quel punto la richiesta è stata fatta ma dobbiamo aspettare che il Futuro si completi 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 esegui 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, vedere il riferimento di 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

Richiama Utilizzo tipico
OnValueChanged Leggere e ascoltare le modifiche all'intero contenuto di un percorso.

Classe base OnChildListener

OnChildAdded Recupera elenchi di elementi o ascolta le 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 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 di OnChildMoved seguono sempre i callback di OnChildChanged a causa della modifica dell'ordine dell'articolo (in base al metodo order-by corrente).

Classe ValueListener

È possibile utilizzare i callback di 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. Al callback viene passato 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&ltDataSnaphot&gt contiene i dati nella posizione specificata nel database al momento dell'evento. La chiamata a value() su uno snapshot restituisce una Variant che rappresenta i dati.

In questo esempio, viene eseguito l'override anche 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 Child Listener

Gli eventi figlio vengono attivati ​​in risposta a operazioni specifiche che si verificano ai 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);

La richiamata OnChildAdded viene in genere utilizzata 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 viene aggiunto un nuovo figlio al percorso specificato. Al listener viene passato uno snapshot contenente i dati del nuovo figlio.

Il callback OnChildChanged viene chiamato ogni volta che viene modificato un nodo figlio. Ciò include eventuali modifiche 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 all'ascoltatore contiene i dati aggiornati per il figlio.

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.

Il callback OnChildMoved viene attivato ogni volta che la chiamata OnChildChanged viene generata da un aggiornamento che causa il riordino del 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, per valore o per 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 per valori figlio.

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

L'esempio seguente mostra 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.

Questo definisce una firebase::Query che, combinata con un ValueListener, sincronizza il client con la classifica nel database, ordinata in base al punteggio di ciascuna voce. Puoi leggere di più su come strutturare i tuoi dati in modo efficiente in Structure Your 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 ogni figlio. Per ulteriori informazioni su come vengono ordinati altri tipi di dati, vedere Come vengono ordinati i dati della query .

Filtraggio dei dati

Per filtrare i dati, puoi combinare qualsiasi metodo limit o range con un metodo order-by 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 di risultati ordinato.
StartAt() Restituisci articoli maggiori o uguali alla chiave o al valore specificato a seconda del metodo di ordinazione scelto.
EndAt() Restituisci articoli inferiori o uguali alla chiave o al valore specificato a seconda del metodo di ordinazione scelto.
EqualTo() Restituisci articoli uguali alla chiave o al valore specificato a seconda del metodo di ordinazione scelto.

A differenza dei metodi order-by, puoi combinare più funzioni di limite o intervallo. Ad esempio, puoi combinare i StartAt() ed EndAt() per limitare i risultati a un intervallo di valori specificato.

Anche quando c'è una sola corrispondenza per la query, lo snapshot è ancora un elenco; contiene solo un singolo elemento.

Limita il numero di risultati

È possibile utilizzare i LimitToFirst() e LimitToLast() per impostare un numero massimo di elementi figlio 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 nel database di Firebase sono archiviati meno di 100 elementi, viene attivata una richiamata OnChildAdded per ciascun elemento.

Man mano che gli elementi cambiano, ricevi le richiamate di OnChildAdded per gli elementi che entrano nella query e le richiamate di OnChildRemoved per gli elementi che escono da essa in modo che il numero totale rimanga a 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. Questo può essere utile per impaginare i dati o trovare elementi con figli 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:

  1. I bambini con un valore null per la chiave figlio specificata vengono prima.
  2. Seguono i figli con un valore false per la chiave figlio specificata. Se più figli hanno un valore di false , vengono ordinati lessicograficamente per chiave.
  3. I figli con un valore true per la chiave figlio specificata vengono dopo. Se più figli hanno un valore true , vengono ordinati lessicograficamente per chiave.
  4. I bambini con un valore numerico vengono dopo, ordinati in ordine crescente. Se più figli hanno lo stesso valore numerico per il nodo figlio 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 lessicograficamente per chiave.
  6. 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.

  1. I bambini con una chiave che può essere analizzata come un intero a 32 bit vengono prima, ordinati in ordine crescente.
  2. I bambini con un valore stringa come chiave vengono dopo, 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 invece del valore di una chiave figlio specificata.

Prossimi passi