在 Android 上使用資料清單

本文說明如何在 Firebase 中處理資料清單。如要瞭解讀取及寫入 Firebase 資料的基本概念，請參閱「在 Android 上讀取及寫入資料」。

取得 DatabaseReference

如要從資料庫讀取及寫入資料，您需要 DatabaseReference 的執行個體：

Kotlin

private lateinit var database: DatabaseReference
// ...
database = Firebase.database.reference

Java

private DatabaseReference mDatabase;
// ...
mDatabase = FirebaseDatabase.getInstance().getReference();

讀取及寫入清單

附加至資料清單

在多使用者應用程式中，使用 push() 方法將資料附加至清單。每當有新的子項新增至指定的 Firebase 參照時，push() 方法就會產生專屬金鑰。為清單中的每個新元素使用這些自動生成的鍵，多個用戶端可以同時將子項新增至相同位置，而不會發生寫入衝突。push() 產生的不重複索引鍵是以時間戳記為基礎，因此清單項目會自動依時間順序排列。

您可以使用 push() 方法傳回的新資料參照，取得子項自動產生的索引鍵值，或為子項設定資料。對 push() 參照呼叫 getKey()，會傳回自動產生的索引鍵值。

您可以使用這些自動產生的鍵，簡化資料結構扁平化作業。詳情請參閱資料展開範例。

監聽子事件

處理清單時，應用程式應監聽子事件，而非用於單一物件的值事件。

子事件會因應節點子項發生的特定作業而觸發，例如透過 push() 方法新增子項，或透過 updateChildren() 方法更新子項。這些方法可以搭配使用，監聽資料庫中特定節點的變更。

如要監聽 DatabaseReference 上的子事件，請附加 ChildEventListener：

監聽器 事件回呼 一般用途
ChildEventListener onChildAdded() 擷取項目清單，或監聽項目清單的新增內容。 系統會為每個現有子項觸發一次這個回呼，然後在每次有新子項新增至指定路徑時再次觸發。傳遞至事件監聽器的 DataSnapshot 包含新子項的資料。
onChildChanged() 監聽清單中項目的變更。每當子節點遭到修改 (包括對子節點的子系進行任何修改)，就會觸發這個事件。傳遞至事件監聽器的 DataSnapshot 包含子項的更新資料。
onChildRemoved() 監聽從清單中移除的項目。傳遞至事件回呼的 DataSnapshot 包含已移除子項的資料。
onChildMoved() 監聽已排序的清單中項目順序的變更。每當更新導致子項重新排序，進而觸發 onChildChanged() 回呼時，系統就會觸發這個事件。這項功能適用於使用 orderByChild 或 orderByValue 排序的資料。

舉例來說，社交網誌應用程式可能會同時使用這些方法，監控貼文留言中的活動，如下所示：

Kotlin 

val childEventListener = object : ChildEventListener {
    override fun onChildAdded(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildAdded:" + dataSnapshot.key!!)

        // A new comment has been added, add it to the displayed list
        val comment = dataSnapshot.getValue<Comment>()

        // ...
    }

    override fun onChildChanged(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildChanged: ${dataSnapshot.key}")

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so displayed the changed comment.
        val newComment = dataSnapshot.getValue<Comment>()
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onChildRemoved(dataSnapshot: DataSnapshot) {
        Log.d(TAG, "onChildRemoved:" + dataSnapshot.key!!)

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so remove it.
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onChildMoved(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildMoved:" + dataSnapshot.key!!)

        // A comment has changed position, use the key to determine if we are
        // displaying this comment and if so move it.
        val movedComment = dataSnapshot.getValue<Comment>()
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onCancelled(databaseError: DatabaseError) {
        Log.w(TAG, "postComments:onCancelled", databaseError.toException())
        Toast.makeText(
            context,
            "Failed to load comments.",
            Toast.LENGTH_SHORT,
        ).show()
    }
}
databaseReference.addChildEventListener(childEventListener)

Java 

ChildEventListener childEventListener = new ChildEventListener() {
    @Override
    public void onChildAdded(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildAdded:" + dataSnapshot.getKey());

        // A new comment has been added, add it to the displayed list
        Comment comment = dataSnapshot.getValue(Comment.class);

        // ...
    }

    @Override
    public void onChildChanged(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildChanged:" + dataSnapshot.getKey());

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so displayed the changed comment.
        Comment newComment = dataSnapshot.getValue(Comment.class);
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onChildRemoved(DataSnapshot dataSnapshot) {
        Log.d(TAG, "onChildRemoved:" + dataSnapshot.getKey());

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so remove it.
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onChildMoved(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildMoved:" + dataSnapshot.getKey());

        // A comment has changed position, use the key to determine if we are
        // displaying this comment and if so move it.
        Comment movedComment = dataSnapshot.getValue(Comment.class);
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onCancelled(DatabaseError databaseError) {
        Log.w(TAG, "postComments:onCancelled", databaseError.toException());
        Toast.makeText(mContext, "Failed to load comments.",
                Toast.LENGTH_SHORT).show();
    }
};
databaseReference.addChildEventListener(childEventListener);

監聽值事件

雖然建議使用 ChildEventListener 讀取資料清單，但在某些情況下，將 ValueEventListener 附加至清單參照會很有用。

將 ValueEventListener 附加至資料清單，會將整個資料清單做為單一 DataSnapshot 傳回，然後您可以循環存取個別子項。

即使查詢只有一個相符項目，快照仍會是清單，只是其中只有一個項目。如要存取項目，您必須對結果執行迴圈：

Kotlin 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        for (postSnapshot in dataSnapshot.children) {
            // TODO: handle the post
        }
    }

    override fun onCancelled(databaseError: DatabaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException())
        // ...
    }
})

Java 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
        for (DataSnapshot postSnapshot: dataSnapshot.getChildren()) {
            // TODO: handle the post
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError databaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException());
        // ...
    }
});

