Google is committed to advancing racial equity for Black communities. See how.
Questa pagina è stata tradotta dall'API Cloud Translation.
Switch to English

Recupero dei dati con Firebase Realtime Database for C ++

Questo documento tratta 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 descritto nella Guida Get Started .

Recupero dati

I dati Firebase vengono recuperati tramite una chiamata una tantum a GetValue() o collegandoli 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 DatabaseReference

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 sola volta un'istantanea statica dei contenuti in un determinato percorso. Il risultato dell'attività conterrà un'istantanea 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();

Al punto la richiesta è stata fatta ma dobbiamo attendere il completamento del Future prima di poter leggere il valore. Poiché i giochi in genere vengono eseguiti in un ciclo e sono meno richiamati rispetto ad altre applicazioni, in genere eseguirai 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 firebase :: Future per ulteriori informazioni sul controllo degli errori e sui modi per determinare quando il risultato è pronto.

Ascolta gli eventi

Puoi aggiungere listener per iscriverti alle modifiche ai dati:

ValueListener base ValueListener

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

OnChildListener base OnChildListener

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

ValueListener classe

È possibile utilizzare i callback OnValueChanged per iscriversi alle modifiche ai contenuti in un determinato percorso. Questo callback viene attivato una volta quando il listener è collegato e di nuovo ogni volta che i dati, inclusi i figli, cambiano. Alla richiamata viene passata un'istantanea 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 rappresenta i dati.

In questo esempio, anche il metodo OnCancelled viene ignorato per vedere 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.

ChildListener classe

Gli eventi figlio vengono attivati ​​in risposta a operazioni specifiche che si verificano agli elementi figlio di un nodo da un'operazione come un nuovo figlio aggiunto tramite il metodo PushChild() o un figlio aggiornato tramite il metodo UpdateChildren() . Ciascuno 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 bambino.

Il callback OnChildChanged viene chiamato ogni volta che viene modificato un nodo figlio. 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.

Il callback OnChildRemoved viene attivato quando viene rimosso un figlio immediato. Viene in genere utilizzato insieme ai callback OnChildAdded e OnChildChanged . Lo snapshot passato alla richiamata contiene i dati per il bambino rimosso.

Il callback OnChildMoved viene attivato ogni volta che la chiamata OnChildChanged viene OnChildChanged 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, valore o valore di un figlio. È inoltre possibile 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. La chiamata di 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, se combinata con un ValueListener, sincronizza il client con la classifica nel database, ordinata in base al punteggio di ogni voce. Puoi leggere ulteriori informazioni sulla strutturazione dei dati in modo efficiente in Struttura del database .

La chiamata al metodo OrderByChild() specifica la chiave figlia in base alla quale ordinare i risultati. In questo caso, i risultati vengono ordinati in base al valore del valore "score" in ogni figlio. Per ulteriori informazioni su come vengono ordinati altri tipi di dati, vedere come vengono ordinati i dati delle query .

Filtraggio dei dati

Per filtrare i dati, è possibile combinare uno qualsiasi dei metodi limite o intervallo 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 di risultati ordinato.
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 ordinamento scelto.
EndAt() Restituisci elementi minori o uguali alla chiave o al valore specificato a seconda del metodo di ordinamento scelto.
EqualTo() Restituisce elementi uguali alla chiave o al valore specificato a seconda del metodo di ordinamento scelto.

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

Anche quando esiste una sola corrispondenza per la query, l'istantanea è comunque 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 LimitToLast() da sincronizzare per un determinato callback. Ad esempio, se utilizzi LimitToFirst() per impostare un limite di 100, inizialmente ricevi solo fino a 100 callback OnChildAdded . Se hai meno di 100 elementi memorizzati nel tuo database Firebase, un callback OnChildAdded per ogni elemento.

Man mano che gli elementi cambiano, ricevi callback OnChildAdded per gli elementi che entrano nella query e callback 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 e equivalenza arbitrari per le query. Ciò 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 figlia specificata vengono prima.
  2. I figli con un valore false per la chiave figlio specificata vengono dopo. Se più elementi secondari hanno un valore false , vengono ordinati lessicograficamente per chiave.
  3. I figli con un valore true per la chiave figlio specificata vengono dopo. Se più elementi secondari 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 arrivano 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 numero 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 figli vengono ordinati in base al loro valore. I criteri di ordinamento sono gli stessi di OrderByChild() , tranne per il fatto che il valore del nodo viene utilizzato al posto del valore di una chiave figlio specificata.

Prossimi passi