Lavora con elenchi di dati su piattaforme Apple

Ottenere un FIRDatabaseReference

Per leggere o scrivere dati dal database, è necessaria un'istanza di FIRDatabaseReference :

Rapido

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
var ref: DatabaseReference!

ref = Database.database().reference()

Obiettivo-C

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
@property (strong, nonatomic) FIRDatabaseReference *ref;

self.ref = [[FIRDatabase database] reference];

Liste di lettura e scrittura

Aggiungi a un elenco di dati

Utilizzare il metodo childByAutoId per aggiungere dati a un elenco nelle applicazioni multiutente. Il metodo childByAutoId genera una chiave univoca ogni volta che viene aggiunto un nuovo figlio al riferimento Firebase specificato. Utilizzando queste chiavi generate automaticamente per ogni nuovo elemento nell'elenco, diversi client possono aggiungere figli alla stessa posizione contemporaneamente senza conflitti di scrittura. La chiave univoca generata da childByAutoId si basa su un timestamp, quindi gli elementi dell'elenco vengono automaticamente ordinati cronologicamente.

È possibile usare il riferimento ai nuovi dati restituiti dal metodo childByAutoId per ottenere il valore della chiave generata automaticamente dell'elemento figlio o impostare i dati per l'elemento figlio. La chiamata getKey su un riferimento childByAutoId restituisce la chiave generata automaticamente.

Puoi utilizzare queste chiavi generate automaticamente per semplificare l'appiattimento della struttura dei dati. Per ulteriori informazioni, vedere l' esempio di fan-out dei dati .

Ascolta gli eventi figlio

Gli eventi figlio vengono attivati ​​in risposta a operazioni specifiche che si verificano sugli elementi figlio di un nodo da un'operazione, ad esempio un nuovo elemento figlio aggiunto tramite il metodo childByAutoId o un elemento figlio aggiornato tramite il metodo updateChildValues .

Tipo di evento Uso tipico
FIRDataEventTypeChildAdded Recupera elenchi di elementi o ascolta le aggiunte a un elenco di elementi. Questo evento viene attivato 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.
FIRDataEventTypeChildChanged Ascolta le modifiche agli elementi in un elenco. Questo evento viene attivato ogni volta che viene modificato un nodo figlio. Ciò include qualsiasi modifica ai discendenti del nodo figlio. Lo snapshot passato al listener di eventi contiene i dati aggiornati per il figlio.
FIRDataEventTypeChildRemoved Ascolta gli elementi che vengono rimossi da un elenco. Questo evento viene attivato quando un figlio immediato viene rimosso. Lo snapshot passato al blocco di callback contiene i dati per il figlio rimosso.
FIRDataEventTypeChildMoved Ascolta le modifiche all'ordine degli elementi in un elenco ordinato. Questo evento viene attivato ogni volta che un aggiornamento provoca il riordino del figlio. Viene utilizzato con i dati ordinati da queryOrderedByChild o queryOrderedByValue .

Ognuno di questi insieme può essere utile per ascoltare le modifiche a un nodo specifico in un database. Ad esempio, un'app di social blogging potrebbe utilizzare questi metodi insieme per monitorare l'attività nei commenti di un post, come mostrato di seguito:

Rapido

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
// Listen for new comments in the Firebase database
commentsRef.observe(.childAdded, with: { (snapshot) -> Void in
  self.comments.append(snapshot)
  self.tableView.insertRows(
    at: [IndexPath(row: self.comments.count - 1, section: self.kSectionComments)],
    with: UITableView.RowAnimation.automatic
  )
})
// Listen for deleted comments in the Firebase database
commentsRef.observe(.childRemoved, with: { (snapshot) -> Void in
  let index = self.indexOfMessage(snapshot)
  self.comments.remove(at: index)
  self.tableView.deleteRows(
    at: [IndexPath(row: index, section: self.kSectionComments)],
    with: UITableView.RowAnimation.automatic
  )
})

Obiettivo-C

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
// Listen for new comments in the Firebase database
[_commentsRef
              observeEventType:FIRDataEventTypeChildAdded
              withBlock:^(FIRDataSnapshot *snapshot) {
                [self.comments addObject:snapshot];
                [self.tableView insertRowsAtIndexPaths:@[
                  [NSIndexPath indexPathForRow:self.comments.count - 1 inSection:kSectionComments]
                ]
                                      withRowAnimation:UITableViewRowAnimationAutomatic];
              }];