如果想在單一作業中擷取清單的所有子項，而不是監聽其他 onChildAdded 事件，這個模式就非常實用。

卸載事件監聽器

如要移除回呼，請在 Firebase 資料庫參照上呼叫 removeEventListener() 方法。

如果監聽器已多次新增至資料位置，則每個事件都會呼叫該監聽器多次，您必須將其卸載相同次數，才能完全移除。

在父項事件監聽器上呼叫 removeEventListener()，並不會自動移除在其子節點上註冊的事件監聽器；您也必須在任何子項事件監聽器上呼叫 removeEventListener()，才能移除回呼。

排序及篩選資料

您可以使用 Realtime Database Query 類別，擷取依鍵、值或子項值排序的資料。您也可以將排序結果篩選為特定數量的結果，或是一組鍵或值。

排序資料

如要擷取排序後的資料，請先指定其中一種排序方法，決定結果的排序方式：

方法 用量
orderByChild() 依指定子鍵或巢狀子路徑的值排序結果。
orderByKey() 依子項索引鍵排序結果。
orderByValue() 依子項值排序結果。

一次只能使用一種排序方法。在同一查詢中多次呼叫排序方法會擲回錯誤。

以下範例說明如何擷取使用者的熱門貼文清單，並依星號數量排序：

Kotlin 

// My top posts by number of stars
val myUserId = uid
val myTopPostsQuery = databaseReference.child("user-posts").child(myUserId)
    .orderByChild("starCount")

myTopPostsQuery.addChildEventListener(object : ChildEventListener {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
})

Java 

// My top posts by number of stars
String myUserId = getUid();
Query myTopPostsQuery = databaseReference.child("user-posts").child(myUserId)
        .orderByChild("starCount");
myTopPostsQuery.addChildEventListener(new ChildEventListener() {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
});

這會定義查詢，與子項事件監聽器結合時，會根據使用者 ID，將用戶端與資料庫路徑中的使用者貼文同步，並依每篇貼文獲得的星號數量排序。這種使用 ID 做為索引鍵的技術稱為資料展開，詳情請參閱「建構資料庫」。

呼叫 orderByChild() 方法時，會指定要用來排序結果的子項鍵。在這種情況下，貼文會依各自 "starCount" 子項的值排序。如果資料結構如下，查詢也可以依巢狀子項排序：

"posts": {
  "ts-functions": {
    "metrics": {
      "views" : 1200000,
      "likes" : 251000,
      "shares": 1200,
    },
    "title" : "Why you should use TypeScript for writing Cloud Functions",
    "author": "Doug",
  },
  "android-arch-3": {
    "metrics": {
      "views" : 900000,
      "likes" : 117000,
      "shares": 144,
    },
    "title" : "Using Android Architecture Components with Firebase Realtime Database (Part 3)",
    "author": "Doug",
  }
},

在這個範例中，我們可以在 orderByChild() 呼叫中指定巢狀子項的相對路徑，依 metrics 鍵下巢狀結構的值排序清單元素。

Kotlin 

