Datenvolumen sparen

Hinweis

Bevor Sie Realtime Database verwenden können, müssen Sie Folgendes tun:

  • Registrieren Sie Ihr Unity-Projekt und konfigurieren Sie es für die Verwendung von Firebase.

    • Wenn Ihr Unity-Projekt bereits Firebase verwendet, ist es bereits für Firebase registriert und konfiguriert.

    • Wenn Sie kein Unity-Projekt haben, können Sie eine Beispiel-App herunterladen.

  • Fügen Sie das Firebase Unity SDK (insbesondere FirebaseDatabase.unitypackage) zu Ihrem Unity-Projekt hinzu.

Wenn Sie Firebase zu Ihrem Unity-Projekt hinzufügen, müssen Sie sowohl in der Firebase Console als auch in Ihrem offenen Unity-Projekt Aufgaben ausführen. Sie laden beispielsweise Firebase-Konfigurationsdateien aus der Console herunter und verschieben sie dann in Ihr Unity-Projekt.

Daten speichern

Es gibt fünf Methoden, um Daten in die Firebase Realtime Database zu schreiben:

Methode Gängige Einsatzmöglichkeiten
SetValueAsync() Daten in einen definierten Pfad schreiben oder ersetzen, z. B. users/<user-id>/<username>.
SetRawJsonValueAsync() Daten mit Roh-JSON schreiben oder ersetzen, z. B. users/<user-id>/<username>.
Push() Zu einer Datenliste hinzufügen. Jedes Mal, wenn Sie Push() aufrufen, generiert Firebase einen eindeutigen Schlüssel, der auch als eindeutige Kennung verwendet werden kann, z. B. user-scores/<user-id>/<unique-score-id>.
UpdateChildrenAsync() Aktualisieren Sie einige der Schlüssel für einen definierten Pfad, ohne alle Daten zu ersetzen.
RunTransaction() Komplexe Daten aktualisieren, die durch gleichzeitige Aktualisierungen beschädigt werden könnten.

DatabaseReference abrufen

Wenn Sie Daten in die Datenbank schreiben möchten, benötigen Sie eine Instanz von DatabaseReference:

using Firebase;
using Firebase.Database;

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

Daten in einer Referenz schreiben, aktualisieren oder löschen

Grundlegende Schreibvorgänge

Für grundlegende Schreibvorgänge können Sie SetValueAsync() verwenden, um Daten in einer angegebenen Referenz zu speichern. Dabei werden alle vorhandenen Daten in diesem Pfad ersetzt. Mit dieser Methode können Sie Typen übergeben, die den verfügbaren JSON-Typen entsprechen:

  • string
  • long
  • double
  • bool
  • Dictionary<string, Object>
  • List<Object>

Wenn Sie ein typisiertes C#-Objekt verwenden, können Sie das integrierte JsonUtility.ToJson() verwenden, um das Objekt in unformatiertes JSON zu konvertieren und SetRawJsonValueAsync() aufzurufen. Beispiel für eine User-Klasse:

public class User {
    public string username;
    public string email;

    public User() {
    }

    public User(string username, string email) {
        this.username = username;
        this.email = email;
    }
}

So fügen Sie einen Nutzer mit SetRawJsonValueAsync() hinzu:

private void writeNewUser(string userId, string name, string email) {
    User user = new User(name, email);
    string json = JsonUtility.ToJson(user);

    mDatabaseRef.Child("users").Child(userId).SetRawJsonValueAsync(json);
}

Wenn Sie SetValueAsync() oder SetRawJsonValueAsync() auf diese Weise verwenden, werden Daten am angegebenen Speicherort überschrieben, einschließlich aller untergeordneten Knoten. Sie können jedoch 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 so aktualisieren:

mDatabaseRef.Child("users").Child(userId).Child("username").SetValueAsync(name);

An eine Liste von Daten anhängen

Verwenden Sie die Methode Push(), um Daten an eine Liste in Anwendungen mit mehreren Nutzern anzuhängen. Die Methode Push() generiert jedes Mal einen eindeutigen Schlüssel, wenn der angegebenen Firebase-Referenz ein neues untergeordnetes Element hinzugefügt wird. Durch die Verwendung dieser automatisch generierten Schlüssel für jedes neue Element in der Liste können mehrere Clients gleichzeitig untergeordnete Elemente am selben Speicherort hinzufügen, ohne dass es zu Schreibkonflikten kommt. Der von Push() generierte eindeutige Schlüssel basiert auf einem Zeitstempel, sodass Listenelemente automatisch chronologisch sortiert werden.

Sie können den Verweis auf die neuen Daten, die von der Methode Push() zurückgegeben werden, verwenden, um den Wert des automatisch generierten Schlüssels des untergeordneten Elements abzurufen oder Daten für das untergeordnete Element festzulegen. Wenn Sie Key für eine Push()-Referenz aufrufen, wird der Wert des automatisch generierten Schlüssels zurückgegeben.

Bestimmte Felder aktualisieren

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

Beim Aufrufen von UpdateChildrenAsync() können Sie untergeordnete Werte auf niedrigerer Ebene aktualisieren, indem Sie einen Pfad für den Schlüssel angeben. Wenn Daten zur besseren Skalierung an mehreren Orten gespeichert sind, können Sie alle Instanzen dieser Daten mithilfe von Daten-Fan-out aktualisieren. Ein Spiel könnte beispielsweise eine LeaderboardEntry-Klasse wie diese haben:

public class LeaderboardEntry {
    public string uid;
    public int score = 0;

    public LeaderboardEntry() {
    }

    public LeaderboardEntry(string uid, int score) {
        this.uid = uid;
        this.score = score;
    }