// Listen for deleted comments in the Firebase database
[_commentsRef
 observeEventType:FIRDataEventTypeChildRemoved
 withBlock:^(FIRDataSnapshot *snapshot) {
   int index = [self indexOfMessage:snapshot];
   [self.comments removeObjectAtIndex:index];
   [self.tableView deleteRowsAtIndexPaths:@[[NSIndexPath indexPathForRow:index inSection:kSectionComments]]
                         withRowAnimation:UITableViewRowAnimationAutomatic];
 }];

Ascolta gli eventi di valore

Mentre l'ascolto di eventi figlio è il modo consigliato per leggere elenchi di dati, ci sono situazioni in cui l'ascolto di eventi valore su un riferimento elenco è utile.

L'associazione di un osservatore FIRDataEventTypeValue a un elenco di dati restituirà l'intero elenco di dati come un singolo DataSnapshot, che è quindi possibile eseguire il ciclo per accedere ai singoli elementi figlio.

Anche quando c'è solo una singola corrispondenza per la query, lo snapshot è ancora un elenco; contiene solo un singolo elemento. Per accedere all'elemento, è necessario eseguire il ciclo sul risultato:

Rapido

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
_commentsRef.observe(.value) { snapshot in
  for child in snapshot.children {
    ...
  }
}

Obiettivo-C

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
[_commentsRef
              observeEventType:FIRDataEventTypeValue
              withBlock:^(FIRDataSnapshot *snapshot) {
                // Loop over children
                NSEnumerator *children = [snapshot children];
                FIRDataSnapshot *child;
                while (child = [children nextObject]) {
                  // ...
                }
              }];

Questo modello può essere utile quando si desidera recuperare tutti gli elementi secondari di un elenco in un'unica operazione, piuttosto che attendere ulteriori eventi secondari aggiunti.

Ordinamento e filtraggio dei dati

È possibile utilizzare la classe Realtime Database FIRDatabaseQuery 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, iniziare specificando uno dei metodi order-by per determinare come vengono ordinati i risultati:

Metodo Utilizzo
queryOrderedByKey Ordina i risultati per chiavi figlio.
queryOrderedByValue Ordina i risultati per valori figlio.
queryOrderedByChild Ordina i risultati in base al valore di una chiave figlio specificata o di un percorso figlio nidificato.

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

L'esempio seguente mostra come recuperare un elenco dei post principali di un utente ordinati in base al numero di stelle:

Rapido

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
// My top posts by number of stars
let myTopPostsQuery = ref.child("user-posts").child(getUid()).queryOrdered(byChild: "starCount")

Obiettivo-C

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
// My top posts by number of stars
FIRDatabaseQuery *myTopPostsQuery = [[[self.ref child:@"user-posts"]
                                      child:[super getUid]]
                                     queryOrderedByChild:@"starCount"];

Questa query recupera i post dell'utente dal percorso nel database in base al suo ID utente, ordinato in base al numero di stelle che ogni post ha ricevuto. Questa tecnica di utilizzo degli ID come chiavi di indice è chiamata data fan out, puoi leggere ulteriori informazioni in Structure Your Database .

La chiamata al metodo queryOrderedByChild specifica la chiave figlio in base alla quale ordinare i risultati. In questo esempio, i post sono ordinati in base al valore del figlio "starCount" in ogni post. Le query possono anche essere ordinate per figli nidificati, nel caso in cui si disponga di dati simili a questi:

"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 caso, possiamo ordinare gli elementi della nostra lista in base ai valori nidificati sotto la chiave metrics specificando il percorso relativo al figlio nidificato nella nostra chiamata queryOrderedByChild .

Rapido

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
 
let postsByMostPopular = ref.child("posts").queryOrdered(byChild: "metrics/views")

Obiettivo-C

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
 
FIRDatabaseQuery *postsByMostPopular = [[ref child:@"posts"] queryOrderedByChild:@"metrics/views"];

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, puoi combinare qualsiasi metodo limit o range con un metodo order-by durante la costruzione di una query.

