Daten auf Apple-Plattformen lesen und schreiben

(Optional) Prototypen erstellen und mit Firebase Local Emulator Suite testen

Bevor wir darauf eingehen, wie Ihre App Daten aus Realtime Databaseliest und in sie schreibt, stellen wir Ihnen eine Reihe von Tools vor, mit denen Sie die Funktionen von Realtime Database prototypisieren und testen können: Firebase Local Emulator Suite. Wenn Sie verschiedene Datenmodelle ausprobieren, Ihre Sicherheitsregeln optimieren oder nach der kostengünstigsten Möglichkeit suchen, mit dem Backend zu interagieren, kann es eine gute Idee sein, lokal zu arbeiten, ohne Live-Dienste bereitzustellen.

Ein Realtime Database Emulator ist Teil der Local Emulator Suite, mit der Ihre App mit dem emulierten Datenbankinhalt und der emulierten Konfiguration sowie optional mit den emulierten Projektressourcen (Funktionen, anderen Datenbanken und Sicherheitsregeln) interagieren kann.

Die Verwendung des Realtime Database Emulators umfasst nur wenige Schritte:

1. Fügen Sie der Testkonfiguration Ihrer App eine Codezeile hinzu, um eine Verbindung zum Emulator herzustellen.
2. Führen Sie im Stammverzeichnis Ihres lokalen Projektverzeichnisses firebase emulators:start aus.
3. Rufen Sie den Prototypcode Ihrer App mit einem Realtime Database Plattform SDK wie gewohnt auf oder verwenden Sie die Realtime Database REST API.

Eine detaillierte Anleitung zur Verwendung von Realtime Database und Cloud Functions ist verfügbar. Sehen Sie sich auch die Local Emulator Suite Einführung an.

FIRDatabaseReference abrufen

Wenn Sie Daten aus der Datenbank lesen oder in sie schreiben möchten, benötigen Sie eine Instanz von FIRDatabaseReference:

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

var ref: DatabaseReference!

ref = Database.database().reference()

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

@property (strong, nonatomic) FIRDatabaseReference *ref;

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

Daten schreiben

In diesem Dokument werden die Grundlagen zum Lesen und Schreiben von Firebase-Daten behandelt.

Firebase-Daten werden in eine Database-Referenz geschrieben und abgerufen, indem ein asynchroner Listener an die Referenz angehängt wird. Der Listener wird einmal für den anfänglichen Status der Daten und dann bei jeder Änderung der Daten ausgelöst.

Hinweis: Standardmäßig ist der Lese- und Schreibzugriff auf Ihre Datenbank eingeschränkt, sodass nur authentifizierte Nutzer Daten lesen oder schreiben können. Wenn Sie ohne Einrichtung von Authentication beginnen möchten, können Sie Ihre Regeln für den öffentlichen Zugriff konfigurieren. Dadurch wird Ihre Datenbank für alle geöffnet, auch für Personen, die Ihre App nicht verwenden. Schränken Sie den Zugriff auf Ihre Datenbank daher wieder ein, wenn Sie die Authentifizierung einrichten.

Grundlegende Schreibvorgänge

Für grundlegende Schreibvorgänge können Sie mit setValue Daten in einer bestimmten Referenz speichern und alle vorhandenen Daten an diesem Pfad ersetzen. Sie können diese Methode für Folgendes verwenden:

• Übergeben Sie Typen, die den verfügbaren JSON-Typen entsprechen:
  • NSString
  • NSNumber
  • NSDictionary
  • NSArray

Mit setValue können Sie beispielsweise einen Nutzer wie folgt hinzufügen:

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

self.ref.child("users").child(user.uid).setValue(["username": username])

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

[[[self.ref child:@"users"] child:authResult.user.uid]
    setValue:@{@"username": username}];

