Google致力於提高黑人社區的種族平等。 怎麼看。
本頁面由 Cloud Translation API 翻譯而成。
Switch to English

保存數據

在你開始之前

在使用Realtime Database之前,您需要:

  • 註冊您的Unity項目並將其配置為使用Firebase。

    • 如果您的Unity項目已經使用Firebase,則說明它已經為Firebase註冊並配置了。

    • 如果您沒有Unity項目,則可以下載示例應用程序

  • Firebase Unity SDK (特別是FirebaseDatabase.unitypackage )添加到Unity項目中。

請注意,將Firebase添加到Unity項目中會涉及Firebase控制台和打開的Unity項目中的任務(例如,您從控制台下載Firebase配置文件,然後將它們移到Unity項目中)。

保存數據

有五種將數據寫入Firebase實時數據庫的方法:

方法常見用途
SetValueAsync() 將數據寫入或替換到已定義的路徑,例如users/<user-id>/<username>
SetRawJsonValueAsync() 使用原始Json寫入或替換數據,例如users/<user-id>/<username>
Push() 添加到數據列表。每次調用Push() ,Firebase都會生成一個唯一密鑰,該密鑰也可以用作唯一標識符,例如user-scores/<user-id>/<unique-score-id>
UpdateChildrenAsync() 更新定義的路徑的某些鍵,而不替換所有數據。
RunTransaction() 更新可能被並發更新破壞的複雜數據。

獲取數據庫參考

要將數據寫入數據庫,您需要一個DatabaseReference實例:

using Firebase;
using Firebase.Database;
using Firebase.Unity.Editor;

public class MyScript: MonoBehaviour {
  void Start() {
    // Set up the Editor before calling into the realtime database.
    FirebaseApp.DefaultInstance.SetEditorDatabaseUrl("https://YOUR-FIREBASE-APP.firebaseio.com/");

    // Get the root reference location of the database.
    DatabaseReference reference = FirebaseDatabase.DefaultInstance.RootReference;
  }
}

在參考處寫入,更新或刪除數據

基本寫操作

對於基本寫操作,可以使用SetValueAsync()將數據保存到指定的引用,從而替換該路徑上的任何現有數據。您可以使用此方法來傳遞與可用JSON類型相對應的類型,如下所示:

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

如果使用類型化的C#對象,則可以使用內置的JsonUtility.ToJson()將對象轉換為原始Json並調用SetRawJsonValueAsync() 。例如,您可能具有一個如下所示的User類:

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

    public User() {
    }

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

您可以使用SetRawJsonValueAsync()添加用戶,如下所示:

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);
}

以這種方式使用SetValueAsync()SetRawJsonValueAsync()覆蓋指定位置(包括所有子節點)上的數據。但是,您仍然可以更新子項而無需重寫整個對象。如果要允許用戶更新其個人資料,則可以按以下方式更新用戶名:

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

附加到數據列表

使用Push()方法將數據追加到多用戶應用程序中的列表中。每當將新的子級添加到指定的Firebase引用時, Push()方法都會生成一個唯一鍵。通過為列表中的每個新元素使用這些自動生成的鍵,多個客戶端可以在同一時間將子代添加到同一位置,而不會發生寫衝突。 Push()生成的唯一鍵基於時間戳,因此列表項將按時間順序自動排序。

您可以使用對Push()方法返回的新數據的引用來獲取子項的自動生成鍵的值或為子項設置數據。在Push()引用上調用Key返回自動生成的鍵的值。

更新特定字段

若要同時寫入節點的特定子節點而不覆蓋其他子節點,請使用UpdateChildrenAsync()方法。

調用UpdateChildrenAsync() ,可以通過指定鍵的路徑來更新較低級別的子值。如果數據存儲在多個位置以更好地擴展,則可以使用數據扇出更新該數據的所有實例。例如,一個遊戲可能具有如下的LeaderboardEntry類:

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;
    }
}

要創建一個LeaderboardEntry並同時將其更新為最近的得分供稿和用戶自己的得分列表,遊戲將使用如下代碼:

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);
}

本示例使用Push()在節點中創建一個條目,該條目包含/scores/$key所有用戶的條目,並同時使用Key檢索Key 。然後,該密鑰可用於在用戶分數中的/user-scores/$userid/$key創建第二個條目。

使用這些路徑,您可以通過一次調用UpdateChildrenAsync()來同時更新JSON樹中的多個位置,例如本示例如何在兩個位置中創建新條目。通過這種方式進行的同時更新是原子性的:要么所有更新成功,要么所有更新失敗。

刪除資料

刪除數據的最簡單方法是在對數據位置的引用上調用RemoveValue()

您還可以通過將null指定為另一個寫入操作(例如SetValueAsync()UpdateChildrenAsync()的值來進行刪除。您可以將此技術與UpdateChildrenAsync()以在單個API調用中刪除多個子級。

知道何時提交數據。

要知道何時將數據提交到Firebase Realtime數據庫服務器,可以添加一個延續。 SetValueAsync()UpdateChildrenAsync()返回一個Task ,該Task使您可以知道操作何時完成。如果由於某種原因調用失敗,則Tasks IsFaulted將為true,並帶有Exception屬性,指示失敗原因。

將數據另存為交易

當使用可能被並發修改破壞的數據(例如增量計數器)時,可以使用事務操作 。您將此操作賦予Func 。此更新Func將數據的當前狀態作為參數,並返回要寫入的新的所需狀態。如果另一個客戶端在成功寫入新值之前寫入該位置,則將使用新的當前值再次調用更新函數,然後重試寫入。

例如,在遊戲中,您可以允許用戶更新得分最高的五個排行榜:

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);
    });
}

如果多個用戶同時記錄分數或客戶端具有陳舊數據,則使用事務可以防止排行榜出現錯誤。如果交易被拒絕,則服務器將當前值返回給客戶端,客戶端將使用更新後的值再次運行交易。重複此過程,直到接受交易或進行過多嘗試為止。

離線寫入數據

如果客戶端失去網絡連接,則您的應用將繼續正常運行。

連接到Firebase數據庫的每個客戶端都維護自己的內部版本的任何活動數據。寫入數據後,首先將其寫入此本地版本。然後,Firebase客戶端會根據“最大努力”與遠程數據庫服務器和其他客戶端同步該數據。

結果,所有寫入數據庫的操作都會在任何數據寫入服務器之前立即觸發本地事件。這意味著您的應用程序始終保持響應狀態,無論網絡延遲或連接性如何。

重新建立連接後,您的應用將接收適當的事件集,以便客戶端與當前服務器狀態同步,而無需編寫任何自定義代碼。

下一步