本頁面由 Cloud Translation API 翻譯而成。

使用 C++ 適用的 Firebase 即時資料庫擷取資料

本文將說明擷取資料的基本概念，以及如何排序及篩選 Firebase 資料。

事前準備

請確認您已設定應用程式，並且可以存取資料庫，如 Get Started 指南所述。

擷取資料

您可以透過一次性呼叫 GetValue()，或是附加至 FirebaseDatabase 參照的 ValueListener，擷取 Firebase 資料。系統會針對資料的初始狀態呼叫值監聽器一次，並且在資料變更時再次呼叫。

取得 DatabaseReference

如要將資料寫入資料庫，您需要 DatabaseReference 的例項：

    // Get the root reference location of the database.
    firebase::database::DatabaseReference dbref = database->GetReference();

讀取一次資料

您可以使用 GetValue() 方法，讀取指定路徑中內容的靜態快照一次。工作結果會包含快照，其中包含該位置的所有資料，包括子資料。如果沒有資料，則傳回的快照為 null。

  firebase::Future&ltfirebase::database::DataSnapshot&gt 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&ltfirebase::database::DataSnapshot&gt result =
    dbRef.GetReference("Leaders").AddValueListener(listener);

Future&ltDataSnapshot&gt 結果包含事件發生時資料庫中指定位置的資料。對快照呼叫 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&ltfirebase::database::DataSnapshot&gt result =
    dbRef.GetReference("GameSessionComments").AddChildListener(listener);

OnChildAdded 回呼通常用於擷取 Firebase 資料庫中的項目清單。系統會為每個現有子項呼叫 OnChildAdded 回呼一次，然後在每次將新子項新增至指定路徑時再次呼叫。事件監聽器傳遞了含有新子項資料的快照。

每當子項節點經過修改，系統就會呼叫 OnChildChanged 回呼。包括對子節點後代所做的任何修改。它通常會搭配 OnChildAdded 和 OnChildRemoved 呼叫使用，以回應項目清單的變更。傳遞至事件監聽器的快照包含子項的更新資料。

當直接子項遭到移除時，系統會觸發 OnChildRemoved 回呼。通常與 OnChildAdded 和 OnChildChanged 回呼搭配使用。傳遞至回呼的快照會包含已移除的子項資料。

每當更新導致子項重新排序時，系統就會觸發 OnChildMoved 回呼，並發出 OnChildChanged 呼叫。可與以 OrderByChild 或 OrderByValue 排序的資料搭配使用。

排序及篩選資料

您可以使用 Realtime Database 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() 相同，只是使用節點的值，而非指定子項鍵的值。

後續步驟

儲存資料