Recupero dei dati in corso...

Questo documento illustra le nozioni di base sul recupero dei dati e su come ordinare e filtrare i dati di Firebase.

Prima di iniziare

Prima di poter utilizzare Realtime Database, devi:

  • Registra il tuo progetto Unity e configuralo in modo che utilizzi Firebase.

    • Se il tuo progetto Unity utilizza già Firebase, è già registrato e configurato per Firebase.

    • Se non hai un progetto Unity, puoi scaricare un'app di esempio.

  • Aggiungi l'SDK Firebase Unity (in particolare FirebaseDatabase.unitypackage) al tuo progetto Unity.

Tieni presente che l'aggiunta di Firebase al progetto Unity comporta attività sia nella console Firebase sia nel progetto Unity aperto (ad esempio, scarichi i file di configurazione di Firebase dalla console, quindi li sposti nel progetto Unity).

Recupero dei dati

I dati di Firebase vengono recuperati tramite una chiamata una tantum a GetValueAsync() o tramite l'associazione a un evento su un riferimento FirebaseDatabase. L'ascoltatore di eventi viene chiamato una volta per lo stato iniziale dei dati e di nuovo ogni volta che i dati cambiano.

Recuperare un DatabaseReference

Per leggere i dati dal database, è necessaria un'istanza di DatabaseReference:

using Firebase;
using Firebase.Database;
using Firebase.Extensions.TaskExtension; // for ContinueWithOnMainThread

public class MyScript: MonoBehaviour {
  void Start() {
    // Get the root reference location of the database.
    DatabaseReference reference = FirebaseDatabase.DefaultInstance.RootReference;
  }
}

Leggi i dati una volta

Puoi utilizzare il metodo GetValueAsync per leggere un'istantanea statica dei contenuti in un determinato percorso una volta sola. 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.

    FirebaseDatabase.DefaultInstance
      .GetReference("Leaders")
      .GetValueAsync().ContinueWithOnMainThread(task => {
        if (task.IsFaulted) {
          // Handle the error...
        }
        else if (task.IsCompleted) {
          DataSnapshot snapshot = task.Result;
          // Do something with snapshot...
        }
      });

Ascolta gli eventi

Puoi aggiungere ascoltatori di eventi per iscriverti alle modifiche ai dati:

Evento Utilizzo tipico
ValueChanged Leggere e ascoltare le modifiche a tutti i contenuti di un percorso.
ChildAdded Recupera elenchi di elementi o ascolta le aggiunte a un elenco di elementi. Utilizzo consigliato con ChildChanged e ChildRemoved per monitorare le modifiche agli elenchi.
ChildChanged Rileva le modifiche agli elementi di un elenco. Da utilizzare con ChildAdded e ChildRemoved per monitorare le modifiche agli elenchi.
ChildRemoved Ascolta gli elementi che vengono rimossi da un elenco. Da utilizzare con ChildAdded e ChildChanged per monitorare le modifiche agli elenchi.
ChildMoved Rileva le modifiche all'ordine degli elementi in un elenco ordinato. Gli eventi ChildMoved seguono sempre l'evento ChildChanged che ha causato la modifica dell'ordine dell'elemento (in base al metodo di ordinamento corrente).

Evento ValueChanged

Puoi utilizzare l'evento ValueChanged per iscriverti alle modifiche dei contenuti in un determinato percorso. Questo evento viene attivato una volta quando l'ascoltatore è collegato e di nuovo ogni volta che i dati, inclusi i bambini, cambiano. Al callback dell'evento 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:

      FirebaseDatabase.DefaultInstance
        .GetReference("Leaders")
        .ValueChanged += HandleValueChanged;
    }

    void HandleValueChanged(object sender, ValueChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

ValueChangedEventArgs contiene un DataSnapshot che contiene i dati nella posizione specificata nel database al momento dell'evento. La chiamata a Value su uno snapshot restituisce un Dictionary<string, object> che rappresenta i dati. Se non esistono dati nella posizione, la chiamata a Value restituisce null.

In questo esempio, viene esaminato anche args.DatabaseError per verificare se la lettura è stata annullata. Ad esempio, una lettura può essere annullata se il client non ha l'autorizzazione per leggere da una posizione del database Firebase. L'DatabaseError indicherà il motivo dell'errore.

In un secondo momento puoi annullare l'iscrizione all'evento utilizzando qualsiasi DatabaseReference con lo stesso percorso. Le istanze DatabaseReference sono effimere e possono essere considerate come un modo per accedere a qualsiasi percorso e query.

      FirebaseDatabase.DefaultInstance
        .GetReference("Leaders")
        .ValueChanged -= HandleValueChanged; // unsubscribe from ValueChanged.
    }

Eventi secondari