Wenn Sie setValue auf diese Weise verwenden, werden Daten am angegebenen Speicherort überschrieben, einschließlich aller untergeordneten Knoten. Sie können jedoch weiterhin ein untergeordnetes Element aktualisieren, ohne das gesamte Objekt neu zu schreiben. Wenn Sie Nutzern erlauben möchten, ihre Profile zu aktualisieren, können Sie den Nutzernamen wie folgt aktualisieren:

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

self.ref.child("users/\(user.uid)/username").setValue(username)

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

[[[[_ref child:@"users"] child:user.uid] child:@"username"] setValue:username];

Daten lesen

Daten lesen, indem Sie auf Wertänderungen reagieren

Wenn Sie Daten an einem Pfad lesen und auf Änderungen reagieren möchten, verwenden Sie observeEventType:withBlock von FIRDatabaseReference, um FIRDataEventTypeValue-Ereignisse zu beobachten.

Ereignistyp	Typische Verwendung
FIRDataEventTypeValue	Änderungen am gesamten Inhalt eines Pfads lesen und beobachten.

Mit dem Ereignis FIRDataEventTypeValue können Sie die Daten an einem bestimmten Pfad so lesen, wie sie zum Zeitpunkt des Ereignisses vorhanden sind. Diese Methode wird einmal ausgelöst, wenn der Listener angehängt wird, und dann jedes Mal, wenn sich die Daten ändern, einschließlich aller untergeordneten Elemente. Der Ereignis-Callback erhält einen snapshot, der alle Daten an diesem Speicherort enthält, einschließlich der untergeordneten Daten. Wenn keine Daten vorhanden sind, gibt der Snapshot false zurück, wenn Sie exists() aufrufen, und nil, wenn Sie die Eigenschaft value lesen.

Wichtig: Das FIRDataEventTypeValue Ereignis wird jedes Mal ausgelöst, wenn Daten in der angegebenen Datenbankreferenz geändert werden, einschließlich Änderungen an untergeordneten Elementen. Um die Größe Ihrer Snapshots zu begrenzen, hängen Sie Listener nur auf der höchsten Ebene an, die für die Beobachtung von Änderungen erforderlich ist. Es wird beispielsweise nicht empfohlen, einen Listener an das Stammverzeichnis Ihrer Datenbank anzuhängen.

Im folgenden Beispiel ruft eine Social-Blogging-App die Details eines Beitrags aus der Datenbank ab:

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

refHandle = postRef.observe(DataEventType.value, with: { snapshot in
  // ...
})

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

_refHandle = [_postRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot * _Nonnull snapshot) {
  NSDictionary *postDict = snapshot.value;
  // ...
}];

Der Listener erhält einen FIRDataSnapshot, der die Daten am angegebenen Speicherort in der Datenbank zum Zeitpunkt des Ereignisses in der Eigenschaft value enthält. Sie können die Werte dem entsprechenden nativen Typ zuweisen, z. B. NSDictionary. Wenn am Speicherort keine Daten vorhanden sind, ist value gleich nil.

Daten einmal lesen

Einmal mit getData() lesen

Das SDK wurde entwickelt, um Interaktionen mit Datenbankservern zu verwalten, unabhängig davon, ob Ihre App online oder offline ist.

Im Allgemeinen sollten Sie die oben beschriebenen Techniken für Wertänderungen verwenden, um Daten zu lesen und über Aktualisierungen der Daten vom Backend benachrichtigt zu werden. Diese Techniken reduzieren die Nutzung und die Abrechnung und sind so optimiert, dass Ihre Nutzer die bestmögliche Erfahrung haben, wenn sie online und offline sind.

Wenn Sie die Daten nur einmal benötigen, können Sie mit getData() einen Snapshot der Daten aus der Datenbank abrufen. Wenn getData() aus irgendeinem Grund den Serverwert nicht zurückgeben kann, prüft der Client den lokalen Speicher-Cache und gibt einen Fehler zurück, wenn der Wert immer noch nicht gefunden wird.

