本文說明擷取資料的基本概念,以及如何排序及篩選 Firebase 資料。
事前準備
請確認已設定應用程式,且能按照 Get Started
指南中的說明存取資料庫。
正在擷取資料
系統會擷取 Firebase 資料,方法有兩種:一次性呼叫 GetValue()
,或是附加至 FirebaseDatabase
參照的 ValueListener
。系統會針對資料的初始狀態呼叫一次值事件監聽器,並在資料變更時再次呼叫。
取得 DatabaseReference
如要將資料寫入資料庫,您需要 DatabaseReference
的執行個體:
// Get the root reference location of the database. firebase::database::DatabaseReference dbref = database->GetReference();
讀取資料一次
您可以使用 GetValue()
方法,一次讀取指定路徑的內容靜態快照。工作結果會包含快照,當中包含該位置所有資料,包括子項資料。如果沒有資料,則傳回的快照為 null
。
firebase::Future<firebase::database::DataSnapshot> result = dbRef.GetReference("Leaders").GetValue();
提出要求時,我們必須等到 Future 完成之後才能讀取該值。由於遊戲通常會以迴圈方式執行,且回呼促成的回呼不像其他應用程式,因此一般會輪詢作業是否完成。
// In the game loop that polls for the result... if (result.status() != firebase::kFutureStatusPending) { if (result.status() != firebase::kFutureStatusComplete) { LogMessage("ERROR: GetValue() returned an invalid result."); // Handle the error... } else if (result.error() != firebase::database::kErrorNone) { LogMessage("ERROR: GetValue() returned error %d: %s", result.error(), result.error_message()); // Handle the error... } else { firebase::database::DataSnapshot snapshot = result.result(); // Do something with the snapshot... } }
此處會顯示一些基本錯誤檢查,請參閱 firebase::Future 參考資料,進一步瞭解錯誤檢查,以及判斷結果何時準備就緒的方法。
接聽事件
您可以新增事件監聽器來訂閱資料變更:
ValueListener
基礎類別
回撥電話 | 一般用量 |
---|---|
OnValueChanged |
讀取及監聽路徑完整內容的異動。 |
OnChildListener
基礎類別
OnChildAdded
| 擷取項目清單,或監聽附加項目清單。
建議搭配 OnChildChanged 和 OnChildRemoved 使用,監控清單變更。 |
OnChildChanged |
監聽清單中項目的變更。使用 OnChildAdded 和 OnChildRemoved 即可監控清單變更。 |
OnChildRemoved |
監聽已從清單中移除的項目。使用 OnChildAdded 和 OnChildChanged 即可監控清單變更。 |
OnChildMoved |
監聽已排序清單中項目順序的變更。
由於項目的順序改變 (依據您目前的排序方法而定),因此 OnChildMoved 回呼一律會遵循 OnChildChanged 回呼。 |
ValueListener 類別
您可以使用 OnValueChanged
回呼,訂閱特定路徑的內容變更。您附加監聽器時,系統會觸發一次回呼,並在資料 (包括子項) 變更時再次觸發。回呼會傳遞內含該位置所有資料的快照,包括子項資料。如果沒有資料,則傳回的快照為 null
。
以下範例是一個遊戲,示範如何從資料庫擷取排行榜的分數:
class LeadersValueListener : public firebase::database::ValueListener { public: void OnValueChanged( const firebase::database::DataSnapshot& snapshot) override { // Do something with the data in snapshot... } void OnCancelled(const firebase::database::Error& error_code, const char* error_message) override { LogMessage("ERROR: LeadersValueListener canceled: %d: %s", error_code, error_message); } }; // Elsewhere in the code... LeadersValueListener* listener = new LeadersValueListener(); firebase::Future<firebase::database::DataSnapshot> result = dbRef.GetReference("Leaders").AddValueListener(listener);
Future<DataSnapshot>
結果包含事件發生時,資料庫中特定位置的資料。對快照呼叫 value()
會傳回代表資料的 Variant
。
在這個範例中,OnCancelled
方法也會遭到覆寫,以確認讀取作業是否已取消。舉例來說,如果用戶端權限不足,無法讀取 Firebase 資料庫位置,系統就會取消讀取作業。database::Error
會指出失敗的原因。
ChildListener 類別
如果作業發生在節點子項所發生的特定作業 (例如透過 PushChild()
方法新增的子項,或透過 UpdateChildren()
方法更新子項),就會觸發子項事件。這兩個組合都有助於監聽資料庫中特定節點的變更。舉例來說,遊戲可能同時使用下列方法,監控遊戲工作階段留言中的活動,如下所示:
class SessionCommentsChildListener : public firebase::database::ChildListener { public: void OnChildAdded(const firebase::database::DataSnapshot& snapshot, const char* previous_sibling) override { // Do something with the data in snapshot ... } void OnChildChanged(const firebase::database::DataSnapshot& snapshot, const char* previous_sibling) override { // Do something with the data in snapshot ... } void OnChildRemoved( const firebase::database::DataSnapshot& snapshot) override { // Do something with the data in snapshot ... } void OnChildMoved(const firebase::database::DataSnapshot& snapshot, const char* previous_sibling) override { // Do something with the data in snapshot ... } void OnCancelled(const firebase::database::Error& error_code, const char* error_message) override { LogMessage("ERROR: SessionCommentsChildListener canceled: %d: %s", error_code, error_message); } }; // elsewhere .... SessionCommentsChildListener* listener = new SessionCommentsChildListener(); firebase::Future<firebase::database::DataSnapshot> result = dbRef.GetReference("GameSessionComments").AddChildListener(listener);
OnChildAdded
回呼通常用於擷取 Firebase 資料庫中的項目清單。系統會為每個現有子項呼叫一次 OnChildAdded
回呼,然後再將新子項新增至指定路徑時再次呼叫。事件監聽器傳遞了含有新子項資料的快照。
每當修改子節點時,系統就會呼叫 OnChildChanged
回呼。這也包括對子節點子系所做的任何修改。這通常會搭配 OnChildAdded
和 OnChildRemoved
呼叫使用,以回應項目清單的變更。傳遞至事件監聽器的快照會包含子項的更新資料。
移除立即子項時,會觸發 OnChildRemoved
回呼。通常與 OnChildAdded
和 OnChildChanged
回呼搭配使用。傳遞至回呼的快照會包含已移除的子項資料。
只要更新引發 OnChildChanged
呼叫,導致子項重新排序時,就會觸發 OnChildMoved
回呼。可與以 OrderByChild
或 OrderByValue
排序的資料搭配使用。
排序及篩選資料
您可以使用即時資料庫 Query
類別,擷取依鍵、值或子項值排序的資料。您也可以篩選排序結果,以達到特定結果數量、鍵/值範圍。
排序資料
如要擷取經過排序的資料,請先指定一種依順序排序的方法來決定結果的排序方式:
方式 | 用量 |
---|---|
OrderByChild() |
按照指定子鍵的值排序結果。 |
OrderByKey()
| 按子項鍵排序結果。 |
OrderByValue() |
按照子項值排序結果。 |
一次只能使用「一個」排序方法。在同一查詢中多次呼叫依順序的方法呼叫會擲回錯誤。
以下範例說明如何訂閱依分數排序的得分排行榜。
firebase::database::Query query = dbRef.GetReference("Leaders").OrderByChild("score"); // To get the resulting DataSnapshot either use query.GetValue() and poll the // future, or use query.AddValueListener() and register to handle the // OnValueChanged callback.
這會定義 firebase::Query
,在與 ValueListener 搭配使用時,系統會依每個項目的分數排序用戶端與資料庫中的排行榜。如要進一步瞭解如何有效率地建構資料,請參閱建立資料庫結構。
OrderByChild()
方法的呼叫會指定子項鍵,依結果排序結果。在這種情況下,結果會按照每個子項中的 "score"
值排序。如要進一步瞭解其他資料類型的排序方式,請參閱查詢資料的排序方式。
篩選資料
如要篩選資料,您可以在建構查詢時,將任何限製或範圍方法與排序方法結合。
方式 | 用量 |
---|---|
LimitToFirst() |
設定要從已排序結果清單開頭傳回的項目數量上限。 |
LimitToLast() |
設定從已排序結果清單結尾傳回的項目數量上限。 |
StartAt() |
依據所選的順序,傳回大於或等於指定鍵或值的項目。 |
EndAt() |
依據所選的順序,傳回小於或等於指定鍵或值的項目。 |
EqualTo() |
根據所選順序,傳回與指定鍵或值相等的項目。 |
有別於依序執行排序的方式,您可以合併多個限製或範圍函式。舉例來說,您可以結合 StartAt()
和 EndAt()
方法,將結果限制為指定範圍內的值。
即使查詢只有一個相符結果,快照仍為清單,只是只包含一個項目。
限制結果數量
您可以使用 LimitToFirst()
和 LimitToLast()
方法,設定特定回呼要同步處理的子項數量上限。舉例來說,如果您使用 LimitToFirst()
將限制設為 100,一開始最多只會接收 100 個 OnChildAdded
回呼。如果 Firebase 資料庫中儲存的項目少於 100 個,則每個項目都會觸發 OnChildAdded
回呼。
當項目有變更時,您也會收到輸入查詢的項目 OnChildAdded
回呼,而針對移出查詢的項目,您會收到 OnChildRemoved
回呼,因此總數會維持在 100。
例如,以下程式碼會傳回排行榜的最高分:
firebase::database::Query query = dbRef.GetReference("Leaders").OrderByChild("score").LimitToLast(1); // To get the resulting DataSnapshot either use query.GetValue() and poll the // future, or use query.AddValueListener() and register to handle the // OnValueChanged callback.
依鍵或值篩選
您可以使用 StartAt()
、EndAt()
和 EqualTo()
,針對查詢選擇任意的開始、結束和對等點。這有助於分頁資料,或是尋找具有特定值的子項項目。
查詢資料的排序方式
本節說明 Query
類別中各個排序方法如何排序資料。
OrderByChild
使用 OrderByChild()
時,包含指定子項鍵的資料會按照以下順序排序:
- 針對指定子項金鑰,具有
null
值的子項會先列出。 - 指定子項金鑰值為
false
的子項接著會顯示。如果多個子項的值為false
,則這些子項的值會按照鍵字母順序排序。 - 指定子項金鑰值為
true
的子項接著會顯示。如果多個子項的值為true
,就會按照鍵的字母順序排序。 - 含有數值的子項接著會以遞增順序排序。如果指定的子節點有多個子項具有相同數值,系統會按照索引鍵排序。
- 字串是由數字後方,並按遞增順序排列。如果指定的子節點有多個子項的值相同,就會按照鍵的字母順序排列。
- 物件在最後,且依索引鍵順序排列,以遞增順序排列。
OrderByKey
使用 OrderByKey()
排序資料時,系統會依鍵以遞增順序傳回資料。
- 如果子項的索引鍵可剖析為 32 位元整數,其內容會先以遞增順序排序。
- 具有字串值做為索引鍵的下一個子項,並依字母順序遞增排序。
OrderByValue
使用 OrderByValue()
時,子項會按照值的順序排列。排序條件與 OrderByChild()
相同,但會使用節點的值而非指定子項鍵的值。