Gli eventi secondari vengono attivati in risposta a operazioni specifiche che si verificano nei figli di un nodo da un'operazione, ad esempio un nuovo figlio aggiunto tramite il metodo Push() o un figlio aggiornato tramite il metodo UpdateChildrenAsync(). Insieme, questi elementi possono essere utili per ascoltare le modifiche apportate a un node 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:

      var ref = FirebaseDatabase.DefaultInstance
      .GetReference("GameSessionComments");

      ref.ChildAdded += HandleChildAdded;
      ref.ChildChanged += HandleChildChanged;
      ref.ChildRemoved += HandleChildRemoved;
      ref.ChildMoved += HandleChildMoved;
    }

    void HandleChildAdded(object sender, ChildChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

    void HandleChildChanged(object sender, ChildChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

    void HandleChildRemoved(object sender, ChildChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

    void HandleChildMoved(object sender, ChildChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

L'evento ChildAdded viene in genere utilizzato per recuperare un elenco di elementi in un database Firebase. L'evento ChildAdded 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. All'ascoltatore viene passato uno snapshot contenente i dati del nuovo bambino.

L'evento ChildChanged viene attivato ogni volta che un nodo secondario viene modificato. Sono incluse eventuali modifiche ai discendenti del nodo figlio. Viene solitamente utilizzato in combinazione con gli eventi ChildAdded e ChildRemoved per rispondere alle modifiche a un elenco di articoli. Lo snapshot passato all'ascoltatore di eventi contiene i dati aggiornati dell'elemento secondario.

L'evento ChildRemoved viene attivato quando viene rimosso un elemento figlio immediato. Viene in genere utilizzato in combinazione con i callback ChildAdded e ChildChanged. Lo snapshot passato al callback dell'evento contiene i dati dell'elemento secondario rimosso.

L'evento ChildMoved viene attivato ogni volta che l'evento ChildChanged viene generato da un aggiornamento che causa il riordinamento del figlio. Viene utilizzato con i dati ordinati con OrderByChild o OrderByValue.

Ordinamento e filtri dei dati

Puoi utilizzare la classe Realtime Database Query per recuperare i dati ordinati per chiave, valore o 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.

Ordinare i dati

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

Metodo Utilizzo
OrderByChild() Ordina i risultati in base al valore di una chiave secondaria specificata.
OrderByKey() Ordina i risultati per 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 di ordinamento più volte nella stessa query genera un errore.

L'esempio seguente mostra come abbonarti a una classifica con punteggio ordinata in base al punteggio.

      FirebaseDatabase.DefaultInstance
        .GetReference("Leaders").OrderByChild("score")
        .ValueChanged += HandleValueChanged;
    }

    void HandleValueChanged(object sender, ValueChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

Questa definisce una query che, se combinata con un listener di eventi valuechanged, sincronizza il client con la classifica nel database, ordinata in base al punteggio di ogni voce. Puoi scoprire di più su come strutturare i dati in modo efficiente in Strutturare il database.

La chiamata al metodo OrderByChild() specifica la chiave secondaria in base alla quale ordinare i risultati. In questo caso, i risultati vengono ordinati in base al valore del valore "score" in ogni elemento secondario. Per ulteriori informazioni sull'ordinamento di altri tipi di dati, consulta Come vengono ordinati i dati delle query.

Filtrare i dati

Per filtrare i dati, puoi combinare uno 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 dei risultati.
LimitToLast() Imposta il numero massimo di elementi da restituire dalla fine dell'elenco ordinato dei risultati.
StartAt() Restituisce gli elementi maggiori o uguali alla chiave o al 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.
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 se esiste una sola corrispondenza per la query, lo snapshot è comunque un elenco, ma contiene un solo elemento.

Limita il numero di risultati

Puoi utilizzare i metodi LimitToFirst() e LimitToLast() per impostare un numero massimo di elementi secondari da sincronizzare per un determinato callback. Ad esempio, se utilizzi LimitToFirst() per impostare un limite di 100, inizialmente riceverai fino a 100 callback LimitToFirst().ChildAdded Se hai meno di 100 elementi archiviati nel database Firebase, viene attivato un callback ChildAdded per ogni elemento.

Quando gli elementi cambiano, ricevi ChildAdded callback per gli elementi che entrano nella query e ChildRemoved callback per gli elementi che ne escono, in modo che il numero totale rimanga 100.

Ad esempio, il codice seguente restituisce il punteggio più alto di una classifica:

      FirebaseDatabase.DefaultInstance
        .GetReference("Leaders").OrderByChild("score").LimitToLast(1)
        .ValueChanged += HandleValueChanged;
    }

    void HandleValueChanged(object sender, ValueChangedEventArgs args) {
      if (args.DatabaseError != null) {
        Debug.LogError(args.DatabaseError.Message);
        return;
      }
      // Do something with the data in args.Snapshot
    }

Filtra per chiave o valore

Puoi utilizzare StartAt(), EndAt() e EqualTo() per scegliere punti di inizio, di fine ed equivalenza arbitrari per le query. Questo può essere utile per eseguire la paginazione dei dati o trovare elementi con 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 della classe Query.

OrderByChild

Quando utilizzi OrderByChild(), i dati che contengono la chiave secondaria specificata sono ordinati come segue:

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

OrderByKey

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

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

OrderByValue

Quando utilizzi OrderByValue(), gli elementi secondari 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 secondaria specificata.