Im folgenden Beispiel wird der öffentlich sichtbare Nutzername eines Nutzers einmal aus der Datenbank abgerufen:

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

do {
  let snapshot = try await ref.child("users/\(uid)/username").getData()
  let userName = snapshot.value as? String ?? "Unknown"
} catch {
  print(error)
}

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

NSString *userPath = [NSString stringWithFormat:@"users/%@/username", uid];
[[ref child:userPath] getDataWithCompletionBlock:^(NSError * _Nullable error, FIRDataSnapshot * _Nonnull snapshot) {
  if (error) {
    NSLog(@"Received an error %@", error);
    return;
  }
  NSString *userName = snapshot.value;
}];

Die unnötige Verwendung von getData() kann die Bandbreitennutzung erhöhen und zu Leistungseinbußen führen. Dies lässt sich vermeiden, indem Sie einen Echtzeit-Listener verwenden, wie oben gezeigt.

Daten einmal mit einem Observer lesen

In einigen Fällen möchten Sie möglicherweise, dass der Wert aus dem lokalen Cache sofort zurückgegeben wird, anstatt auf einen aktualisierten Wert auf dem Server zu prüfen. In diesen Fällen können Sie observeSingleEventOfType verwenden, um die Daten sofort aus dem lokalen Festplatten-Cache abzurufen.

Dies ist nützlich für Daten, die nur einmal geladen werden müssen und sich voraussichtlich nicht häufig ändern oder keine aktive Beobachtung erfordern. In den vorherigen Beispielen verwendet die Blogging-App diese Methode beispielsweise, um das Profil eines Nutzers zu laden, wenn er einen neuen Beitrag verfasst:

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

let userID = Auth.auth().currentUser?.uid
ref.child("users").child(userID!).observeSingleEvent(of: .value, with: { snapshot in
  // Get user value
  let value = snapshot.value as? NSDictionary
  let username = value?["username"] as? String ?? ""
  let user = User(username: username)

  // ...
}) { error in
  print(error.localizedDescription)
}

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

NSString *userID = [FIRAuth auth].currentUser.uid;
[[[_ref child:@"users"] child:userID] observeSingleEventOfType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot * _Nonnull snapshot) {
  // Get user value
  User *user = [[User alloc] initWithUsername:snapshot.value[@"username"]];

  // ...
} withCancelBlock:^(NSError * _Nonnull error) {
  NSLog(@"%@", error.localizedDescription);
}];

Daten aktualisieren oder löschen

Bestimmte Felder aktualisieren

Wenn Sie gleichzeitig in bestimmte untergeordnete Elemente eines Knotens schreiben möchten, ohne andere untergeordnete Knoten zu überschreiben, verwenden Sie die Methode updateChildValues.

Wenn Sie updateChildValues aufrufen, können Sie untergeordnete Werte auf niedrigerer Ebene aktualisieren, indem Sie einen Pfad für den Schlüssel angeben. Wenn Daten an mehreren Speicherorten gespeichert sind, um die Skalierung zu verbessern , können Sie alle Instanzen dieser Daten mit Data Fan-Out aktualisieren. Eine Social-Blogging-App möchte beispielsweise einen Beitrag erstellen und ihn gleichzeitig im Feed für die letzten Aktivitäten und im Feed für die Aktivitäten des Nutzers veröffentlichen. Dazu verwendet die Blogging-App Code wie diesen:

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

guard let key = ref.child("posts").childByAutoId().key else { return }
let post = ["uid": userID,
            "author": username,
            "title": title,
            "body": body]
let childUpdates = ["/posts/\(key)": post,
                    "/user-posts/\(userID)/\(key)/": post]
ref.updateChildValues(childUpdates)

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

NSString *key = [[_ref child:@"posts"] childByAutoId].key;
NSDictionary *post = @{@"uid": userID,
                       @"author": username,
                       @"title": title,
                       @"body": body};
