Làm việc với danh sách dữ liệu trên Android

Tài liệu này bao gồm cách làm việc với danh sách dữ liệu trong Firebase. Để tìm hiểu kiến ​​thức cơ bản về đọc và ghi dữ liệu Firebase, hãy xem Đọc và ghi dữ liệu trên Android .

Nhận một tài liệu tham khảo cơ sở dữ liệu

Để đọc và ghi dữ liệu từ cơ sở dữ liệu, bạn cần một phiên bản của DatabaseReference :

Kotlin+KTX

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

Java

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

Đọc và viết danh sách

Thêm vào danh sách dữ liệu

Sử dụng phương thức push() để nối dữ liệu vào danh sách trong các ứng dụng nhiều người dùng. Phương thức push() tạo một khóa duy nhất mỗi khi một phần tử con mới được thêm vào tham chiếu Firebase đã chỉ định. Bằng cách sử dụng các khóa được tạo tự động này cho từng thành phần mới trong danh sách, một số khách hàng có thể thêm các thành phần con vào cùng một vị trí cùng lúc mà không bị xung đột khi ghi. Khóa duy nhất được tạo bởi push() dựa trên dấu thời gian, do đó các mục trong danh sách sẽ tự động được sắp xếp theo thứ tự thời gian.

Bạn có thể sử dụng tham chiếu đến dữ liệu mới được phương thức push() trả về để lấy giá trị của khóa được tạo tự động hoặc dữ liệu tập hợp cho trẻ. Gọi getKey() trên tham chiếu push() trả về giá trị của khóa được tạo tự động.

Bạn có thể sử dụng các khóa được tạo tự động này để đơn giản hóa việc làm phẳng cấu trúc dữ liệu của mình. Để biết thêm thông tin, hãy xem ví dụ về phân xuất dữ liệu.

Lắng nghe các sự kiện trẻ em

Khi làm việc với danh sách, ứng dụng của bạn nên lắng nghe các sự kiện con thay vì các sự kiện giá trị được sử dụng cho các đối tượng đơn lẻ.

Các sự kiện con được kích hoạt để phản hồi các hoạt động cụ thể xảy ra với các nút con của một nút từ một thao tác, chẳng hạn như một nút con mới được thêm thông qua phương thức push() hoặc một nút con được cập nhật thông qua phương thức updateChildren() . Mỗi thứ này kết hợp với nhau có thể hữu ích cho việc lắng nghe những thay đổi đối với một nút cụ thể trong cơ sở dữ liệu.

Để lắng nghe các sự kiện con trên DatabaseReference , hãy đính kèm ChildEventListener :

Người nghe Gọi lại sự kiện Cách sử dụng điển hình
ChildEventListener onChildAdded() Truy xuất danh sách các mục hoặc lắng nghe phần bổ sung vào danh sách các mục. Lệnh gọi lại này được kích hoạt một lần cho mỗi thành phần con hiện có và sau đó được kích hoạt lại mỗi khi có một thành phần con mới được thêm vào đường dẫn đã chỉ định. DataSnapshot được truyền tới trình nghe chứa dữ liệu của thành phần con mới.
onChildChanged() Lắng nghe những thay đổi đối với các mục trong danh sách. Sự kiện này được kích hoạt bất cứ khi nào nút con được sửa đổi, bao gồm mọi sửa đổi đối với nút con của nút con. DataSnapshot được chuyển tới trình xử lý sự kiện chứa dữ liệu cập nhật cho trẻ.
onChildRemoved() Lắng nghe các mục bị xóa khỏi danh sách. DataSnapshot được chuyển tới lệnh gọi lại sự kiện chứa dữ liệu cho thành phần con đã bị xóa.
onChildMoved() Lắng nghe những thay đổi về thứ tự của các mục trong danh sách có thứ tự. Sự kiện này được kích hoạt bất cứ khi nào lệnh gọi lại onChildChanged() được kích hoạt bởi một bản cập nhật khiến trẻ sắp xếp lại thứ tự. Nó được sử dụng với dữ liệu được sắp xếp theo orderByChild hoặc orderByValue .

Ví dụ: một ứng dụng viết blog xã hội có thể sử dụng các phương pháp này cùng nhau để theo dõi hoạt động trong các nhận xét của bài đăng, như minh họa bên dưới:

Kotlin+KTX

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

Lắng nghe các sự kiện giá trị

Mặc dù sử dụng ChildEventListener là cách được khuyến nghị để đọc danh sách dữ liệu, nhưng có những trường hợp việc đính kèm ValueEventListener vào tham chiếu danh sách sẽ hữu ích.

Việc đính kèm ValueEventListener vào danh sách dữ liệu sẽ trả về toàn bộ danh sách dữ liệu dưới dạng một DataSnapshot duy nhất, sau đó bạn có thể lặp lại để truy cập từng dữ liệu con.