    public Dictionary<string, Object> ToDictionary() {
        Dictionary<string, Object> result = new Dictionary<string, Object>();
        result["uid"] = uid;
        result["score"] = score;

        return result;
    }
}

Um einen LeaderboardEntry zu erstellen und ihn gleichzeitig im Feed mit den aktuellen Punktzahlen und in der Liste mit den eigenen Punktzahlen des Nutzers zu aktualisieren, verwendet das Spiel Code wie diesen:

private void WriteNewScore(string userId, int score) {
    // Create new entry at /user-scores/$userid/$scoreid and at
    // /leaderboard/$scoreid simultaneously
    string key = mDatabase.Child("scores").Push().Key;
    LeaderBoardEntry entry = new LeaderBoardEntry(userId, score);
    Dictionary<string, Object> entryValues = entry.ToDictionary();

    Dictionary<string, Object> childUpdates = new Dictionary<string, Object>();
    childUpdates["/scores/" + key] = entryValues;
    childUpdates["/user-scores/" + userId + "/" + key] = entryValues;

    mDatabase.UpdateChildrenAsync(childUpdates);
}

In diesem Beispiel wird Push() verwendet, um einen Eintrag im Knoten zu erstellen, der Einträge für alle Nutzer unter /scores/$key enthält, und gleichzeitig den Schlüssel mit Key abzurufen. Der Schlüssel kann dann verwendet werden, um einen zweiten Eintrag in den Punktzahlen des Nutzers unter /user-scores/$userid/$key zu erstellen.

Mit diesen Pfaden können Sie mit einem einzigen Aufruf von UpdateChildrenAsync() gleichzeitige Aktualisierungen an mehreren Stellen im JSON-Baum vornehmen, wie in diesem Beispiel, in dem der neue Eintrag an beiden Stellen erstellt wird. Gleichzeitige Aktualisierungen, die auf diese Weise vorgenommen werden, sind unteilbar: Entweder sind alle Aktualisierungen erfolgreich oder alle schlagen fehl.

Daten löschen

Am einfachsten lassen sich Daten löschen, indem Sie RemoveValue() für einen Verweis auf den Speicherort dieser Daten aufrufen.

Sie können auch löschen, indem Sie null als Wert für einen anderen Schreibvorgang wie SetValueAsync() oder UpdateChildrenAsync() angeben. Sie können diese Technik mit UpdateChildrenAsync() verwenden, um mehrere untergeordnete Elemente in einem einzigen API-Aufruf zu löschen.

Wissen, wann Ihre Daten festgeschrieben sind.

Wenn Sie wissen möchten, wann Ihre Daten auf dem Firebase Realtime Database-Server gespeichert werden, können Sie eine Fortsetzung hinzufügen. Sowohl SetValueAsync() als auch UpdateChildrenAsync() geben einen Task zurück, mit dem Sie feststellen können, wann der Vorgang abgeschlossen ist. Wenn der Aufruf aus irgendeinem Grund fehlschlägt, ist die Tasks-IsFaulted „true“ und die Exception-Property gibt an, warum der Fehler aufgetreten ist.

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 geben diesem Vorgang einen Func. Diese Aktualisierung Func verwendet den aktuellen Status der Daten als Argument und gibt den neuen gewünschten Status zurück, den Sie schreiben möchten. Wenn ein anderer Client in den Speicherort schreibt, bevor Ihr neuer Wert erfolgreich geschrieben wurde, wird Ihre Aktualisierungsfunktion noch einmal mit dem neuen aktuellen Wert aufgerufen und der Schreibvorgang wird wiederholt.

In einem Spiel können Sie Nutzern beispielsweise erlauben, eine Bestenliste mit den fünf höchsten Punktzahlen zu aktualisieren:

private void AddScoreToLeaders(string email, 
                               long score,
                               DatabaseReference leaderBoardRef) {

    leaderBoardRef.RunTransaction(mutableData => {
      List<object> leaders = mutableData.Value as List<object>

      if (leaders == null) {
        leaders = new List<object>();
      } else if (mutableData.ChildrenCount >= MaxScores) {
        long minScore = long.MaxValue;
        object minVal = null;
        foreach (var child in leaders) {
          if (!(child is Dictionary<string, object>)) continue;
          long childScore = (long)
                      ((Dictionary<string, object>)child)["score"];
          if (childScore < minScore) {
            minScore = childScore;
            minVal = child;
          }
        }
        if (minScore > score) {
          // The new score is lower than the existing 5 scores, abort.
          return TransactionResult.Abort();
        }

        // Remove the lowest score.
        leaders.Remove(minVal);
      }

      // Add the new high score.
      Dictionary<string, object> newScoreMap =
                       new Dictionary<string, object>();
      newScoreMap["score"] = score;
      newScoreMap["email"] = email;
      leaders.Add(newScoreMap);
      mutableData.Value = leaders;
      return TransactionResult.Success(mutableData);
    });
}

Durch die Verwendung einer Transaktion wird verhindert, dass die Bestenliste fehlerhaft ist, wenn mehrere Nutzer gleichzeitig Ergebnisse aufzeichnen oder der Client veraltete Daten hatte. Wenn die Transaktion abgelehnt wird, gibt der Server den aktuellen Wert an den Client zurück, der die Transaktion dann mit dem aktualisierten Wert noch einmal ausführt. Dies wird wiederholt, bis die Transaktion akzeptiert wird oder zu viele Versuche unternommen wurden.

Daten offline schreiben

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 dem Best-Effort-Prinzip mit den Remote-Datenbankservern und anderen Clients.

Daher lösen alle Schreibvorgänge in der Datenbank sofort lokale Ereignisse aus, bevor Daten auf den Server geschrieben werden. Das bedeutet, dass Ihre App unabhängig von Netzwerklatenz oder -verbindung reaktionsfähig bleibt.

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

Nächste Schritte