NSDictionary *childUpdates = @{[@"/posts/" stringByAppendingString:key]: post,
                               [NSString stringWithFormat:@"/user-posts/%@/%@/", userID, key]: post};
[_ref updateChildValues:childUpdates];

In diesem Beispiel wird childByAutoId verwendet, um einen Beitrag im Knoten mit Beiträgen für alle Nutzer unter /posts/$postid zu erstellen und gleichzeitig den Schlüssel mit getKey() abzurufen. Der Schlüssel kann dann verwendet werden, um einen zweiten Eintrag in den Beiträgen des Nutzers unter /user-posts/$userid/$postid zu erstellen.

Mit diesen Pfaden können Sie mit einem einzigen Aufruf von updateChildValues gleichzeitige Aktualisierungen an mehreren Speicherorten im JSON-Baum vornehmen. In diesem Beispiel wird der neue Beitrag an beiden Speicherorten erstellt. Gleichzeitige Aktualisierungen, die auf diese Weise vorgenommen werden, sind atomar: Entweder sind alle Aktualisierungen erfolgreich oder alle Aktualisierungen schlagen fehl.

Abschlussblock hinzufügen

Wenn Sie wissen möchten, wann Ihre Daten übernommen wurden, können Sie einen Abschlussblock hinzufügen. Sowohl setValue als auch updateChildValues verwenden einen optionalen Abschlussblock, der aufgerufen wird, wenn der Schreibvorgang in der Datenbank übernommen wurde. Dieser Listener kann hilfreich sein, um zu verfolgen, welche Daten gespeichert wurden und welche Daten noch synchronisiert werden. Wenn der Aufruf nicht erfolgreich war, wird dem Listener ein Fehlerobjekt übergeben, das angibt, warum der Fehler aufgetreten ist.

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

do {
  try await ref.child("users").child(user.uid).setValue(["username": username])
  print("Data saved successfully!")
} catch {
  print("Data could not be saved: \(error).")
}

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

[[[_ref child:@"users"] child:user.uid] setValue:@{@"username": username} withCompletionBlock:^(NSError *error, FIRDatabaseReference *ref) {
  if (error) {
    NSLog(@"Data could not be saved: %@", error);
  } else {
    NSLog(@"Data saved successfully.");
  }
}];

Daten löschen

Die einfachste Möglichkeit, Daten zu löschen, besteht darin, removeValue für eine Referenz auf den Speicherort dieser Daten aufzurufen.

Sie können auch löschen, indem Sie nil als Wert für einen anderen Schreibvorgang wie setValue oder updateChildValues angeben. Mit dieser Technik können Sie mit updateChildValues mehrere untergeordnete Elemente in einem einzigen API-Aufruf löschen.

Listener trennen

Observer beenden die Synchronisierung von Daten nicht automatisch, wenn Sie einen ViewController verlassen. Wenn ein Observer nicht ordnungsgemäß entfernt wird, synchronisiert er weiterhin Daten mit dem lokalen Speicher. Wenn ein Observer nicht mehr benötigt wird, entfernen Sie ihn, indem Sie das zugehörige FIRDatabaseHandle an die Methode removeObserverWithHandle übergeben.

Wenn Sie einer Referenz einen Callback-Block hinzufügen, wird ein FIRDatabaseHandle zurückgegeben. Mit diesen Handles kann der Callback-Block entfernt werden.

Wenn einer Datenbankreferenz mehrere Listener hinzugefügt wurden, wird jeder Listener aufgerufen, wenn ein Ereignis ausgelöst wird. Wenn Sie die Synchronisierung von Daten an diesem Speicherort beenden möchten, müssen Sie alle Observer an einem Speicherort entfernen, indem Sie die Methode removeAllObservers aufrufen.

Wenn Sie removeObserverWithHandle oder removeAllObservers für einen Listener aufrufen, werden Listener, die für die untergeordneten Knoten registriert sind, nicht automatisch entfernt. Sie müssen auch diese Referenzen oder Handles im Auge behalten, um sie zu entfernen.