Ngay cả khi chỉ có một kết quả khớp duy nhất cho truy vấn, ảnh chụp nhanh vẫn là một danh sách; nó chỉ chứa một mục duy nhất. Để truy cập mục, bạn cần lặp lại kết quả:

Kotlin+KTX

// 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());
        // ...
    }
});

Mẫu này có thể hữu ích khi bạn muốn tìm nạp tất cả danh sách con trong một thao tác duy nhất, thay vì lắng nghe các sự kiện onChildAdded bổ sung.

Tách người nghe

Lệnh gọi lại bị xóa bằng cách gọi phương thức removeEventListener() trên tham chiếu cơ sở dữ liệu Firebase của bạn.

Nếu một trình nghe đã được thêm nhiều lần vào một vị trí dữ liệu thì nó sẽ được gọi nhiều lần cho mỗi sự kiện và bạn phải tách nó ra với số lần như nhau để xóa nó hoàn toàn.

Việc gọi removeEventListener() trên trình nghe chính không tự động xóa trình nghe đã đăng ký trên các nút con của nó; removeEventListener() cũng phải được gọi trên bất kỳ trình nghe con nào để loại bỏ lệnh gọi lại.

Sắp xếp và lọc dữ liệu

Bạn có thể sử dụng lớp Query cơ sở dữ liệu thời gian thực để truy xuất dữ liệu được sắp xếp theo khóa, theo giá trị hoặc theo giá trị của phần tử con. Bạn cũng có thể lọc kết quả đã sắp xếp theo một số kết quả cụ thể hoặc một phạm vi khóa hoặc giá trị.

Sắp xếp dữ liệu

Để truy xuất dữ liệu đã được sắp xếp, hãy bắt đầu bằng cách chỉ định một trong các phương pháp theo thứ tự để xác định cách sắp xếp kết quả:

Phương pháp Cách sử dụng
orderByChild() Sắp xếp kết quả theo giá trị của khóa con được chỉ định hoặc đường dẫn con lồng nhau.
orderByKey() Sắp xếp kết quả theo khóa con.
orderByValue() Sắp xếp kết quả theo giá trị con.

Bạn chỉ có thể sử dụng một phương pháp theo thứ tự tại một thời điểm. Việc gọi một phương thức theo thứ tự nhiều lần trong cùng một truy vấn sẽ gây ra lỗi.

Ví dụ sau minh họa cách bạn có thể truy xuất danh sách các bài đăng hàng đầu của người dùng được sắp xếp theo số sao của họ:

Kotlin+KTX

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

Điều này xác định một truy vấn mà khi kết hợp với trình nghe con sẽ đồng bộ hóa ứng dụng khách với các bài đăng của người dùng từ đường dẫn trong cơ sở dữ liệu dựa trên ID người dùng của họ, được sắp xếp theo số sao mà mỗi bài đăng đã nhận được. Kỹ thuật sử dụng ID làm khóa chỉ mục này được gọi là data fan out, bạn có thể đọc thêm về nó trong Cấu trúc cơ sở dữ liệu của bạn .

Lệnh gọi phương thức orderByChild() chỉ định khóa con để sắp xếp kết quả theo. Trong trường hợp này, các bài đăng được sắp xếp theo giá trị của phần tử con "starCount" tương ứng. Các truy vấn cũng có thể được sắp xếp theo thứ tự con lồng nhau, trong trường hợp bạn có dữ liệu giống như sau:

"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",
  }
},

Trong ví dụ này, chúng ta có thể sắp xếp các thành phần trong danh sách theo các giá trị được lồng trong khóa metrics bằng cách chỉ định đường dẫn tương đối đến phần tử con được lồng trong lệnh gọi orderByChild() của chúng ta.

Kotlin+KTX

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

Để biết thêm thông tin về cách sắp xếp các loại dữ liệu khác, hãy xem Cách sắp xếp thứ tự dữ liệu truy vấn .

Lọc dữ liệu

Để lọc dữ liệu, bạn có thể kết hợp bất kỳ phương pháp giới hạn hoặc phạm vi nào với phương pháp theo thứ tự khi xây dựng truy vấn.

Phương pháp Cách sử dụng
limitToFirst() Đặt số lượng mục tối đa cần trả về từ đầu danh sách kết quả được sắp xếp.
limitToLast() Đặt số lượng mục tối đa cần trả về từ cuối danh sách kết quả được sắp xếp.
startAt() Trả về các mục lớn hơn hoặc bằng khóa hoặc giá trị được chỉ định tùy thuộc vào phương pháp theo thứ tự đã chọn.
startAfter() Trả về các mục lớn hơn khóa hoặc giá trị được chỉ định tùy thuộc vào phương pháp theo thứ tự đã chọn.
endAt() Trả về các mục nhỏ hơn hoặc bằng khóa hoặc giá trị được chỉ định tùy thuộc vào phương pháp theo thứ tự đã chọn.
endBefore() Trả về các mục nhỏ hơn khóa hoặc giá trị được chỉ định tùy thuộc vào phương pháp theo thứ tự đã chọn.
equalTo() Trả về các mục bằng khóa hoặc giá trị được chỉ định tùy thuộc vào phương thức theo thứ tự đã chọn.