// Most viewed posts
val myMostViewedPostsQuery = databaseReference.child("posts")
    .orderByChild("metrics/views")
myMostViewedPostsQuery.addChildEventListener(object : ChildEventListener {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
})

Java 

// Most viewed posts
Query myMostViewedPostsQuery = databaseReference.child("posts")
        .orderByChild("metrics/views");
myMostViewedPostsQuery.addChildEventListener(new ChildEventListener() {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
});

如要進一步瞭解其他資料類型的排序方式，請參閱「查詢資料的排序方式」。

篩選資料

如要篩選資料，您可以在建構查詢時，將任何限制或範圍方法與排序方法結合。

方法 用量
limitToFirst() 設定從已排序的清單結果開頭傳回的項目數量上限。
limitToLast() 設定從已排序結果清單結尾傳回的項目數量上限。
startAt() 根據所選排序方法，傳回大於或等於指定鍵或值的項目。
startAfter() 根據所選排序方法，傳回大於指定鍵或值的項目。
endAt() 根據所選排序方法，傳回小於或等於指定鍵或值的項目。
endBefore() 根據所選排序方法，傳回小於指定鍵或值的項目。
equalTo() 根據所選排序方法，傳回與指定鍵或值相等的項目。

與排序方法不同，您可以合併多個限制或範圍函式。舉例來說，您可以結合 startAt() 和 endAt() 方法，將結果限制在指定的值範圍內。

即使查詢只有一個相符項目，快照仍會是清單，只是其中只有一個項目。如要存取項目，您需要對結果執行迴圈：

Kotlin 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        for (postSnapshot in dataSnapshot.children) {
            // TODO: handle the post
        }
    }

    override fun onCancelled(databaseError: DatabaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException())
        // ...
    }
})

Java 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
        for (DataSnapshot postSnapshot: dataSnapshot.getChildren()) {
            // TODO: handle the post
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError databaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException());
        // ...
    }
});

限制結果數量

您可以使用 limitToFirst() 和 limitToLast() 方法，設定特定回呼要同步處理的子項數量上限。舉例來說，如果您使用 limitToFirst() 將限制設為 100，一開始最多只會收到 100 個 onChildAdded() 回呼。如果 Firebase 資料庫中儲存的項目少於 100 個，系統會為每個項目觸發 onChildAdded() 回呼。

當項目變更時，您會收到進入查詢項目的 onChildAdded() 回呼，以及從查詢中刪除項目的 onChildRemoved() 回呼，因此總數會維持在 100。

以下範例說明範例網誌應用程式如何定義查詢，擷取所有使用者最近 100 則貼文的清單：

Kotlin 

// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys.
databaseReference.child("posts").limitToFirst(100)

Java 

// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys
Query recentPostsQuery = databaseReference.child("posts")
        .limitToFirst(100);

這個範例只定義查詢，如要實際同步處理資料，則必須附加事件監聽器。

依鍵或值篩選

您可以使用 startAt()、startAfter()、endAt()、endBefore() 和 equalTo()，為查詢選擇任意的起始點、結束點和等值點。這項功能可用於分頁資料，或尋找子項具有特定值的項目。

查詢資料的排序方式

本節說明 Query 類別中各個排序方法的資料排序方式。

orderByChild

使用 orderByChild() 時，包含指定子項索引鍵的資料會依下列方式排序：

  1. 指定子項索引鍵的值為 null 的子項會排在最前面。
  2. 接著是指定子鍵值為 false 的子項。如果多個子項的值為 false，系統會依鍵按字母順序排序。
  3. 接著是指定子鍵值為 true 的子項。如果多個子項的值為 true，則會依鍵的字母順序排序。
  4. 接著是具有數值的子項目，按照遞增順序排序。如果多個子項的指定子節點具有相同的數值，則會依鍵排序。
  5. 字串會排在數字後面，並依字母順序遞增排序。如果多個子項在指定子節點的值相同，則會依鍵的字典順序排列。
  6. 物件排在最後，並依鍵的字母順序遞增排序。

orderByKey

使用 orderByKey() 排序資料時，系統會依鍵值遞增傳回資料。

  1. 如果子項的鍵可剖析為 32 位元整數，則會優先顯示，並依遞增順序排序。
  2. 接著是鍵值為字串值的子項，按照字母順序遞增排序。

orderByValue

使用 orderByValue() 時，子項會依其值排序。排序條件與 orderByChild() 相同，但使用的是節點的值，而非指定子項索引鍵的值。

後續步驟