Daten als Transaktionen speichern

Wenn Sie mit Daten arbeiten, die durch gleichzeitige Änderungen beschädigt werden könnten, z. B. inkrementelle Zähler, können Sie einen Transaktionsvorgang verwenden. Sie übergeben dieser Operation zwei Argumente: eine Aktualisierungsfunktion und einen optionalen Abschluss-Callback. Die Aktualisierungsfunktion verwendet den aktuellen Status der Daten als Argument und gibt den neuen gewünschten Status zurück, den Sie schreiben möchten.

In der Social-Blogging-App im Beispiel könnten Sie Nutzern beispielsweise erlauben, Beiträge mit einem Stern zu markieren und die Markierung wieder zu entfernen, und verfolgen, wie viele Sterne ein Beitrag erhalten hat:

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

ref.runTransactionBlock({ (currentData: MutableData) -> TransactionResult in
  if var post = currentData.value as? [String: AnyObject],
    let uid = Auth.auth().currentUser?.uid {
    var stars: [String: Bool]
    stars = post["stars"] as? [String: Bool] ?? [:]
    var starCount = post["starCount"] as? Int ?? 0
    if let _ = stars[uid] {
      // Unstar the post and remove self from stars
      starCount -= 1
      stars.removeValue(forKey: uid)
    } else {
      // Star the post and add self to stars
      starCount += 1
      stars[uid] = true
    }
    post["starCount"] = starCount as AnyObject?
    post["stars"] = stars as AnyObject?

    // Set value and report transaction success
    currentData.value = post

    return TransactionResult.success(withValue: currentData)
  }
  return TransactionResult.success(withValue: currentData)
}) { error, committed, snapshot in
  if let error = error {
    print(error.localizedDescription)
  }
}

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

[ref runTransactionBlock:^FIRTransactionResult * _Nonnull(FIRMutableData * _Nonnull currentData) {
  NSMutableDictionary *post = currentData.value;
  if (!post || [post isEqual:[NSNull null]]) {
    return [FIRTransactionResult successWithValue:currentData];
  }

  NSMutableDictionary *stars = post[@"stars"];
  if (!stars) {
    stars = [[NSMutableDictionary alloc] initWithCapacity:1];
  }
  NSString *uid = [FIRAuth auth].currentUser.uid;
  int starCount = [post[@"starCount"] intValue];
  if (stars[uid]) {
    // Unstar the post and remove self from stars
    starCount--;
    [stars removeObjectForKey:uid];
  } else {
    // Star the post and add self to stars
    starCount++;
    stars[uid] = @YES;
  }
  post[@"stars"] = stars;
  post[@"starCount"] = @(starCount);

  // Set value and report transaction success
  currentData.value = post;
  return [FIRTransactionResult successWithValue:currentData];
} andCompletionBlock:^(NSError * _Nullable error,
                       BOOL committed,
                       FIRDataSnapshot * _Nullable snapshot) {
  // Transaction completed
  if (error) {
    NSLog(@"%@", error.localizedDescription);
  }
}];

Durch die Verwendung einer Transaktion wird verhindert, dass die Anzahl der Sterne falsch ist, wenn mehrere Nutzer gleichzeitig denselben Beitrag mit einem Stern markieren oder der Client veraltete Daten hatte. Der Wert in der Klasse FIRMutableData ist zunächst der letzte bekannte Wert des Clients für den Pfad oder nil, wenn kein Wert vorhanden ist. Der Server vergleicht den Anfangswert mit dem aktuellen Wert und akzeptiert oder lehnt die Transaktion ab. Wenn die Transaktion abgelehnt wird, gibt der Server den aktuellen Wert an den Client zurück, der die Transaktion mit dem aktualisierten Wert noch einmal ausführt. Dieser Vorgang wird wiederholt, bis die Transaktion akzeptiert wird oder zu viele Versuche unternommen wurden.