Metodo Utilizzo
queryLimitedToFirst Imposta il numero massimo di elementi da restituire dall'inizio dell'elenco ordinato di risultati.
queryLimitedToLast Imposta il numero massimo di elementi da restituire dalla fine dell'elenco ordinato di risultati.
queryStartingAtValue Restituisce elementi maggiori o uguali alla chiave o al valore specificato, a seconda del metodo di ordinazione scelto.
queryStartingAfterValue Restituisce elementi maggiori della chiave o del valore specificato, a seconda del metodo di ordinazione scelto.
queryEndingAtValue Restituisce gli elementi inferiori o uguali alla chiave o al valore specificato, a seconda del metodo di ordinazione scelto.
queryEndingBeforeValue Restituisce gli elementi inferiori alla chiave o al valore specificato, a seconda del metodo di ordinazione scelto.
queryEqualToValue Restituisce elementi uguali alla chiave o al valore specificato, a seconda del metodo di ordinazione scelto.

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

Limita il numero di risultati

È possibile utilizzare i metodi queryLimitedToFirst e queryLimitedToLast per impostare un numero massimo di elementi figlio da sincronizzare per un determinato callback. Ad esempio, se utilizzi queryLimitedToFirst per impostare un limite di 100, inizialmente riceverai solo fino a 100 callback FIRDataEventTypeChildAdded . Se hai meno di 100 elementi archiviati nel database Firebase, viene attivata una richiamata FIRDataEventTypeChildAdded per ciascun elemento.

Man mano che gli elementi cambiano, ricevi callback FIRDataEventTypeChildAdded per gli elementi che accedono alla query e FIRDataEventTypeChildRemoved callback per gli elementi che ne escono in modo che il numero totale rimanga a 100.

L'esempio seguente mostra come un'app di blog di esempio potrebbe recuperare un elenco dei 100 post più recenti di tutti gli utenti:

Rapido

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys
let recentPostsQuery = (ref?.child("posts").queryLimited(toFirst: 100))!

Obiettivo-C

Nota: questo prodotto Firebase non è disponibile nel target App Clip.
// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys
FIRDatabaseQuery *recentPostsQuery = [[self.ref child:@"posts"] queryLimitedToFirst:100];

Filtra per chiave o valore

È possibile utilizzare queryStartingAtValue , queryStartingAfterValue , queryEndingAtValue , queryEndingBeforeValue e queryEqualToValue per scegliere punti iniziali, finali e di 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 delle query

Questa sezione spiega come i dati vengono ordinati da ciascuno dei metodi order-by nella classe FIRDatabaseQuery .

queryOrderedByKey

Quando si utilizza queryOrderedByKey per ordinare i dati, i dati vengono restituiti in ordine crescente per chiave.

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

queryOrderedByValue

Quando si utilizza queryOrderedByValue , gli elementi figlio vengono ordinati in base al relativo valore. I criteri di ordinamento sono gli stessi di queryOrderedByChild , tranne per il fatto che viene utilizzato il valore del nodo anziché il valore di una chiave figlio specificata.

queryOrderedByChild

Quando si utilizza queryOrderedByChild , i dati che contengono la chiave figlio specificata vengono ordinati come segue:

  1. Gli elementi figlio con un valore nil per la chiave figlio specificata vengono per primi.
  2. I bambini con un valore false per la chiave figlio specificata vengono dopo. Se più figli hanno un valore false , vengono ordinati lessicograficamente per chiave.
  3. I bambini con un valore true per la chiave figlio specificata vengono dopo. Se più figli hanno un valore true , vengono ordinati lessicograficamente per chiave.
  4. 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.
  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.

Distacca gli ascoltatori

Gli osservatori non interrompono automaticamente la sincronizzazione dei dati quando lasci un ViewController . Se un osservatore non viene rimosso correttamente, continua a sincronizzare i dati nella memoria locale e manterrà tutti gli oggetti acquisiti nella chiusura del gestore eventi, che possono causare perdite di memoria. Quando un osservatore non è più necessario, rimuoverlo passando il FIRDatabaseHandle associato al metodo removeObserverWithHandle .

Quando aggiungi un blocco di callback a un riferimento, viene restituito un FIRDatabaseHandle . Questi handle possono essere utilizzati per rimuovere il blocco di callback.

Se sono stati aggiunti più listener a un riferimento al database, ogni listener viene chiamato quando viene generato un evento. Per interrompere la sincronizzazione dei dati in quella posizione, è necessario rimuovere tutti gli osservatori in una posizione chiamando il metodo removeAllObservers .

Chiamare removeObserverWithHandle o removeAllObservers su un listener non rimuove automaticamente i listener registrati sui suoi nodi figlio; devi anche tenere traccia di quei riferimenti o handle per rimuoverli.

Prossimi passi