開始使用
如果您尚未設置應用程序和訪問數據庫,請先參閱Get Started
指南。
獲取數據庫參考
要將數據寫入數據庫,您需要一個DatabaseReference
實例:
// Get the root reference location of the database. firebase::database::DatabaseReference dbref = database->GetReference();
保存數據
將數據寫入 Firebase 實時數據庫有四種方法:
方法 | 常見用途 |
---|---|
SetValue() | 將數據寫入或替換到定義的路徑,例如users/<user-id>/<username> 。 |
PushChild() | 添加到數據列表。每次調用Push() 時,Firebase 都會生成一個唯一鍵,該鍵也可以用作唯一標識符,例如user-scores/<user-id>/<unique-score-id> 。 |
UpdateChildren() | 更新已定義路徑的一些鍵,而不替換所有數據。 |
RunTransaction() | 更新可能因並發更新而損壞的複雜數據。 |
在參考處寫入、更新或刪除數據
基本寫操作
對於基本寫入操作,您可以使用SetValue()
將數據保存到指定引用,替換該路徑中的任何現有數據。您可以使用此方法通過 Variant 類型傳遞 JSON 接受的類型,該類型支持:
- 空(這會刪除數據)
- 整數(64 位)
- 雙精度浮點數
- 布爾值
- 弦樂
- 變體向量
- 字符串到變體的映射
以這種方式使用SetValue()
會覆蓋指定位置的數據,包括任何子節點。但是,您仍然可以更新子對象而無需重寫整個對象。如果您想允許用戶更新他們的個人資料,您可以按如下方式更新用戶名:
dbref.Child("users").Child(userId).Child("username").SetValue(name);
追加到數據列表
使用PushChild()
方法將數據追加到多用戶應用程序中的列表中。每次將新子項添加到指定的 Firebase 引用時PushChild()
方法都會生成一個唯一的密鑰。通過為列表中的每個新元素使用這些自動生成的鍵,多個客戶端可以同時將子元素添加到同一位置,而不會發生寫入衝突。 PushChild()
生成的唯一鍵基於時間戳,因此列表項會自動按時間順序排序。
您可以使用對PushChild()
方法返回的新數據的引用來獲取子項自動生成的鍵的值或為子項設置數據。對PushChild()
引用調用GetKey()
將返回自動生成的鍵的值。
更新特定字段
要同時寫入節點的特定子節點而不覆蓋其他子節點,請使用UpdateChildren()
方法。
調用UpdateChildren()
時,您可以通過指定鍵的路徑來更新較低級別的子值。如果數據存儲在多個位置以更好地擴展,您可以使用數據扇出更新該數據的所有實例。例如,遊戲可能具有如下的LeaderboardEntry
類:
class LeaderboardEntry { std::string uid; int score = 0; public: LeaderboardEntry() { } LeaderboardEntry(std::string uid, int score) { this->uid = uid; this->score = score; } std::map<std::string, Object> ToMap() { std::map<string, Variant> result = new std::map<string, Variant>(); result["uid"] = Variant(uid); result["score"] = Variant(score); return result; } }
要創建LeaderboardEntry
並同時將其更新為最近的分數源和用戶自己的分數列表,遊戲使用以下代碼:
void WriteNewScore(std::string userId, int score) { // Create new entry at /user-scores/$userid/$scoreid and at // /leaderboard/$scoreid simultaneously std::string key = dbref.Child("scores").PushChild().GetKey(); LeaderBoardEntry entry = new LeaderBoardEntry(userId, score); std::map<std::string, Variant> entryValues = entry.ToMap(); std::map<string, Variant> childUpdates = new std::map<string, Variant>(); childUpdates["/scores/" + key] = entryValues; childUpdates["/user-scores/" + userId + "/" + key] = entryValues; dbref.UpdateChildren(childUpdates); }
此示例使用PushChild()
在/scores/$key
處所有用戶條目的節點中創建一個條目,並同時使用key()
檢索密鑰。然後,該密鑰可用於在/user-scores/$userid/$key
處的用戶分數中創建第二個條目。
使用這些路徑,您可以通過一次調用UpdateChildren()
對 JSON 樹中的多個位置執行同步更新,例如本示例如何在兩個位置創建新條目。以這種方式進行的同時更新是原子的:要么所有更新成功,要么所有更新失敗。
刪除數據
刪除數據的最簡單方法是對該數據位置的引用調用RemoveValue()
。
您還可以通過指定null
Variant
作為另一個寫入操作(例如SetValue()
或UpdateChildren()
的值來刪除。您可以將此技術與UpdateChildren()
結合使用,在單個 API 調用中刪除多個子項。
了解您的數據何時提交。
要了解您的數據何時提交到 Firebase 實時數據庫服務器,請檢查未來結果是否成功。
將數據保存為交易
當處理可能被並發修改損壞的數據(例如增量計數器)時,您可以使用事務操作。您為該操作指定一個DoTransaction
函數。此更新函數將數據的當前狀態作為參數,並返回您想要寫入的新的所需狀態。如果在成功寫入新值之前另一個客戶端寫入該位置,則會使用新的當前值再次調用您的更新函數,並重試寫入。
例如,在遊戲中,您可以允許用戶更新具有五個最高分數的排行榜:
void AddScoreToLeaders(std::string email, long score, DatabaseReference leaderBoardRef) { leaderBoardRef.RunTransaction([](firebase::database::MutableData* mutableData) { if (mutableData.children_count() >= MaxScores) { long minScore = LONG_MAX; MutableData *minVal = null; std::vector<MutableData> children = mutableData.children(); std::vector<MutableData>::iterator it; for (it = children.begin(); it != children.end(); ++it) { if (!it->value().is_map()) continue; long childScore = (long)it->Child("score").value().int64_value(); if (childScore < minScore) { minScore = childScore; minVal = &*it; } } if (minScore > score) { // The new score is lower than the existing 5 scores, abort. return kTransactionResultAbort; } // Remove the lowest score. children.Remove(minVal); } // Add the new high score. std::map<std::string, Variant> newScoreMap = new std::map<std::string, Variant>(); newScoreMap["score"] = score; newScoreMap["email"] = email; children.Add(newScoreMap); mutableData->set_value(children); return kTransactionResultSuccess; }); }
如果多個用戶同時記錄分數或客戶端擁有過時的數據,使用事務可以防止排行榜不正確。如果事務被拒絕,服務器將當前值返回給客戶端,客戶端使用更新後的值再次運行事務。重複此操作,直到交易被接受或進行了太多次嘗試。
離線寫入數據
如果客戶端失去網絡連接,您的應用程序將繼續正常運行。
連接到 Firebase 數據庫的每個客戶端都會維護自己的任何活動數據的內部版本。寫入數據時,首先寫入此本地版本。然後,Firebase 客戶端會“盡力”將該數據與遠程數據庫服務器和其他客戶端同步。
因此,在將任何數據寫入服務器之前,對數據庫的所有寫入都會立即觸發本地事件。這意味著無論網絡延遲或連接如何,您的應用程序都保持響應。
重新建立連接後,您的應用程序會收到適當的事件集,以便客戶端與當前服務器狀態同步,而無需編寫任何自定義代碼。