Hinweis: Da runTransactionBlock:andCompletionBlock: mehrmals aufgerufen wird, muss es nil Daten verarbeiten können. Auch wenn in Ihrer Remote-Datenbank vorhandene Daten vorhanden sind, werden sie möglicherweise nicht lokal im Cache gespeichert, wenn die Transaktionsfunktion ausgeführt wird. Dies führt zu nil für den Anfangswert.

Atomare serverseitige Inkremente

Im obigen Anwendungsfall schreiben wir zwei Werte in die Datenbank: die ID des Nutzers, der den Beitrag mit einem Stern markiert oder die Markierung entfernt, und die erhöhte Anzahl der Sterne. Wenn wir bereits wissen, dass der Nutzer den Beitrag mit einem Stern markiert, können wir anstelle einer Transaktion einen atomaren Inkrementvorgang verwenden.

Swift

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

let updates = [
  "posts/\(postID)/stars/\(userID)": true,
  "posts/\(postID)/starCount": ServerValue.increment(1),
  "user-posts/\(postID)/stars/\(userID)": true,
  "user-posts/\(postID)/starCount": ServerValue.increment(1)
] as [String : Any]
Database.database().reference().updateChildValues(updates)

Objective-C

Hinweis:Dieses Firebase-Produkt ist für das App Clip-Ziel nicht verfügbar.

NSDictionary *updates = @{[NSString stringWithFormat: @"posts/%@/stars/%@", postID, userID]: @TRUE,
                        [NSString stringWithFormat: @"posts/%@/starCount", postID]: [FIRServerValue increment:@1],
                        [NSString stringWithFormat: @"user-posts/%@/stars/%@", postID, userID]: @TRUE,
                        [NSString stringWithFormat: @"user-posts/%@/starCount", postID]: [FIRServerValue increment:@1]};
[[[FIRDatabase database] reference] updateChildValues:updates];

Dieser Code verwendet keinen Transaktionsvorgang. Daher wird er bei einer Konfliktaktualisierung nicht automatisch noch einmal ausgeführt. Da der Inkrementvorgang jedoch direkt auf dem Datenbankserver erfolgt, besteht keine Gefahr eines Konflikts.

Wenn Sie anwendungsspezifische Konflikte erkennen und ablehnen möchten, z. B. wenn ein Nutzer einen Beitrag mit einem Stern markiert, den er bereits zuvor mit einem Stern markiert hat, sollten Sie benutzerdefinierte Sicherheitsregeln für diesen Anwendungsfall schreiben.

Offline mit Daten arbeiten

Wenn ein Client die Netzwerkverbindung verliert, funktioniert Ihre App weiterhin ordnungsgemäß.

Jeder Client, der mit einer Firebase-Datenbank verbunden ist, verwaltet eine eigene interne Version aller aktiven Daten. Wenn Daten geschrieben werden, werden sie zuerst in diese lokale Version geschrieben. Der Firebase-Client synchronisiert diese Daten dann nach bestem Bemühen mit den Remote-Datenbankservern und mit anderen Clients.

Daher lösen alle Schreibvorgänge in die Datenbank sofort lokale Ereignisse aus, bevor Daten auf den Server geschrieben werden. Das bedeutet, dass Ihre App unabhängig von Netzwerklatenz oder Konnektivität reaktionsschnell bleibt.

Sobald die Verbindung wiederhergestellt ist, erhält Ihre App die entsprechenden Ereignisse, sodass der Client mit dem aktuellen Serverstatus synchronisiert wird, ohne dass Sie benutzerdefinierten Code schreiben müssen.

Weitere Informationen zum Offlineverhalten finden Sie unter Online- und Offlinefunktionen.

Nächste Schritte

• Mit Datenlisten arbeiten
• Daten strukturieren
• Online- und Offlinefunktionen