Không giống như các phương pháp theo thứ tự, bạn có thể kết hợp nhiều hàm giới hạn hoặc phạm vi. Ví dụ: bạn có thể kết hợp các phương thức startAt()endAt() để giới hạn kết quả ở một phạm vi giá trị được chỉ định.

Ngay cả khi chỉ có một kết quả khớp duy nhất cho truy vấn, ảnh chụp nhanh vẫn là một danh sách; nó chỉ chứa một mục duy nhất. Để truy cập mục, bạn cần lặp lại kết quả:

Kotlin+KTX

// 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());
        // ...
    }
});

Giới hạn số lượng kết quả

Bạn có thể sử dụng các phương thức limitToFirst()limitToLast() để đặt số lượng con tối đa được đồng bộ hóa cho một cuộc gọi lại nhất định. Ví dụ: nếu bạn sử dụng limitToFirst() để đặt giới hạn là 100 thì ban đầu bạn chỉ nhận được tối đa 100 lệnh gọi lại onChildAdded() . Nếu bạn có ít hơn 100 mục được lưu trữ trong cơ sở dữ liệu Firebase của mình, lệnh gọi lại onChildAdded() sẽ kích hoạt cho từng mục.

Khi các mục thay đổi, bạn sẽ nhận được lệnh gọi lại onChildAdded() cho các mục nhập truy vấn và lệnh gọi lại onChildRemoved() cho các mục bị loại bỏ để tổng số vẫn ở mức 100.

Ví dụ sau đây minh họa cách ứng dụng viết blog mẫu xác định truy vấn để truy xuất danh sách 100 bài đăng gần đây nhất của tất cả người dùng:

Kotlin+KTX

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

Ví dụ này chỉ định nghĩa một truy vấn, để thực sự đồng bộ hóa dữ liệu cần phải có một trình lắng nghe kèm theo.

Lọc theo khóa hoặc giá trị

Bạn có thể sử dụng startAt() , startAfter() , endAt() , endBefore()equalTo() để chọn điểm bắt đầu, kết thúc và điểm tương đương tùy ý cho truy vấn. Điều này có thể hữu ích cho việc phân trang dữ liệu hoặc tìm các mục có trẻ em có giá trị cụ thể.

Cách dữ liệu truy vấn được sắp xếp

Phần này giải thích cách sắp xếp dữ liệu theo từng phương pháp theo thứ tự trong lớp Query .

orderByChild

Khi sử dụng orderByChild() , dữ liệu chứa khóa con được chỉ định sẽ được sắp xếp như sau:

  1. Con có giá trị null cho khóa con được chỉ định sẽ được ưu tiên trước.
  2. Tiếp theo là các phần tử con có giá trị false cho khóa con được chỉ định. Nếu nhiều phần tử con có giá trị false , chúng sẽ được sắp xếp theo từ điển theo khóa.
  3. Tiếp theo là các phần tử con có giá trị true cho khóa con được chỉ định. Nếu nhiều phần tử con có giá trị true thì chúng sẽ được sắp xếp theo từ điển theo khóa.
  4. Tiếp theo là các trẻ em có giá trị số, được sắp xếp theo thứ tự tăng dần. Nếu nhiều nút con có cùng giá trị số cho nút con được chỉ định thì chúng sẽ được sắp xếp theo khóa.
  5. Các chuỗi đứng sau các số và được sắp xếp theo thứ tự từ điển tăng dần. Nếu nhiều nút con có cùng giá trị cho nút con được chỉ định, chúng sẽ được sắp xếp theo thứ tự từ điển theo khóa.
  6. Các đối tượng ở cuối cùng và được sắp xếp theo từ điển theo thứ tự tăng dần.

orderByKey

Khi sử dụng orderByKey() để sắp xếp dữ liệu của bạn, dữ liệu sẽ được trả về theo thứ tự tăng dần theo khóa.

  1. Trẻ em có khóa có thể được phân tích cú pháp dưới dạng số nguyên 32 bit sẽ được xếp trước, được sắp xếp theo thứ tự tăng dần.
  2. Những phần tử con có giá trị chuỗi làm khóa sẽ xuất hiện tiếp theo, được sắp xếp theo từ điển theo thứ tự tăng dần.

orderByValue

Khi sử dụng orderByValue() , các phần tử con được sắp xếp theo giá trị của chúng. Tiêu chí đặt hàng giống như trong orderByChild() , ngoại trừ giá trị của nút được sử dụng thay cho giá trị của khóa con được chỉ định.

Bước tiếp theo